HTTP MFT Rest API

Suggest Edits

LOGIN

Basic

POST /2.0/login/basic

Content-Type: application/x-www-form-urlencoded.
Description: It allows the login.
Request body
Form parameters: username and password.
Example: 

curl -v 'http://domain/2.0/login/basic' \
 -H 'Content-Type: application/x-www-form-urlencoded; charset=UTF-8' \
 -d 'username=part1&password=partner1'

Response:

HTTP Status codeDescriptionResponse exampleNotes
200SUCCESSCookies to pass as headers in other APICookies returned are:
sp-http-usr=part1;Version=1;Path=/;HttpOnly
sp-http-ses=KRs88RDcZ7aVDcUEBk966A==;Version=1;Path=/;HttpOnly
401Authentication Error{
"result":"failed",
"message":"Invalid username or password",
"errorType":"authentication"
}
404Missing Parameters{
"result":"failed",
"message":"No username or password",
"errorType":"request_syntax"
}

FILES

Upload

PUT /2.0/files/<path>/<file>

Content-Type: multipart/form-data.
Description: To be used to upload files.
Request body
file: The content of the file to upload with type. (application/octet-stream or text/plain).
Example:
Upload 'file1.txt' in folder 'in'

curl -i -X PUT "https://domain/2.0/files/in/file1.txt" \
 -H "Content-Type: multipart/form-data" \
 -F 'file=@<FILE_NAME>;type=application/octet-stream'

*Response:

HTTP Status codeDescriptionResponse exampleNotes
201SUCCESS{
"result":"ok",
"timestamp":"2020-11-13T08:58:20.680Z"
"message":"Upload successful",
"fileset": ,
}		id : long value that represents the file

Timestamp: UTC representation of the response creation using ISO-8601
400No filename provided{
"result":"failed",
"timestamp":"2020-11-13T08:58:20.680Z"
"message":"No filename specified",
"errorType":"request_syntax"
}		Example if specified only path of folder.

Timestamp: UTC representation of the response creation using ISO-8601
400Missing parameters or syntax error{
"result":"failed",
"timestamp":"2020-11-13T08:58:20.680Z"
"message":"Missing parameters or syntax error",
"errorType":"request_syntax"
}		Example if metadata has syntax error or content-type header is missing.

Timestamp: UTC representation of the response creation using ISO-8601
401Connection contract not configured{
"result":"failed",
"timestamp":"2020-11-13T08:58:20.680Z"
"message":"Connection contract not configured",
"errorType":"configuration"
}		Timestamp: UTC representation of the response creation using ISO-8601
401Authentication error{
"result":"failed",
"timestamp":"2020-11-13T08:58:20.680Z"
"message":"Invalid username or password",
"errorType":"authentication"
}		Messages depends on authentication type.
timestamp: UTC representation of the response creation using ISO-8601
403No write permission{
"result":"failed",
"timestamp":"2020-11-13T08:58:20.680Z"
"message":"No write permission",
"errorType":"authorization"
}		Timestamp: UTC representation of the response creation using ISO-8601
404Path not found{
"result":"failed",
"timestamp":"2020-11-13T08:58:20.680Z"
"message":"Path '' doesn't exist",
"errorType":"io"
}		Timestamp: UTC representation of the response creation using ISO-8601

Upload with metadata

POST /2.0/files/<path>

Content-Type: multipart/form-data.
Description: To be used to upload files with metadata.
Request body
• metadata: List of metadata associated to file in JSON format.
• file: The content of the file to upload with type. (application/octet-stream or text/plain)
Example: 

curl -i -X POST 'https://domain/2.0/files/in/file1.txt' \
  -H "Content-Type: multipart/form-data" \
  -F 'metadata={"GENERIC.NAME1":"Value1", "GENERIC.NAME2":"Value2", "CORRELATIONID":"CORR1"}' \
  -F '[email protected];type=application/octet-stream'

Response:

HTTP Status codeDescriptionResponse exampleNotes
201SUCCESS{
"result":"ok",
"message":"Upload successful",
"fileset": ,
}		id: long value that represents the file
400No filename provided{
"result":"failed",
"message":"No filename specified",
"errorType":"request_syntax"
}		Example if specified only path of folder.
400Missing parameters or syntax error{
"result":"failed",
"message":"Missing parameters or syntax error",
"errorType":"request_syntax"
}		Example if metadata has syntax error or content-type header is missing.
401Connection contract not configured{
"result":"failed",
"message":"Connection contract not configured",
"errorType":"configuration"
}		Messages depends on authentication type.
401Authentication error{
"result":"failed",
"message":"Invalid username or password",
"errorType":"authentication"
}
403No write permission{
"result":"failed",
"message":"No write permission",
"errorType":"authorization"
}
404Path not found{
"result":"failed",
"message":"Path '' doesn't exist",
"errorType":"io"
}

Download

GET /2.0/files/<path>/<file>

Description: To be used to download files.
Example: 

curl -i -X GET 'https://domain/2.0/files/out/test1.txt’ \
   -o download_file.txt

Response:

HTTP Status codeDescriptionResponse exampleNotes
200SUCCESSContent of file
400No filename provided{
"result":"failed",
"timestamp":"2020-11-13T08:58:20.680Z"
"message":"No filename specified",
"errorType":"request_syntax"
}		Example if specified only path of folder
Timestamp: UTC representation of the response creation using ISO-8601
401Connection contract not configured{
"result":"failed",
"timestamp":"2020-11-13T08:58:20.680Z"
"message":"Connection contract not configured",
"errorType":"configuration"
}		Timestamp: UTC representation of the response creation using ISO-8601
401Authentication error{
"result":"failed",
"timestamp":"2020-11-13T08:58:20.680Z"
"message":"Invalid username or password",
"errorType":"authentication"
}		Messages depends on authentication type.

Timestamp: UTC representation of the response creation using ISO-8601
403No download permission{
"result":"failed",
"timestamp":"2020-11-13T08:58:20.680Z"
"message":"No read permission",
"errorType":"authorization"
}		Timestamp: UTC representation of the response creation using ISO-8601
404File not found{
"result":"failed",
"timestamp":"2020-11-13T08:58:20.680Z"
"message":"File '' doesn't exist",
"errorType":"io"
}		Timestamp: UTC representation of the response creation using ISO-8601
404Path not found{
"result":"failed",
"timestamp":"2020-11-13T08:58:20.680Z"
"message":"Path '' doesn't exist",
"errorType":"io"
}		Timestamp: UTC representation of the response creation using ISO-8601

Delete

DELETE /2.0/files/<path>/<file>

Description: To be used to delete files.
Example: 

curl -i -X DELETE 'https://domain/2.0/files/out/test1c.txt

Response:

HTTP Status codeDescriptionResponse exampleNotes
200SUCCESS{
"result":"ok",
"timestamp":"2020-11-13T08:58:20.680Z"
"message":"File deleted",
"fileset":
}		id : long value that represents the file
Timestamp: UTC representation of the response creation using ISO-8601
400Missing param or syntax error{
"result":"failed",
"timestamp":"2020-11-13T08:58:20.680Z"
"message":"missing param or syntax error",
"errorType":"syntax_error"
}		Timestamp: UTC representation of the response creation using ISO-8601
401Connection contract not configured{
"result":"failed",
"timestamp":"2020-11-13T08:58:20.680Z"
"message":"Connection contract not configured",
"errorType":"configuration"
}		Timestamp: UTC representation of the response creation using ISO-8601
401Authentication error{
"result":"failed",
"timestamp":"2020-11-13T08:58:20.680Z"
"message":"Invalid username or password",
"errorType":"authentication"
}		Messages depends on authentication type.
timestamp: UTC representation of the response creation using ISO-8601
403No delete permission{
"result":"failed",
"timestamp":"2020-11-13T08:58:20.680Z"
"message":"No delete permission",
"errorType":"authorization"
}		Timestamp: UTC representation of the response creation using ISO-8601
404File not found{
"result":"failed",
"timestamp":"2020-11-13T08:58:20.680Z"
"message":"File '' doesn't exist",
"errorType":"io"
}		Timestamp: UTC representation of the response creation using ISO-8601
404Path not found{
"result":"failed",
"timestamp":"2020-11-13T08:58:20.680Z"
"message":"Path '' doesn't exist",
"errorType":"io"
}		Timestamp: UTC representation of the response creation using ISO-8601

FILESET

Download

GET /2.0/fileset/<id>

Description: To be used to download files using fileset id.
Example: 

curl -i -X GET 'https://domain/2.0/fileset/342345’ \
   -o download_file.txt

Response:

HTTP Status codeDescriptionResponse exampleNotes
200SUCCESSContent of file
400No fileset provided{
"result":"failed",
"timestamp":"2020-11-13T08:58:20.680Z"
"message":"No fileset specified",
"errorType":"request_syntax"
}		Timestamp: UTC representation of the response creation using ISO-8601
401Connection contract not configured{
"result":"failed",
"timestamp":"2020-11-13T08:58:20.680Z"
"message":"Connection contract not configured",
"errorType":"configuration"
}		Timestamp: UTC representation of the response creation using ISO-8601
401Authentication error{
"result":"failed",
"timestamp":"2020-11-13T08:58:20.680Z"
"message":"Invalid username or password",
"errorType":"authentication"
}		Messages depends on authentication type.
Timestamp: UTC representation of the response creation using ISO-8601
403No download permission{
"result":"failed",
"timestamp":"2020-11-13T08:58:20.680Z"
"message":"No read permission",
"errorType":"authorization"
}		Timestamp: UTC representation of the response creation using ISO-8601
404File not found{
"result":"failed",
"timestamp":"2020-11-13T08:58:20.680Z"
"message":" doesn't exist",
"errorType":"io"
}		Timestamp: UTC representation of the response creation using ISO-8601

Delete

DELETE /2.0/fileset/<id>

Description: To be used to delete files using fileset id.
Example: 

curl -i -X DELETE 'https://domain/2.0/fileset/76785’

Response:

HTTP Status codeDescriptionResponse exampleNotes
200SUCCESS{
"result":"ok",
"timestamp":"2020-11-13T08:58:20.680Z"
"message":"File deleted",
"fileset":
}		id : long value that represents the file
Timestamp: UTC representation of the response creation using ISO-8601
401Connection contract not configured{
"result":"failed",
"timestamp":"2020-11-13T08:58:20.680Z"
"message":"Connection contract not configured",
"errorType":"configuration"
}		Timestamp: UTC representation of the response creation using ISO-8601
401Authentication error{
"result":"failed",
"timestamp":"2020-11-13T08:58:20.680Z"
"message":"Invalid username or password",
"errorType":"authentication"
}		Message depends on authentication type.
Timestamp: UTC representation of the response creation using ISO-8601
403No delete permission{
"result":"failed",
"timestamp":"2020-11-13T08:58:20.680Z"
"message":"No delete permission",
"errorType":"authorization"
}		Timestamp: UTC representation of the response creation using ISO-8601
404Fileset not found{
"result":"failed",
"timestamp":"2020-11-13T08:58:20.680Z"
"message":" doesn't exist",
"errorType":"io"
}		Timestamp: UTC representation of the response creation using ISO-8601

METADATA

Insert or Update

POST /2.0/metadata/<path>/<file>

Content-Type: application/json
Description: To be used to add or update metadata to files already uploaded.
Request body
• metadata: List of metadata associated to file in JSON format.
Example: 

curl -i -X POST 'https://domain/2.0/metadata/in/file1.txt' \
   -H "Content-Type: application/json" \
   -d '{SPFB_FILE_GENERIC_MD.MD_NAME":"Partner", "SPFB_FILE_GENERIC_MD.MD_VALUE":"Partner5"}'

Response:

HTTP Status codeDescriptionResponse exampleNotes
200SUCCESS{
"result":"ok",
"timestamp":"2020-11-13T08:58:20.680Z"
"message":"Metadata updated",
"fileset":
}		id : long value that represents the file
timestamp: UTC representation of the response creation using ISO-8601
400No filename provided{
"result":"failed",
"timestamp":"2020-11-13T08:58:20.680Z"
"message":"No filename specified",
"errorType":"request_syntax"
}		Example if specified only path of folder
timestamp: UTC representation of the response creation using ISO-8601
400Missing parameter or syntax error{
"result":"failed",
"timestamp":"2020-11-13T08:58:20.680Z"
"message":"Missing parameters or syntax error",
"errorType":"request_syntax"
}		Example if metadata has syntax error or content-type header is missing.
timestamp: UTC representation of the response creation using ISO-8601
401Connection contract not configured{
"result":"failed",
"timestamp":"2020-11-13T08:58:20.680Z"
"message":"Connection contract not configured",
"errorType":"configuration"
}		timestamp: UTC representation of the response creation using ISO-8601
401Authentication error{
"result":"failed",
"timestamp":"2020-11-13T08:58:20.680Z"
"message":"Invalid username or password",
"errorType":"authentication"
}		Messages depends on authentication type.
timestamp: UTC representation of the response creation using ISO-8601
403No write permission{
"result":"failed",
"timestamp":"2020-11-13T08:58:20.680Z"
"message":"No write permission",
"errorType":"authorization"
}		timestamp: UTC representation of the response creation using ISO-8601
404File not found{
"result":"failed",
"timestamp":"2020-11-13T08:58:20.680Z"
"message":"File '' doesn't exist",
"errorType":"io"
}		timestamp: UTC representation of the response creation using ISO-8601
404Path not found{
"result":"failed",
"timestamp":"2020-11-13T08:58:20.680Z"
"message":"Path '' doesn't exist",
"errorType":"io"
}		timestamp: UTC representation of the response creation using ISO-8601

Read

GET /2.0/metadata/<path>/<file>

Description: To be used to view the files metadata.
Example: 

curl -i -X GET 'https://domain/2.0/metadata/in/file1.txt' \
    -H "Accept: application/json"

Response:

HTTP Status codeDescriptionResponse exampleNotes
200SUCCESS{
"id":"/inbox/fileB_94.txt",
"uri":"https://domain/2.0/files/inbox/fileB_94.txt",
"metaUri":"https://domain/2.0/metadata/inbox/fileB_94.txt",
"filename":"fileB_94.txt",
"fileset":54678,
"metadata":{
"dstFileName":"",
"size":"89",
"correlationId":"",
"putDate":"2020-09-15T10:55:01.669Z",
"firstReadDate":"",
"lastModifiedTime":"2020-09-15T10:55:01.583Z",
"lastAccessTime":"",
"creationTime":"2020-09-15T10:55:01.583Z",
"datatype":"application/octet-stream",
"description":"",
"Partner":"Partner5"
}
}		The list of metadata is to be defined.
400No filename provided{
"result":"failed",
"timestamp":"2020-11-13T08:58:20.680Z"
"message":"No filename specified",
"errorType":"request_syntax"
}		Example if specified only path of folder
timestamp: UTC representation of the response creation using ISO-8601
401Connection contract not configured{
"result":"failed",
"timestamp":"2020-11-13T08:58:20.680Z"
"message":"Connection contract not configured",
"errorType":"configuration"
}		timestamp: UTC representation of the response creation using ISO-8601
401Authentication error{
"result":"failed",
"timestamp":"2020-11-13T08:58:20.680Z"
"message":"Invalid username or password",
"errorType":"authentication"
}		Messages depends on authentication type.
timestamp: UTC representation of the response creation using ISO-8601
403No read permission{
"result":"failed",
"timestamp":"2020-11-13T08:58:20.680Z"
"message":"No read permission",
"errorType":"authorization"
}		timestamp: UTC representation of the response creation using ISO-8601
404File not found{
"result":"failed",
"timestamp":"2020-11-13T08:58:20.680Z"
"message":" doesn't exist",
"errorType":"io"
}		timestamp: UTC representation of the response creation using ISO-8601
404Path not found{
"result":"failed",
"timestamp":"2020-11-13T08:58:20.680Z"
"message":"Path '' doesn't exist",
"errorType":"io"
}		timestamp: UTC representation of the response creation using ISO-8601

METADATABYID

Insert or Update

POST /2.0/metadatabyid/<id>

Content-Type: application/json
Description: To be used to add or update metadata to files already uploaded using the file id.
Request body
• metadata: List of metadata associated to file in JSON format.
Example: 

curl -i -X POST 'https://domain/2.0/metadatabyid/5678' \
   -H "Content-Type: application/json" \
   -d '{SPFB_FILE_GENERIC_MD.MD_NAME":"Partner", "SPFB_FILE_GENERIC_MD.MD_VALUE":"Partner5"}'

Response:

HTTP Status codeDescriptionResponse exampleNotes
200SUCCESS{
"result":"ok",
"timestamp":"2020-11-13T08:58:20.680Z"
"message":"Metadata updated",
"fileset":
}		id : long value that represents the file
timestamp: UTC representation of the response creation using ISO-8601
400No fileset provided{
"result":"failed",
"timestamp":"2020-11-13T08:58:20.680Z"
"message":"No fileset specified",
"errorType":"request_syntax"
}		timestamp: UTC representation of the response creation using ISO-8601
400Missing parameter or syntax error{
"result":"failed",
"timestamp":"2020-11-13T08:58:20.680Z"
"message":"Missing parameters or syntax error",
"errorType":"request_syntax"
}		Example if metadata has syntax error or content-type header is missing.
timestamp: UTC representation of the response creation using ISO-8601
401Connection contract not configured{
"result":"failed",
"timestamp":"2020-11-13T08:58:20.680Z"
"message":"Connection contract not configured",
"errorType":"configuration"
}		timestamp: UTC representation of the response creation using ISO-8601
401Authentication error{
"result":"failed",
"timestamp":"2020-11-13T08:58:20.680Z"
"message":"Invalid username or password",
"errorType":"authentication"
}		Messages depends on authentication type.
timestamp: UTC representation of the response creation using ISO-8601
403No write permission {
"result":"failed",
"timestamp":"2020-11-13T08:58:20.680Z"
"message":"No write permission",
"errorType":"authorization"
}		timestamp: UTC representation of the response creation using ISO-8601
404Fileset not found{
"result":"failed",
"timestamp":"2020-11-13T08:58:20.680Z"
"message":" doesn't exist",
"errorType":"io"
}		timestamp: UTC representation of the response creation using ISO-8601

Read

GET /2.0/metadatabyid/<id>

Description: To be used to view the files metadata using file id.
Example: 

curl -i -X GET 'https://domain/2.0/metadatabyid/5678' \
    -H "Accept: application/json"

Response:

HTTP Status codeDescriptionResponse exampleNotes
200SUCCESS{
"id":"/inbox/fileB_94.txt",
"uri":"https://domain/2.0/files/inbox/fileB_94.txt",
"metaUri":"https://domain/2.0/metadata/inbox/fileB_94.txt",
"filename":"fileB_94.txt",
"fileset":54678,
"metadata":{
"dstFileName":"",
"size":"89",
"correlationId":"",
"putDate":"2020-09-15T10:55:01.669Z",
"firstReadDate":"",
"lastModifiedTime":"2020-09-15T10:55:01.583Z",
"lastAccessTime":"",
"creationTime":"2020-09-15T10:55:01.583Z",
"datatype":"application/octet-stream",
"description":"",
"Partner":"Partner5"
}
}		The list of metadata is to be defined.
400No fileset provided{
"result":"failed",
"timestamp":"2020-11-13T08:58:20.680Z"
"message":"No fileset specified",
"errorType":"request_syntax"
}		timestamp: UTC representation of the response creation using ISO-8601
401Connection contract not configured{
"result":"failed",
"timestamp":"2020-11-13T08:58:20.680Z"
"message":"Connection contract not configured",
"errorType":"configuration"
}		timestamp: UTC representation of the response creation using ISO-8601
401Authentication error{
"result":"failed",
"timestamp":"2020-11-13T08:58:20.680Z"
"message":"Invalid username or password",
"errorType":"authentication"
}		Messages depends on authentication type.
timestamp: UTC representation of the response creation using ISO-8601
403No read permission{
"result":"failed",
"timestamp":"2020-11-13T08:58:20.680Z"
"message":"No read permission",
"errorType":"authorization"
}		timestamp: UTC representation of the response creation using ISO-8601
404Fileset not found{
"result":"failed",
"timestamp":"2020-11-13T08:58:20.680Z"
"message":" doesn't exist",
"errorType":"io"
}		timestamp: UTC representation of the response creation using ISO-8601

COUNTELEMENTS

Count

GET /2.0/countelements/<path%gt

Description: To be used to know the number of elements existing in the selected path.
Request body
Query parameters:
• filter: pattern to filter list count. '' is used to select any characters. Example: .txt or file.*
• type: all | folders | files. If not specified, it is all.
Example: 

curl -i -X GET 'https://domain/2.0/countelements/in?type=all'

Response:

HTTP Status codeDescriptionResponse exampleNotes
200SUCCESSNumber of elementsPossible values is 0 or positive number.
401Connection contract not configured{
"result":"failed",
"timestamp":"2020-11-13T08:58:20.680Z"
"message":"Connection contract not configured",
"errorType":"configuration"
}		timestamp: UTC representation of the response creation using ISO-8601
401Authentication error{
"result":"failed",
"timestamp":"2020-11-13T08:58:20.680Z"
"message":"Invalid username or password",
"errorType":"authentication"
}		Message depends on authentication type.
timestamp: UTC representation of the response creation using ISO-8601
403No list permission{
"result":"failed",
"timestamp":"2020-11-13T08:58:20.680Z"
"message":"No list permission",
"errorType":"authorization"
}		timestamp: UTC representation of the response creation using ISO-8601
404Path not found{
"result":"failed",
"timestamp":"2020-11-13T08:58:20.680Z"
"message":"Path doesn't exist",
"errorType":"io"
}		timestamp: UTC representation of the response creation using ISO-8601

DIRECTORIES

List Contents

GET /2.0/directories/<path>

Description: To be used to know the number of folders and files in the selected path.
Request body
Header accepted: application/json.
Query parameters:
• filter: pattern to filter list. '' is used to select any characters. Example .txt or file.*
• sort: sorting elements by name | size | put_date | read_date | expiry_date. Default is name.
• direction: direction of sort DESC | ASC. Default is DESC.
• start: List of elements start from. Default is 0.
• limit: Limit list of elements. Default is 500.
• type: all | folders | files. If not specified, all.
• attributes: List of attributes for each element to show in response. Value is command separated value. If attributes are not present, the value are empty. Default is all.
Example: 

curl -i -X GET 'https://domain/2.0/directories/in?sort=size&direction=DESC&start=0&limit=25' \
-H 'Accept: application/json'

Response:

HTTP Status codeDescriptionResponse exampleNotes
200SUCCESS{
"uri":"https://domain/2.0/directories/inbox",
"totalCount":"6",
"files":[
{
"id":"/inbox/dir1",
"uri":"https://domain/2.0/directories/inbox/dir1",
"filename":"dir1",
"owner":"",
"directory":true,
"attributes":{
"dstFileName":"",
"size":"",
"correlationId":"",
"putDate":"",
"firstReadDate":"",
"lastModifiedTime":"",
"lastAccessTime":"",
"creationTime":"",
"datatype":"",
"description":""
}
},
{
"id":"/inbox/dir2",
"uri":"https://domain/2.0/directories/inbox/dir2",
"filename":"dir2",
"owner":"",
"directory":true,
"attributes":{
"dstFileName":"",
"size":"",
"correlationId":"",
"putDate":"",
"firstReadDate":"",
"lastModifiedTime":"",
"lastAccessTime":"",
"creationTime":"",
"datatype":"",
"description":""
}
},
{
"id":"/inbox/fileB_94.txt",
"uri":"https://domain/2.0/files/inbox/fileB_94.txt",
"metaUri":"https://domain/2.0/metadata/inbox/fileB_94.txt",
"filename":"fileB_94.txt",
"fileset":54678,
"owner":"",
"directory":false,
"attributes":{
"dstFileName":"",
"size":"89",
"correlationId":"",
"putDate":"2020-09-15T10:55:01.669Z",
"firstReadDate":"",
"lastModifiedTime":"2020-09-15T10:55:01.583Z",
"lastAccessTime":"",
"creationTime":"2020-09-15T10:55:01.583Z",
"datatype":"application/octet-stream",
"description":""
}
},
{
"id":"/inbox/fileB_95.txt",
"uri":"https://domain/2.0/files/inbox/fileB_95.txt",
"metaUri":"https://domain/2.0/metadata/inbox/fileB_95.txt",
"filename":"fileB_95.txt",
"fileset":54679,
"owner":"",
"directory":false,
"attributes":{
"dstFileName":"",
"size":"206",
"correlationId":"",
"putDate":"2020-09-15T10:55:05.649Z",
"firstReadDate":"",
"lastModifiedTime":"2020-09-15T10:55:05.601Z",
"lastAccessTime":"",
"creationTime":"2020-09-15T10:55:05.601Z",
"datatype":"application/octet-stream",
"description":""
}
},
{
"id":"/inbox/fileB_96.txt",
"uri":"https://domain/2.0/files/inbox/fileB_96.txt",
"metaUri":"https://domain/2.0/metadata/inbox/fileB_96.txt",
"filename":"fileB_96.txt",
"fileset":54680,
"owner":"",
"directory":false,
"attributes":{
"dstFileName":"",
"size":"187",
"correlationId":"",
"putDate":"2020-09-15T10:55:03.379Z",
"firstReadDate":"",
"lastModifiedTime":"2020-09-15T10:55:03.325Z",
"lastAccessTime":"",
"creationTime":"2020-09-15T10:55:03.325Z",
"datatype":"application/octet-stream",
"description":""
}
},
{
"id":"/inbox/fileB_99.txt",
"uri":"https://domain/2.0/files/inbox/fileB_99.txt",
"metaUri":"https://domain/2.0/metadata/inbox/fileB_99.txt",
"filename":"fileB_99.txt",
"fileset":54681,
"owner":"",
"directory":false,
"attributes":{
"dstFileName":"",
"size":"151",
"correlationId":"",
"putDate":"2020-09-15T10:54:56.529Z",
"firstReadDate":"",
"lastModifiedTime":"2020-09-15T10:54:55.292Z",
"lastAccessTime":"",
"creationTime":"2020-09-15T10:54:55.292Z",
"datatype":"application/octet-stream",
"description":""
}
}
]
}		Example of list in inbox folder with 2 folders and 4 files.
401Authentication error{
"result":"failed",
"timestamp":"2020-11-13T08:58:20.680Z"
"message":"Invalid username or password",
"errorType":"authentication"
}		Message depends on authentication type.
timestamp: UTC representation of the response creation using ISO-8601
401Connection contract not configured{
"result":"failed",
"timestamp":"2020-11-13T08:58:20.680Z"
"message":"Connection contract not configured",
"errorType":"configuration"
}		timestamp: UTC representation of the response creation using ISO-8601
403No list permission{
"result":"failed",
"timestamp":"2020-11-13T08:58:20.680Z"
"message":"No list permission",
"errorType":"authorization"
}		timestamp: UTC representation of the response creation using ISO-8601
404Path not found{
"result":"failed",
"timestamp":"2020-11-13T08:58:20.680Z"
"message":"Path doesn't exist",
"errorType":"io"
}		timestamp: UTC representation of the response creation using ISO-8601

Updated 6 months ago