TRtrimble
Actions

Get an Action instance.

get/direct/actions/{action_key_value}

Request

  • Base URL
    https://api.xchange.trimble.com/connect/v1
  • URL
    https://api.xchange.trimble.com/connect/v1/direct/actions/{action_key_value}
  • Auth
    none required

Path parameters

action_key_valuestring required

Action Instance Identifier.

Headers

X-Application-Keystring required

Used to authorize access to the Direct API.

Response

Success

idstring

Action Identifier

dataobject

Contains the input object to the Action POST call.

dataObjectCodestring

Data Object Code

actionCodestring

Action Code

subscriberCodestring

Subscriber Code

createdUtcstring

Action Created Date

status'Queued' | 'Processing' | 'Failed' | 'Successful'

Action Status

resultstring

This object definition is defined on each Action POST. See Responses: "x-$.result for Successful" and "x-$.result for Failed" for the specific action based on the $.dataObjectCode and $.actionCode properties.

Changes

No recorded changes to this operation across all 2 revisions of this API.