Data API

Create a record

To create a record, use the below API. It accepts a JSON Payload as shown in the below.

For any linked parent example:

JSON

{

"name" : "FedEx Transport Services",

"parent" : {

    "id" : 1011

}

}

Example Data API:

POST   /data/<DataObject>/create

Update a record

To update a record, use the below API. It accepts a JSON Payload as shown in the below example. Make sure to include ID as url variable.

JSON

{

"id" : "101189",

"name" : "FedEx Transport Services"

}

Example Data API:

POST   /data/<DataObject>/update/<id>

Create multiple records

To create multiple records, use the below API. It accepts a JSON Payload as shown in the below.

For any linked parent example:

JSON

[

{

"name" : "FedEx Transport Services",

"parent" : {

    "id" : 1011

}

]

Example Data API:

POST   /data/<DataObject>/create_multiple

Create or Update multiple records

To create or update multiple records, use the below API. It accepts a JSON Payload as shown in the below.

For any linked parent example:

JSON

[

{

"name" : "FedEx Transport Services",

"parent" : {

    "id" : 1011

    }

}

]

Example Data API:

POST   /data/<DataObject>/upsert_multiple

Fetch records

To fetch records

JSON

{

"fields" : "Name;Type;Parent.Id" ,

"conditions" : ["Parent.Id = 1011001”, “Type = ‘Normal’"] ,

"logic" : "({0} AND {1}) OR {2}"

}

Example Data API:

POST   /data/<DataObject>/list

Delete a record

Example Data API:

POST   /data/<DataObject>/delete?id=xx

Delete Multiple records

Example Data API:

POST   /data/<DataObject>/delete_multiple

Document API

Delete an Uploaded File

To delete an uploaded file. Make sure to include id as a url parameter.

POST   /document/upload/delete?id=xx

Upload a File

To upload a file. Include type, referenceNumber and additionalInfo as url parameters.

POST   /document/upload/<type>?referenceNumber=xx&additionalInfo=xx

Get a File

To get a file. Include type, referenceNumber and additionalInfo as url parameters.

GET   /document/upload/documents?referenceNumber=x&type=<type>&additionalInfo=x