Developers
Diamonds18

Retrieve a processing attempt

GET/automations/diamond/{diamond_id}/memberships/{membership_id}/processing-attempts/{attempt_id}

Retrieves a processing attempt requested for the membership.

Only attempts that belong to the membership in the path can be retrieved; attempts of other memberships return 404 Not Found.

Authorization

AuthorizationBearer <token>

Autonomous mode: the API credential secret, sent as a bearer token. Credential secrets are identified by a fixed prefix.

In: header

Path Parameters

diamond_id*string

Public ID of the diamond, prefixed with dmd_.

membership_id*string

Public ID of the membership, prefixed with mbr_.

attempt_id*string

Public ID of the attempt, prefixed with pat_.

Header Parameters

X-Client-Request-Id?string

Optional client-generated identifier of the request, up to 64 characters from [A-Za-z0-9._-]. Echoed back in the response and recorded in the request log; it never replaces the server-generated X-Request-Id.

Lengthlength <= 64

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/automations/diamond/string/memberships/string/processing-attempts/string"
{  "data": {    "created_at": "2019-08-24T14:15:22Z",    "effects": {      "communication_sent": true,      "stage_confirmed": true    },    "error": {},    "event_id": "string",    "id": "string",    "import_id": "string",    "membership_id": "string",    "object": "processing_attempt",    "operation_id": "string",    "requested_by": {      "id": "string",      "kind": "credential"    },    "selection": {      "mode": "initial",      "rows": 0    },    "status": "queued"  }}

Create a processing attempt POST

Requests that the most recent failed communication for the membership be sent again. Failed communications are not retried automatically. The communication is queued for delivery. If the corresponding stage has already been confirmed, the message is not sent again, preventing duplicates. A membership with no recorded failure is rejected with `409 state_conflict` and `details[].reason` = `no_failed_run`.

List stages GET

Returns all eleven stages of the Diamond, in order. The set of stages is fixed: stages cannot be created or deleted.