Update the modification date for a history member

post/folders/{folderId}/histories
Internal-Use Only

Updates the modification date for a history member. If the object URI exists as a reference in the history folder, the information including the added field is updated. If it does not exist, a new member is added, and an eviction is performed if the folder is already at the maximum members threshold.

Request Samples

1

Response Samples

1{
2 "creationTimeStamp": "2022-06-20T18:19:13.92Z",
3 "createdBy": "stpweb1",
4 "modifiedTimeStamp": "2022-06-20T18:19:13.92Z",
5 "modifiedBy": "stpweb1",
6 "version": 2,
7 "id": "a73fd398-8969-415a-b0e2-3b423cf95849",
8 "name": "Folders_Spike.png",
9 "added": "2022-06-20T18:19:13.947099Z",
10 "parentFolderUri": "/folders/folders/f4300a6d-407e-46fc-9c8a-e8142bd5d172",
11 "uri": "/files/files/016cf2b0-ef36-4344-9896-0439a027d8ab",
12 "type": "child",
13 "contentType": "file",
14 "typeDefName": "file_png",
15 "links": [
16 {
17 "method": "GET",
18 "rel": "self",
19 "href": "/folders/folders/f4300a6d-407e-46fc-9c8a-e8142bd5d172/members/a73fd398-8969-415a-b0e2-3b423cf95849",
20 "uri": "/folders/folders/f4300a6d-407e-46fc-9c8a-e8142bd5d172/members/a73fd398-8969-415a-b0e2-3b423cf95849",
21 "type": "application/vnd.sas.content.folder.member"
22 },
23 {
24 "method": "GET",
25 "rel": "up",
26 "href": "/folders/folders/f4300a6d-407e-46fc-9c8a-e8142bd5d172",
27 "uri": "/folders/folders/f4300a6d-407e-46fc-9c8a-e8142bd5d172",
28 "type": "application/vnd.sas.content.folder"
29 },
30 {
31 "method": "GET",
32 "rel": "getResource",
33 "href": "/files/files/016cf2b0-ef36-4344-9896-0439a027d8ab",
34 "uri": "/files/files/016cf2b0-ef36-4344-9896-0439a027d8ab",
35 "type": "application/vnd.sas.summary"
36 },
37 {
38 "method": "PUT",
39 "rel": "putResource",
40 "href": "/files/files/016cf2b0-ef36-4344-9896-0439a027d8ab",
41 "uri": "/files/files/016cf2b0-ef36-4344-9896-0439a027d8ab"
42 },
43 {
44 "method": "DELETE",
45 "rel": "deleteResource",
46 "href": "/files/files/016cf2b0-ef36-4344-9896-0439a027d8ab",
47 "uri": "/files/files/016cf2b0-ef36-4344-9896-0439a027d8ab"
48 },
49 {
50 "method": "GET",
51 "rel": "ancestors",
52 "href": "/folders/ancestors?childUri=/files/files/016cf2b0-ef36-4344-9896-0439a027d8ab",
53 "uri": "/folders/ancestors?childUri=/files/files/016cf2b0-ef36-4344-9896-0439a027d8ab",
54 "type": "application/vnd.sas.content.folder.ancestor"
55 },
56 {
57 "method": "PUT",
58 "rel": "update",
59 "href": "/folders/folders/f4300a6d-407e-46fc-9c8a-e8142bd5d172/members/a73fd398-8969-415a-b0e2-3b423cf95849",
60 "uri": "/folders/folders/f4300a6d-407e-46fc-9c8a-e8142bd5d172/members/a73fd398-8969-415a-b0e2-3b423cf95849",
61 "type": "application/vnd.sas.content.folder.member"
62 },
63 {
64 "method": "DELETE",
65 "rel": "delete",
66 "href": "/folders/folders/f4300a6d-407e-46fc-9c8a-e8142bd5d172/members/a73fd398-8969-415a-b0e2-3b423cf95849",
67 "uri": "/folders/folders/f4300a6d-407e-46fc-9c8a-e8142bd5d172/members/a73fd398-8969-415a-b0e2-3b423cf95849"
68 },
69 {
70 "method": "PUT",
71 "rel": "validateRename",
72 "href": "/folders/commons/validations/folders/f4300a6d-407e-46fc-9c8a-e8142bd5d172/members/a73fd398-8969-415a-b0e2-3b423cf95849/name?value={newname}&type={newtype}",
73 "uri": "/folders/commons/validations/folders/f4300a6d-407e-46fc-9c8a-e8142bd5d172/members/a73fd398-8969-415a-b0e2-3b423cf95849/name?value={newname}&type={newtype}",
74 "type": "application/vnd.sas.validation"
75 },
76 {
77 "method": "GET",
78 "rel": "transferExport",
79 "href": "/folders/folders/f4300a6d-407e-46fc-9c8a-e8142bd5d172/members/a73fd398-8969-415a-b0e2-3b423cf95849",
80 "uri": "/folders/folders/f4300a6d-407e-46fc-9c8a-e8142bd5d172/members/a73fd398-8969-415a-b0e2-3b423cf95849",
81 "type": "application/vnd.sas.transfer.object"
82 },
83 {
84 "method": "PUT",
85 "rel": "transferImportUpdate",
86 "href": "/folders/folders/f4300a6d-407e-46fc-9c8a-e8142bd5d172/members/a73fd398-8969-415a-b0e2-3b423cf95849",
87 "uri": "/folders/folders/f4300a6d-407e-46fc-9c8a-e8142bd5d172/members/a73fd398-8969-415a-b0e2-3b423cf95849",
88 "type": "application/vnd.sas.transfer.object",
89 "responseType": "application/vnd.sas.summary"
90 },
91 {
92 "method": "POST",
93 "rel": "transferImport",
94 "href": "/folders/folders/f4300a6d-407e-46fc-9c8a-e8142bd5d172/members",
95 "uri": "/folders/folders/f4300a6d-407e-46fc-9c8a-e8142bd5d172/members",
96 "type": "application/vnd.sas.transfer.object",
97 "responseType": "application/vnd.sas.summary"
98 }
99 ]
100}

Path Parameters

NameTypeRequiredDescription
folderId
string<object-id>
true

The identifier of a specific history folder, or the delegate string: @myHistory.

Query Parameters

NameTypeRequiredDescription
abortOnMetadataFailure
boolean
false

If true, if the GET to retrieve the member metadata fails, abort the member creation. If false, the member creation succeeds regardless of the metadata retrieval status. The default value is false.

Request Body

Member

The schema for creating a new folder member.

Example:
{"name":"Test Object","type":"child","uri":"/objekts/e8cdb3af-30d8-423d-92a1-6f3bf1dffbb9","contentType":"objekt"}
NameTypeRequiredDescription
uri
string<relative URI>
true

The URI of the item that the member represents. The service does not make any attempt to validate this field, so it can be anything. However, if this is a folder, it MUST be the folder's URI. It should come from the folder's "self" link, and not be assembled from pieces.

type
string
true

Must be "child" or "reference". Child members are deleted when the parent folder is deleted. Child members that rely on SAS authorization checking inherit authorization settings from the parent folder. An object can be a child of one and only one folder. Reference members have no such restrictions. Any member object can be referenced from an unrestricted number of containers.

parentFolderUri
string
false

The URI of this member's parent folder. This is writable by the client. In order to perform a move, PUT this member with an updated parentFolderUri pointing to the new parent.

name
string
true

Localizable name of the member object. This attribute is persisted with the folder for performance reasons. For SAS managed objects, this value is intended to be synchronized with the attribute persisted with the object.

description
string
false

Localizable description of the member object. Member attribute is synchronized with attribute of member object for SAS managed objects.

creationTimeStamp
string<date-time>
false

Timestamp of member object creation. Member attribute is synchronized with attribute of member object for SAS managed objects.

modifiedTimeStamp
string<date-time>
false

Timestamp of last member object modification. Member attribute is synchronized with attribute of member object for SAS managed objects.

contentType
string
false

Member object type. Member attribute is synchronized with attribute of member object for SAS managed objects.

typeDefName
string
false

(version 2) If the resource has a subtype that applies, the client can specify it when creating the member. This gives the client navigating the members more information for filtering, sorting, or searching for matching members.

iconUri
string<relative URI>
false

Member object icon URI. Member attribute is synchronized with attribute of member object for SAS managed objects.

orderNum
integer
false

Optional ordering specifier to provide user ordering of members. When retrieving members, if no other ordering is specified, members are ordered by this field in ascending order. The values do not have to be sequential; the results are ordered according to the values provided. The values also do not have to be unique. However, duplicates result in arbitrary ordering of records with duplicate values.

version
integer
false

This media type's schema version number. This representation is version 2.

Responses

StatusMeaningDescription
200OKThe member was updated.HeadersSchema
201CreatedA member was created.HeadersSchema
400Bad RequestThe request was invalid. A folder type other than a history folder was referenced, or the body does not contain valid JSON.Schema
404Not FoundNo folder exists at the requested path.Schema
422Unprocessable EntityHistory creation failed because the metadata retrieval failed.Schema