Get an action from the action history of a link

get/links/@item/actions/{actionId}

Gets the full representation of an action from a links action history. A link to this representation is returned in the links property of an action summary.

Request Samples

1

Response Samples

1{
2 "actionId": "string",
3 "action": "string",
4 "actionType": "DOCUMENT_CREATE",
5 "objectType": "string",
6 "objectId": "string",
7 "objectVersion": "string",
8 "createdBy": "string",
9 "createdAt": "2019-08-24T14:15:22Z",
10 "links": [
11 {
12 "method": "string",
13 "rel": "string",
14 "uri": "string",
15 "href": "string",
16 "title": "string",
17 "type": "string",
18 "itemType": "string",
19 "responseType": "string",
20 "responseItemType": "string"
21 }
22 ],
23 "version": 0,
24 "items": [
25 {}
26 ]
27}

Path Parameters

NameTypeRequiredDescription
actionId
string
true

The ID of the action.

Query Parameters

NameTypeRequiredDescription
_id
string
true

The ID for an individual link. A link ID uses the following format: ${relationshipName}|_|${fromEntityTypeName}|_|${toEntityTypeName}|_|${fromEntityId}|_|${toEntityId} where |_| is the delimiter between link ID components.

Link ID component details:

  • relationshipName - The relationship type name that defines the link.
  • fromEntityTypeName - The entity type name of the starting point for the link.
  • fromEntityId - The unique identifier of the entity that is the starting point for the link.
  • toEntityTypeName - The entity type name of the destination point for the link.
  • toEntityId - The unique identifier of the entity that is the destination point for the link.

When submitting the request, the pipe character (|) must be percent-encoded as %7C. See below for an example of the pipe character properly encoded: ${relationshipName}%7C_%7C${fromEntityTypeName}%7C_%7C${toEntityTypeName}%7C_%7C${fromEntityId}%7C_%7C${toEntityId}

Responses

StatusMeaningDescription
200OK

The request succeeded.

Schema
400Bad Request

Action history was not available for the specified link.

Schema
404Not Found

The specified link or requested action was not found.

Schema