List Resources

Returns a list of one or more types of resources in the File Store: data files, templates, data mapping configurations, job creation presets and output creation presets, depending on the Type query parameter. If no Type value is passed, all OL Connect resources, but no generic or data files are listed.

This call only returns the list of resources that have been uploaded with the persistent attribute.

Examples:
/rest/serverengine/filestore/resources?type=TEMPLATE
/rest/serverengine/filestore/resources?type=TEMPLATE,DATA_MAPPING_CONFIG,JOB_CREATION_CONFIG

Request takes no content, and on success returns a response containing a JSON structure that has an array of objects holding base information on Connect resources.

Request

Method Type:

GET

URI:

/rest/serverengine/filestore/resources

Content: –
Content Type:

–

Add. Headers:

If server security settings are enabled, then one of the following:

  • Authorization – Basic Authentication (Username and Password) credentials (Base64 encoded)
  • auth_token – Authorization Token

Parameters

Path

Name Required Type Default Value Description
type

–

–

If the type parameter is omitted the endpoint will return:

  • Templates

  • Data mapping configurations

  • Job Creation Presets

  • Output Creation Presets

The type or types (comma-separated) of the files to list. Possible values:

  • GENERIC: Generic resources, e.g. binary files

  • TEMPLATE: Templates

  • DATA_MAPPING_CONFIG: Data mapping configurations

  • JOB_CREATION_CONFIG: Job creation presets

  • OUTPUT_CREATION_CONFIG: Output creation presets

  • DATA_FILE: Data files

Response

Success

The following lists status codes indicative of a successful response:

Status Code Content Content-Type Add. Headers Description
200
OK

A JSON structure that has an array of objects holding base information on Connect resources:

  • id (integer)

  • name (string)

  • path (string)

  • type (string)

  • size (integer)

application/json

 

 List returned.

Error

The following lists status codes indicative of a failed or error response:

Status Code Content Content-Type Add. Headers Description

401 Unauthorized

JSON Error specifying error message

application/json

WWW-Authenticate – BASIC (Basic Authentication credentials are accepted)

Server authentication has failed.

Response when either:

  • basic authentication credentials nor an authorization token have been specified in the request headers

  • the basic authentication credentials or the authorization token specified in the request headers are invalid

  • the authorization token specified in the request headers has now expired

403 Forbidden

JSON Error specifying error message

application/json

–

Server authentication has succeeded, but user authorization for this specific method has failed.

Response when authentication of the credentials or the authorization token specified in the request headers has succeeded, but the user associated with the credentials or the authorization token specified has insufficient role assignment/privileges.

404 Not Found

JSON Error specifying error message

application/json

–
  • No resources of the specified type found in File Store.
    		•