v1 > Services > ResultGet

Get the result of any asynchronous submitted command. Any asynchronous calls of other services will provide this callback in its response.

  • URL

    /connect/v1/result/{command}/batch/{batchId}

  • Method:

    GET

  • URL Params

Param Type Required Description Domain of value
command string Yes The asynchronous command submitted A string
batchId UUID Yes The batchId that was assigned to the asynchonous submission A UUID

  • Sample URL

    /connect/v1/result/certifications_create/batch/1c8a06b6-45be-4e68-9e2d-5c1f075e6ca2

  • Request :

    The request has no body.

  • Response :
Field Type Presence Description Domain of value
status object Always The execution status A status object
status[].state string Always The state of execution 'SUCCESS' or 'ERROR'
status[].code string On error The general error code and message See Errors reference
status[].messages[] array of string On error List of error causes An error code and message
result object On success The execution result A result object
result.executionStatus string While incompleted The type of entity this result is about 'PENDING' or 'ERROR'
result.batchId string While incompleted The batchId input parameter echoed A UUID
result.? object When completed Variable output. The command input parameter determine output content Any output for service that support async
  • Sample Response (Success and Completed /w example output of CertificationsCreate service):
{
  "status":{
    "state":"SUCCESS"
  },
  "result":{
    "entityType":"CERTIFICATION",
    "correlations":[
      {
        "externalId":"ABC-123",
        "originId":"0d168588-fc26-4603-9193-a262f4b98fa9"
      }
    ]
  }
}
  • Sample Response (Success and Pending):
{
  "status":{
    "state":"SUCCESS"
  },
  "result":{
    "executionStatus":"PENDING",
    "batchId":"b2689fd1-f25f-4d0f-9d0e-ea5c2adac46e"
  }
}

  • Sample Response (Success and Error):

    Meaning that ResultGet successfully returned that the asynchronous execution ended in an error state. If this happen, contact Origin support.

{
  "status":{
    "state":"SUCCESS"
  },
  "result":{
    "executionStatus":"ERROR",
    "batchId":"b2689fd1-f25f-4d0f-9d0e-ea5c2adac46e"
  }
}

results matching ""

    No results matching ""