Get an archive of an entity's history with related objects

get/instances/{instanceId}/history/{historyId}

Internal-Use Only

Returns an archive of entities and relationships corresponding to a history record for an entity. The limits of the network described by the archive are determined by the view associated with the instance (if specified) or the type definition (if specified). If no history policy or view is associated with the entity, then an archive consisting of the current entity's representation is returned. Each element has a link for its type definition; entities may also provide a link to its resource (which may not be in the same state it had when the history record was originally created).

Request Samples

Response Samples

200
application/vnd.sas.metadata.instance.archive+json
1{
2  "version": 1,
3  "entities": [
4    {
5      "creationTimeStamp": "2021-10-04T13:50:48.448Z",
6      "createdBy": "sasuser",
7      "modifiedTimeStamp": "2021-10-04T13:50:48.448Z",
8      "modifiedBy": "sasuser",
9      "id": "22916db5-01c8-dc40-8f83-9a384f518abd",
10      "links": [
11        {
12          "method": "GET",
13          "rel": "definition",
14          "href": "/catalog/definitions/02b7102c-e997-465d-9f41-2491c3a4f05b",
15          "uri": "/catalog/definitions/02b7102c-e997-465d-9f41-2491c3a4f05b",
16          "type": "application/vnd.sas.metadata.definition.entity"
17        },
18        {
19          "method": "GET",
20          "rel": "resource",
21          "href": "/dataTables/dataSources/Compute~fs~7b90bc1d-f019-48e3-926b-f4ad10b00779~fs~SASUSER/tables/CARS",
22          "uri": "/dataTables/dataSources/Compute~fs~7b90bc1d-f019-48e3-926b-f4ad10b00779~fs~SASUSER/tables/CARS",
23          "type": "application/json"
24        }
25      ],
26      "version": 1,
27      "instanceType": "entity",
28      "definition": "sasTable",
29      "name": "CARS",
30      "label": "2004 Car Data",
31      "type": "sasTable",
32      "attributes": {
33        "analysisTimeStamp": "2021-06-12T13:48:48.995Z",
34        "columnCount": 15,
35        "completenessPercent": 99.968847352,
36        "creator": "sasuser",
37        "dataLocale": "ENUSA",
38        "dataSize": 196608,
39        "dateCreated": "2019-11-05T02:09:55.805Z",
40        "dateModified": "2019-11-05T02:09:55.805Z",
41        "encoding": "us-ascii  ASCII (ANSI)",
42        "extension": "sas7bdat",
43        "informationPrivacy": "candidate",
44        "isView": false,
45        "reviewStatus": "none",
46        "rowCount": 428,
47        "sourceSystem": "SAS"
48      },
49      "resourceId": "/dataTables/dataSources/Compute~fs~7b90bc1d-f019-48e3-926b-f4ad10b00779~fs~SASUSER/tables/CARS"
50    }
51  ]
52}

Path Parameters

Name	Type	Required	Description
historyId	string	true	The ID of a historical record of an entity
instanceId	string	true	The ID of the Instance

Header Parameters

Name	Type	Required	Description
Accept	string	false	The desired item representation for the response. The default is application/vnd.sas.metadata.instance.archive+json Allowed values: application/vnd.sas.metadata.instance.archive+jsonapplication/json

Responses

Status	Meaning	Description
200	OK	OK.	Headers	Schema
400	Bad Request	Bad request (the request is not well-formed).		Schema
401	Unauthorized	Not authenticated.		Schema
403	Forbidden	The user does not have permission to complete this request.		Schema
404	Not Found	The specified resource was not found.		Schema
406	Not Acceptable	Not Acceptable. Include an Accept header with a supported value on the request.		Schema