- Url
- /V2.0/services/data/objects
- HTTP Method
GET
- Description
- Read an entity
- Parameters
-
Name Type Description fields string[] The list of fields to read id* entityId (string) - Result
Name Type Description entity entity In case of failure an error object will be returned
* indicates required fields- Samples
- The following example retrieves a single task by id with its Name, StartDate, Duration and Manager name fields
GET /V2.0/services/data/objects/Task/e22ca960-73bb-4cf6-b6e8-b638ed0ab1fd?fields=Name,StartDate,Duration,Manager.Name
{ "id": "/Task/e22ca960-73bb-4cf6-b6e8-b638ed0ab1fd", "Name": "New Task", "StartDate": "2014-11-03T08:00:00.0000000", "Duration": { "unit": "Weeks", "value": 3.0 }, "Manager": { "id": "/User/9bcd7df3-4f6b-4272-944c-219b65b7862a", "Name": "Sam" } }
- Url
- /V2.0/services/data/objects
- HTTP Method
POST
- Description
- Update an entity
- Parameters
-
Name Type Description entity entity - Result
Name Type Description In case of failure an error object will be returned
* indicates required fields- Samples
- The following example updates the Manager field of a task:
POST /V2.0/services/data/objects/Task/e22ca960-73bb-4cf6-b6e8-b638ed0ab1fd
{ "Manager": "/User/9bcd7df3-4f6b-4272-944c-219b65b7862a", "C_MyMultiSelectPickList": ["Value1","Value2"] }
- Url
- /V2.0/services/data/objects
- HTTP Method
PUT
- Description
- Create an entity
- Parameters
-
Name Type Description entity entity - Result
Name Type Description warnings string[] id entityId (string) In case of failure an error object will be returned
* indicates required fields- Samples
- The following example creates a new task under an existing task:
PUT /V2.0/services/data/objects/Task
{ "Parent": "/Task/e22ca960-73bb-4cf6-b6e8-b638ed0ab1fd", "Name": "Sub Task", "StartDate": "2014-12-01", "Duration": { "value": 3, "unit": "Days" } }
{ "id": "/Task/dc84ee38-12cc-492e-b70d-d7fd660f4ae7" }
When creating an entity, a unique ID is generated and returned as part of the object creation process. If needed, you can also set a specific ID to the entity being created as long as you can guarantee this ID is unique.
The following example shows how to create an entity with a preset ID:PUT /V2.0/services/data/objects/Task/1234567890
{ "Parent": "/Task/e22ca960-73bb-4cf6-b6e8-b638ed0ab1fd", "Name": "Sub Task", "StartDate": "2014-12-01", "Duration": { "value": 3, "unit": "Days" } }
{ "id": "/Task/1234567890" }
- Url
- /V2.0/services/data/objects
- HTTP Method
PUT
- Description
- Create an entity
- Parameters
-
Name Type Description entity entity - Result
Name Type Description warnings string[] id entityId (string) In case of failure an error object will be returned
* indicates required fields- Samples
- The following example creates a new task under an existing task:
PUT /V2.0/services/data/objects/Task
{ "Parent": "/Task/e22ca960-73bb-4cf6-b6e8-b638ed0ab1fd", "Name": "Sub Task", "StartDate": "2014-12-01", "Duration": { "value": 3, "unit": "Days" } }
{ "id": "/Task/dc84ee38-12cc-492e-b70d-d7fd660f4ae7" }
When creating an entity, a unique ID is generated and returned as part of the object creation process. If needed, you can also set a specific ID to the entity being created as long as you can guarantee this ID is unique.
The following example shows how to create an entity with a preset ID:PUT /V2.0/services/data/objects/Task/1234567890
{ "Parent": "/Task/e22ca960-73bb-4cf6-b6e8-b638ed0ab1fd", "Name": "Sub Task", "StartDate": "2014-12-01", "Duration": { "value": 3, "unit": "Days" } }
{ "id": "/Task/1234567890" }
- Url
- /V2.0/services/data/objects
- HTTP Method
DELETE
- Description
- Delete an entity
- Parameters
-
Name Type Description id* entityId (string) - Result
Name Type Description In case of failure an error object will be returned
* indicates required fields- Samples
- Delete an entity:
DELETE /V2.0/services/data/objects/Task/1234567890