Resource URL Summary
Panel | ||||||
---|---|---|---|---|---|---|
| ||||||
Retrieve the details of a specific Activity
Insert or Update the details of a specific Activity
Delete a specific Activity
|
API Specific Parameters
Parameter | Description |
---|---|
| Identifies the |
Activity IDs are globally unique. |
Include Page | ||||
---|---|---|---|---|
|
API Specifics
Panel | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||
Retrieve the details of a specific ActivityThis REST API will return an Activity with the specified ID. The Activity with the specified ID must already exist in the system. URL
HTTP Request BodyThis request does not require a request body. HTTP Response BodyOn success, an HTTP response code of 200 will be returned, and the response body will contain an REST Object Definitions Work Order Activity Related Objects Activity Object. Otherwise, on error, the response body will contain a descriptive reason for the error.
|
Panel | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
Insert or Update the details of a specific ActivityThis REST API will insert a new Activity with the specified ID into the system, if an Activity with the specified ID does not already exist in the system. If, however, the Activity with the specified ID does already exist in the system, then this REST API will update (i.e. replace) the already existing Activity with the specified ID with the details of the Activity supplied in the HTTP Request Body. URL
HTTP Request BodyThe HTTP request body must contain a valid REST Object Definitions Work Order Activity Related Objects Activity Object. HTTP ResponseOn success the API will return a response code of 200. |
Panel | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
Delete a specific ActivityThis REST API will delete an Activity with the specified ID from the system. The Activity with the specified ID must already exist in the system. URL
HTTP Request BodyThis request does not require a request body. HTTP ResponseOn success an HTTP response code of 200 will be returned. The system will return HTTP response code 410 in case of non-existent REST Object Definitions Work Order Activity Related Objects Activity Object. |