REST API Reference for Launch Cloud Service

Get folder contents

get

https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/v1/folder/{name}

Returns a list of folders that match the search criteria.

Request

Path Parameters

name(required): string

The name of the parent folder to search content.

Query Parameters

fileName.ew(required): string

The ending name of the file to fetch the filelist.
fileName.sw(required): string

The starting name of the file to fetch the filelist.
path(required): string

The name of the subfolder to fetch the filelist.

There's no request body for this operation.

Response

Supported Media Types

application/json

200 Response

The list of folders was returned successfully.

Root Schema : FolderOracle

Type: object

Title: FolderOracle

The folder resource.

Show Source

fileList: array fileList

A list of file lists associated with the folder.
folderPath: string

The complete folder path of the directory(UCM path).
name: string

Folder path to from where to retrieve the contents.

{
    "title":"FolderOracle",
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"Folder path to from where to retrieve the contents."
        },
        "folderPath":{
            "type":"string",
            "description":"The complete folder path of the directory(UCM path)."
        },
        "fileList":{
            "type":"array",
            "items":{
                "type":"object",
                "description":"The information about the folder contents fetch from UCM.",
                "properties":{
                    "name":{
                        "type":"string",
                        "description":"The name of the folder."
                    },
                    "url":{
                        "type":"string",
                        "description":"The URL to download the content."
                    }
                }
            },
            "description":"A list of file lists associated with the folder."
        }
    },
    "description":"The folder resource."
}

Nested Schema : fileList

Type: array

A list of file lists associated with the folder.

Show Source

Array of: object items

The information about the folder contents fetch from UCM.

{
    "type":"array",
    "items":{
        "type":"object",
        "description":"The information about the folder contents fetch from UCM.",
        "properties":{
            "name":{
                "type":"string",
                "description":"The name of the folder."
            },
            "url":{
                "type":"string",
                "description":"The URL to download the content."
            }
        }
    },
    "description":"A list of file lists associated with the folder."
}

Nested Schema : items

Type: object

The information about the folder contents fetch from UCM.

Show Source

name: string

The name of the folder.
url: string

The URL to download the content.

{
    "type":"object",
    "description":"The information about the folder contents fetch from UCM.",
    "properties":{
        "name":{
            "type":"string",
            "description":"The name of the folder."
        },
        "url":{
            "type":"string",
            "description":"The URL to download the content."
        }
    }
}

400 Response

Your request couldn't be processed because it contains missing or invalid information, such as a validation error on an input field, a missing required value, and so forth.

Root Schema : Error

Type: object

Title: Error

The error resource.

Show Source

@schemaLocation: string

The URI of the schema that defines the error.
@type: string

The class type of a REST resource.
code(required): string

Application related code (as defined in the API or from a common list).
message: string

The text that provides more details and corrective actions related to the error. This can be shown to a client user.
reason(required): string

The text that explains the reason for error. This can be shown to a client user.
referenceError: string

The URL pointing to documentation describing the error.
status: string

The status of the error.

{
    "title":"Error",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application related code (as defined in the API or from a common list)."
        },
        "reason":{
            "type":"string",
            "description":"The text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"The text that provides more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"The status of the error."
        },
        "referenceError":{
            "type":"string",
            "description":"The URL pointing to documentation describing the error."
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI of the schema that defines the error."
        }
    },
    "required":[
        "code",
        "reason"
    ],
    "description":"The error resource."
}

401 Response

Your request isn't authorized. The authentication credentials included with this request are missing or invalid.

Root Schema : Error

Type: object

Title: Error

The error resource.

Show Source

@schemaLocation: string

The URI of the schema that defines the error.
@type: string

The class type of a REST resource.
code(required): string

Application related code (as defined in the API or from a common list).
message: string

The text that provides more details and corrective actions related to the error. This can be shown to a client user.
reason(required): string

The text that explains the reason for error. This can be shown to a client user.
referenceError: string

The URL pointing to documentation describing the error.
status: string

The status of the error.

{
    "title":"Error",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application related code (as defined in the API or from a common list)."
        },
        "reason":{
            "type":"string",
            "description":"The text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"The text that provides more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"The status of the error."
        },
        "referenceError":{
            "type":"string",
            "description":"The URL pointing to documentation describing the error."
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI of the schema that defines the error."
        }
    },
    "required":[
        "code",
        "reason"
    ],
    "description":"The error resource."
}

404 Response

The resource with the specified URI couldn't be found.

Root Schema : Error

Type: object

Title: Error

The error resource.

Show Source

@schemaLocation: string

The URI of the schema that defines the error.
@type: string

The class type of a REST resource.
code(required): string

Application related code (as defined in the API or from a common list).
message: string

The text that provides more details and corrective actions related to the error. This can be shown to a client user.
reason(required): string

The text that explains the reason for error. This can be shown to a client user.
referenceError: string

The URL pointing to documentation describing the error.
status: string

The status of the error.

{
    "title":"Error",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application related code (as defined in the API or from a common list)."
        },
        "reason":{
            "type":"string",
            "description":"The text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"The text that provides more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"The status of the error."
        },
        "referenceError":{
            "type":"string",
            "description":"The URL pointing to documentation describing the error."
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI of the schema that defines the error."
        }
    },
    "required":[
        "code",
        "reason"
    ],
    "description":"The error resource."
}

405 Response

HTTP action specified in the request (DELETE, GET, POST, PUT) isn't supported for this request URI.

Root Schema : Error

Type: object

Title: Error

The error resource.

Show Source

@schemaLocation: string

The URI of the schema that defines the error.
@type: string

The class type of a REST resource.
code(required): string

Application related code (as defined in the API or from a common list).
message: string

The text that provides more details and corrective actions related to the error. This can be shown to a client user.
reason(required): string

The text that explains the reason for error. This can be shown to a client user.
referenceError: string

The URL pointing to documentation describing the error.
status: string

The status of the error.

{
    "title":"Error",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application related code (as defined in the API or from a common list)."
        },
        "reason":{
            "type":"string",
            "description":"The text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"The text that provides more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"The status of the error."
        },
        "referenceError":{
            "type":"string",
            "description":"The URL pointing to documentation describing the error."
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI of the schema that defines the error."
        }
    },
    "required":[
        "code",
        "reason"
    ],
    "description":"The error resource."
}

500 Response

The server encountered something unexpected that prevented it from completing the request.

Root Schema : Error

Type: object

Title: Error

The error resource.

Show Source

@schemaLocation: string

The URI of the schema that defines the error.
@type: string

The class type of a REST resource.
code(required): string

Application related code (as defined in the API or from a common list).
message: string

The text that provides more details and corrective actions related to the error. This can be shown to a client user.
reason(required): string

The text that explains the reason for error. This can be shown to a client user.
referenceError: string

The URL pointing to documentation describing the error.
status: string

The status of the error.

{
    "title":"Error",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application related code (as defined in the API or from a common list)."
        },
        "reason":{
            "type":"string",
            "description":"The text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"The text that provides more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"The status of the error."
        },
        "referenceError":{
            "type":"string",
            "description":"The URL pointing to documentation describing the error."
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI of the schema that defines the error."
        }
    },
    "required":[
        "code",
        "reason"
    ],
    "description":"The error resource."
}

Examples

The following example shows how to upload files into a folder by submitting a post request and how to get the contents of the folder by submitting a get request on the REST resource using cURL.

curl  -H 'Authorization: Bearer <accessToken> -H POST https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/v1/folder/ -H "Content-Type: application/json" -D @post_foldercontents.json | json_pp

curl -u username:password -X GET https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/v1/attachment/{filename}?path={folder_name} -H "Content-Type: application/json"

Upload files

Prerequisites to upload files

This resource only accepts zipped file as input.
Ensure that the files are zipped into a single file.
In the Request Body of Postman
- In the form-data tab, use the following keys to upload the files:
  - Mention primaryFile as KEY value and select the type as File. Choose the input zip file as Value.
  - Use the path KEY and specify the name of the folder containing the zipped file

Example of Request Body

The following shows an example of the request body.

curl  -H 'Authorization: Bearer <accessToken> -H POST https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/v1/folder/

Example of Response Body

The following example shows the contents of the response body in JSON format.

[
    {
        "fileName": "Test1.docx",
        "path": "files",
        "url": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/v1/attachment/Test1.docx?path=files"
    },
    {
        "fileName": "Test2.docx",
        "path": "files",
        "url": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/v1/attachment/Test2.docx?path=files"
    }
]

Get folder contents

Example of Request Body

The following shows an example of the request body.

curl -u username:password -X GET https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/v1/attachment/{filename}?path={folder_name}

Example of Response Body

The following example shows the contents of the response body in JSON format.

>> Save the Output response in an file.
>> Open the file to read the contents.

Export Files with queryParam fileName.sw

Example of Request Body

The following shows an example of the request body.

curl -u username:password -X GET https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/v1/folder/export?fileName.sw=exp_

Example of Response Body

The following example shows the contents of the response body in JSON format.

{
    "name": "export",
    "folderPath": "/Contribution Folders/CatalogManagement/export",
    "fileList": [
        {
            "name": "exp_633002.json",
            "url": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/v1/exportFile/exp_633002.json"
        },
        {
            "name": "exp_633014.json",
            "url": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/v1/exportFile/exp_633014.json"
        },
        {
            "name": "exp_635674.json",
            "url": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/v1/exportFile/exp_635674.json"
        },
        {
            "name": "exp_647021.json",
            "url": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/v1/exportFile/exp_647021.json"
        }
    ]
}

Export Files with queryParam fileName.ew

Example of Request Body

The following shows an example of the request body.

curl -u username:password -X GET https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/v1/folder/export?fileName.ew=.csv

Example of Response Body

The following example shows the contents of the response body in JSON format.

{
    "name": "export",
    "folderPath": "/Contribution Folders/CatalogManagement/export",
    "fileList": [
        {
            "name": "Test.csv",
            "url": "{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/v1/exportFile/Test.csv"
        },
        {
            "name": "VF_637601.csv",
            "url": "{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/v1/exportFile/VF_637601.csv"
        },
        {
            "name": "exp_664672.csv",
            "url": "{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/v1/exportFile/exp_664672.csv"
        },
        {
            "name": "exp_675274.csv",
            "url": "{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/v1/exportFile/exp_675274.csv"
        }
]