REST API Reference

Back Next

Getting the status of a source control operation

Use the sourceControlAction resource to get the status of a source control operation.

You can request the status of a source control operation.

GET request

To receive the status of a source control operation, include the action ID in the following URI::

/public/core/v3/sourceControlAction/<action ID>

To receive the status for each object in the source control operation, use the following URI:

/public/core/v3/sourceControlAction/<action ID>?expand=objects

GET response

Returns the following information for the source control operation:

Field	Type	Description
id	String	ID of the source control operation.
action	String	Type of operation. Returns one of the following values: CHECKIN CHECKOUT PULL UNLINK UNDO_CHECKOUT
commitHash	String	Unique commit hash. Included when the request is for checkin and pull operations.
startTime	TimeStamp	Start time of the operation.
endTime	TimeStamp	End time of the operation.
status	Object	Includes status information for the operation.
state	String	Included in the status object. Status of the operation. Returns one of the following values: NOT_STARTED IN_PROGRESS SUCCESSFUL FAILED WARNING
message	String	Included in the status object. Descriptive status message for the operation.
objects	List<Object>	Lists each object included in the operation. Returned when expand=objects is included in the URI.
target	Object	Included in the objects object. Target object
id	String	Included in the target object. ID of the target object.
path	List<String>	Included in the target object. Complete path of the target object. For example, "Default" , "mt_MappingTask1".
type	String	Included in the target object. Asset type of the target object.
status	Object	Included in the target object. Status information for the target object.
state	String	Included in the status object. Status of the operation. Returns one of the following values: NOT_STARTED IN_PROGRESS SUCCSSFUL FAILED SKIPPED CANCELLED WARNING
message	String	Included in the status object. Descriptive status message for the operation.

Get response example

If successful, you might receive a response similar to the following example:

{
  "id": "drLV4N8PFiuhAbcprrur2W",
  "action": "CHECKIN"
  "commitHash": "1234567abcdefg"
  "startTime": "2020-03-24T22:07:44Z",
  "endTime": "2020-03-24T22:08:14Z",
  "status": {
    "state": "SUCCESSFUL",
    "message": "Checkin Successful"
  },
  "objects": [
    {
      "target": {
        "path": [
          "Versioned_Project",
          "Versioned_Folder",
          "Versioned Mapping - Rename"
        ],
        "id": "2CefbUuBsYxhG6eeKXvGmh",
        "type": "MAPPING"
      },
      "status": {
        "state": "SUCCESSFUL",
        "message": "Checkin Successful"
      }
    },
    {
      "target": {
        "path": [
          "Versioned_Project",
          "Versioned_Folder",
          "Versioned Mapping - Edit"
        ],
        "id": "2CefbUuBsYxhG6eeKXvGmh",
        "type": "MAPPING"
      },
      "status": {
        "state": "FAILED",
        "message": "Checkin Failed."
     }
  ]
}

Rename Saved Search

Table of Contents

REST API Reference

REST API Reference

Getting the status of a source control operation

Getting the status of a source control operation

GET request

GET response

Get response example