1944 lines
45 KiB
JSON
1944 lines
45 KiB
JSON
|
{
|
||
|
|
"version": "2.0",
|
||
|
|
"metadata": {
|
||
|
|
"apiVersion": "2016-05-01",
|
||
|
|
"endpointPrefix": "workdocs",
|
||
|
|
"jsonVersion": "1.1",
|
||
|
|
"protocol": "rest-json",
|
||
|
|
"serviceFullName": "Amazon WorkDocs",
|
||
|
|
"serviceId": "WorkDocs",
|
||
|
|
"signatureVersion": "v4",
|
||
|
|
"uid": "workdocs-2016-05-01"
|
||
|
|
},
|
||
|
|
"operations": {
|
||
|
|
"AbortDocumentVersionUpload": {
|
||
|
|
"http": {
|
||
|
|
"method": "DELETE",
|
||
|
|
"requestUri": "/api/v1/documents/{DocumentId}/versions/{VersionId}",
|
||
|
|
"responseCode": 204
|
||
|
|
},
|
||
|
|
"input": {
|
||
|
|
"type": "structure",
|
||
|
|
"required": [
|
||
|
|
"DocumentId",
|
||
|
|
"VersionId"
|
||
|
|
],
|
||
|
|
"members": {
|
||
|
|
"AuthenticationToken": {
|
||
|
|
"shape": "S2",
|
||
|
|
"location": "header",
|
||
|
|
"locationName": "Authentication"
|
||
|
|
},
|
||
|
|
"DocumentId": {
|
||
|
|
"location": "uri",
|
||
|
|
"locationName": "DocumentId"
|
||
|
|
},
|
||
|
|
"VersionId": {
|
||
|
|
"location": "uri",
|
||
|
|
"locationName": "VersionId"
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"ActivateUser": {
|
||
|
|
"http": {
|
||
|
|
"requestUri": "/api/v1/users/{UserId}/activation",
|
||
|
|
"responseCode": 200
|
||
|
|
},
|
||
|
|
"input": {
|
||
|
|
"type": "structure",
|
||
|
|
"required": [
|
||
|
|
"UserId"
|
||
|
|
],
|
||
|
|
"members": {
|
||
|
|
"UserId": {
|
||
|
|
"location": "uri",
|
||
|
|
"locationName": "UserId"
|
||
|
|
},
|
||
|
|
"AuthenticationToken": {
|
||
|
|
"shape": "S2",
|
||
|
|
"location": "header",
|
||
|
|
"locationName": "Authentication"
|
||
|
|
}
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"output": {
|
||
|
|
"type": "structure",
|
||
|
|
"members": {
|
||
|
|
"User": {
|
||
|
|
"shape": "S8"
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"AddResourcePermissions": {
|
||
|
|
"http": {
|
||
|
|
"requestUri": "/api/v1/resources/{ResourceId}/permissions",
|
||
|
|
"responseCode": 201
|
||
|
|
},
|
||
|
|
"input": {
|
||
|
|
"type": "structure",
|
||
|
|
"required": [
|
||
|
|
"ResourceId",
|
||
|
|
"Principals"
|
||
|
|
],
|
||
|
|
"members": {
|
||
|
|
"AuthenticationToken": {
|
||
|
|
"shape": "S2",
|
||
|
|
"location": "header",
|
||
|
|
"locationName": "Authentication"
|
||
|
|
},
|
||
|
|
"ResourceId": {
|
||
|
|
"location": "uri",
|
||
|
|
"locationName": "ResourceId"
|
||
|
|
},
|
||
|
|
"Principals": {
|
||
|
|
"type": "list",
|
||
|
|
"member": {
|
||
|
|
"type": "structure",
|
||
|
|
"required": [
|
||
|
|
"Id",
|
||
|
|
"Type",
|
||
|
|
"Role"
|
||
|
|
],
|
||
|
|
"members": {
|
||
|
|
"Id": {},
|
||
|
|
"Type": {},
|
||
|
|
"Role": {}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"NotificationOptions": {
|
||
|
|
"type": "structure",
|
||
|
|
"members": {
|
||
|
|
"SendEmail": {
|
||
|
|
"type": "boolean"
|
||
|
|
},
|
||
|
|
"EmailMessage": {
|
||
|
|
"shape": "St"
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"output": {
|
||
|
|
"type": "structure",
|
||
|
|
"members": {
|
||
|
|
"ShareResults": {
|
||
|
|
"type": "list",
|
||
|
|
"member": {
|
||
|
|
"type": "structure",
|
||
|
|
"members": {
|
||
|
|
"PrincipalId": {},
|
||
|
|
"InviteePrincipalId": {},
|
||
|
|
"Role": {},
|
||
|
|
"Status": {},
|
||
|
|
"ShareId": {},
|
||
|
|
"StatusMessage": {
|
||
|
|
"shape": "St"
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"CreateComment": {
|
||
|
|
"http": {
|
||
|
|
"requestUri": "/api/v1/documents/{DocumentId}/versions/{VersionId}/comment",
|
||
|
|
"responseCode": 201
|
||
|
|
},
|
||
|
|
"input": {
|
||
|
|
"type": "structure",
|
||
|
|
"required": [
|
||
|
|
"DocumentId",
|
||
|
|
"VersionId",
|
||
|
|
"Text"
|
||
|
|
],
|
||
|
|
"members": {
|
||
|
|
"AuthenticationToken": {
|
||
|
|
"shape": "S2",
|
||
|
|
"location": "header",
|
||
|
|
"locationName": "Authentication"
|
||
|
|
},
|
||
|
|
"DocumentId": {
|
||
|
|
"location": "uri",
|
||
|
|
"locationName": "DocumentId"
|
||
|
|
},
|
||
|
|
"VersionId": {
|
||
|
|
"location": "uri",
|
||
|
|
"locationName": "VersionId"
|
||
|
|
},
|
||
|
|
"ParentId": {},
|
||
|
|
"ThreadId": {},
|
||
|
|
"Text": {
|
||
|
|
"shape": "S10"
|
||
|
|
},
|
||
|
|
"Visibility": {},
|
||
|
|
"NotifyCollaborators": {
|
||
|
|
"type": "boolean"
|
||
|
|
}
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"output": {
|
||
|
|
"type": "structure",
|
||
|
|
"members": {
|
||
|
|
"Comment": {
|
||
|
|
"shape": "S13"
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"CreateCustomMetadata": {
|
||
|
|
"http": {
|
||
|
|
"method": "PUT",
|
||
|
|
"requestUri": "/api/v1/resources/{ResourceId}/customMetadata",
|
||
|
|
"responseCode": 200
|
||
|
|
},
|
||
|
|
"input": {
|
||
|
|
"type": "structure",
|
||
|
|
"required": [
|
||
|
|
"ResourceId",
|
||
|
|
"CustomMetadata"
|
||
|
|
],
|
||
|
|
"members": {
|
||
|
|
"AuthenticationToken": {
|
||
|
|
"shape": "S2",
|
||
|
|
"location": "header",
|
||
|
|
"locationName": "Authentication"
|
||
|
|
},
|
||
|
|
"ResourceId": {
|
||
|
|
"location": "uri",
|
||
|
|
"locationName": "ResourceId"
|
||
|
|
},
|
||
|
|
"VersionId": {
|
||
|
|
"location": "querystring",
|
||
|
|
"locationName": "versionid"
|
||
|
|
},
|
||
|
|
"CustomMetadata": {
|
||
|
|
"shape": "S16"
|
||
|
|
}
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"output": {
|
||
|
|
"type": "structure",
|
||
|
|
"members": {}
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"CreateFolder": {
|
||
|
|
"http": {
|
||
|
|
"requestUri": "/api/v1/folders",
|
||
|
|
"responseCode": 201
|
||
|
|
},
|
||
|
|
"input": {
|
||
|
|
"type": "structure",
|
||
|
|
"required": [
|
||
|
|
"ParentFolderId"
|
||
|
|
],
|
||
|
|
"members": {
|
||
|
|
"AuthenticationToken": {
|
||
|
|
"shape": "S2",
|
||
|
|
"location": "header",
|
||
|
|
"locationName": "Authentication"
|
||
|
|
},
|
||
|
|
"Name": {},
|
||
|
|
"ParentFolderId": {}
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"output": {
|
||
|
|
"type": "structure",
|
||
|
|
"members": {
|
||
|
|
"Metadata": {
|
||
|
|
"shape": "S1d"
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"CreateLabels": {
|
||
|
|
"http": {
|
||
|
|
"method": "PUT",
|
||
|
|
"requestUri": "/api/v1/resources/{ResourceId}/labels",
|
||
|
|
"responseCode": 200
|
||
|
|
},
|
||
|
|
"input": {
|
||
|
|
"type": "structure",
|
||
|
|
"required": [
|
||
|
|
"ResourceId",
|
||
|
|
"Labels"
|
||
|
|
],
|
||
|
|
"members": {
|
||
|
|
"ResourceId": {
|
||
|
|
"location": "uri",
|
||
|
|
"locationName": "ResourceId"
|
||
|
|
},
|
||
|
|
"Labels": {
|
||
|
|
"shape": "S1g"
|
||
|
|
},
|
||
|
|
"AuthenticationToken": {
|
||
|
|
"shape": "S2",
|
||
|
|
"location": "header",
|
||
|
|
"locationName": "Authentication"
|
||
|
|
}
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"output": {
|
||
|
|
"type": "structure",
|
||
|
|
"members": {}
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"CreateNotificationSubscription": {
|
||
|
|
"http": {
|
||
|
|
"requestUri": "/api/v1/organizations/{OrganizationId}/subscriptions",
|
||
|
|
"responseCode": 200
|
||
|
|
},
|
||
|
|
"input": {
|
||
|
|
"type": "structure",
|
||
|
|
"required": [
|
||
|
|
"OrganizationId",
|
||
|
|
"Endpoint",
|
||
|
|
"Protocol",
|
||
|
|
"SubscriptionType"
|
||
|
|
],
|
||
|
|
"members": {
|
||
|
|
"OrganizationId": {
|
||
|
|
"location": "uri",
|
||
|
|
"locationName": "OrganizationId"
|
||
|
|
},
|
||
|
|
"Endpoint": {},
|
||
|
|
"Protocol": {},
|
||
|
|
"SubscriptionType": {}
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"output": {
|
||
|
|
"type": "structure",
|
||
|
|
"members": {
|
||
|
|
"Subscription": {
|
||
|
|
"shape": "S1p"
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"CreateUser": {
|
||
|
|
"http": {
|
||
|
|
"requestUri": "/api/v1/users",
|
||
|
|
"responseCode": 201
|
||
|
|
},
|
||
|
|
"input": {
|
||
|
|
"type": "structure",
|
||
|
|
"required": [
|
||
|
|
"Username",
|
||
|
|
"GivenName",
|
||
|
|
"Surname",
|
||
|
|
"Password"
|
||
|
|
],
|
||
|
|
"members": {
|
||
|
|
"OrganizationId": {},
|
||
|
|
"Username": {},
|
||
|
|
"EmailAddress": {},
|
||
|
|
"GivenName": {},
|
||
|
|
"Surname": {},
|
||
|
|
"Password": {
|
||
|
|
"type": "string",
|
||
|
|
"sensitive": true
|
||
|
|
},
|
||
|
|
"TimeZoneId": {},
|
||
|
|
"StorageRule": {
|
||
|
|
"shape": "Sj"
|
||
|
|
},
|
||
|
|
"AuthenticationToken": {
|
||
|
|
"shape": "S2",
|
||
|
|
"location": "header",
|
||
|
|
"locationName": "Authentication"
|
||
|
|
}
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"output": {
|
||
|
|
"type": "structure",
|
||
|
|
"members": {
|
||
|
|
"User": {
|
||
|
|
"shape": "S8"
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"DeactivateUser": {
|
||
|
|
"http": {
|
||
|
|
"method": "DELETE",
|
||
|
|
"requestUri": "/api/v1/users/{UserId}/activation",
|
||
|
|
"responseCode": 204
|
||
|
|
},
|
||
|
|
"input": {
|
||
|
|
"type": "structure",
|
||
|
|
"required": [
|
||
|
|
"UserId"
|
||
|
|
],
|
||
|
|
"members": {
|
||
|
|
"UserId": {
|
||
|
|
"location": "uri",
|
||
|
|
"locationName": "UserId"
|
||
|
|
},
|
||
|
|
"AuthenticationToken": {
|
||
|
|
"shape": "S2",
|
||
|
|
"location": "header",
|
||
|
|
"locationName": "Authentication"
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"DeleteComment": {
|
||
|
|
"http": {
|
||
|
|
"method": "DELETE",
|
||
|
|
"requestUri": "/api/v1/documents/{DocumentId}/versions/{VersionId}/comment/{CommentId}",
|
||
|
|
"responseCode": 204
|
||
|
|
},
|
||
|
|
"input": {
|
||
|
|
"type": "structure",
|
||
|
|
"required": [
|
||
|
|
"DocumentId",
|
||
|
|
"VersionId",
|
||
|
|
"CommentId"
|
||
|
|
],
|
||
|
|
"members": {
|
||
|
|
"AuthenticationToken": {
|
||
|
|
"shape": "S2",
|
||
|
|
"location": "header",
|
||
|
|
"locationName": "Authentication"
|
||
|
|
},
|
||
|
|
"DocumentId": {
|
||
|
|
"location": "uri",
|
||
|
|
"locationName": "DocumentId"
|
||
|
|
},
|
||
|
|
"VersionId": {
|
||
|
|
"location": "uri",
|
||
|
|
"locationName": "VersionId"
|
||
|
|
},
|
||
|
|
"CommentId": {
|
||
|
|
"location": "uri",
|
||
|
|
"locationName": "CommentId"
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"DeleteCustomMetadata": {
|
||
|
|
"http": {
|
||
|
|
"method": "DELETE",
|
||
|
|
"requestUri": "/api/v1/resources/{ResourceId}/customMetadata",
|
||
|
|
"responseCode": 200
|
||
|
|
},
|
||
|
|
"input": {
|
||
|
|
"type": "structure",
|
||
|
|
"required": [
|
||
|
|
"ResourceId"
|
||
|
|
],
|
||
|
|
"members": {
|
||
|
|
"AuthenticationToken": {
|
||
|
|
"shape": "S2",
|
||
|
|
"location": "header",
|
||
|
|
"locationName": "Authentication"
|
||
|
|
},
|
||
|
|
"ResourceId": {
|
||
|
|
"location": "uri",
|
||
|
|
"locationName": "ResourceId"
|
||
|
|
},
|
||
|
|
"VersionId": {
|
||
|
|
"location": "querystring",
|
||
|
|
"locationName": "versionId"
|
||
|
|
},
|
||
|
|
"Keys": {
|
||
|
|
"location": "querystring",
|
||
|
|
"locationName": "keys",
|
||
|
|
"type": "list",
|
||
|
|
"member": {}
|
||
|
|
},
|
||
|
|
"DeleteAll": {
|
||
|
|
"location": "querystring",
|
||
|
|
"locationName": "deleteAll",
|
||
|
|
"type": "boolean"
|
||
|
|
}
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"output": {
|
||
|
|
"type": "structure",
|
||
|
|
"members": {}
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"DeleteDocument": {
|
||
|
|
"http": {
|
||
|
|
"method": "DELETE",
|
||
|
|
"requestUri": "/api/v1/documents/{DocumentId}",
|
||
|
|
"responseCode": 204
|
||
|
|
},
|
||
|
|
"input": {
|
||
|
|
"type": "structure",
|
||
|
|
"required": [
|
||
|
|
"DocumentId"
|
||
|
|
],
|
||
|
|
"members": {
|
||
|
|
"AuthenticationToken": {
|
||
|
|
"shape": "S2",
|
||
|
|
"location": "header",
|
||
|
|
"locationName": "Authentication"
|
||
|
|
},
|
||
|
|
"DocumentId": {
|
||
|
|
"location": "uri",
|
||
|
|
"locationName": "DocumentId"
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"DeleteFolder": {
|
||
|
|
"http": {
|
||
|
|
"method": "DELETE",
|
||
|
|
"requestUri": "/api/v1/folders/{FolderId}",
|
||
|
|
"responseCode": 204
|
||
|
|
},
|
||
|
|
"input": {
|
||
|
|
"type": "structure",
|
||
|
|
"required": [
|
||
|
|
"FolderId"
|
||
|
|
],
|
||
|
|
"members": {
|
||
|
|
"AuthenticationToken": {
|
||
|
|
"shape": "S2",
|
||
|
|
"location": "header",
|
||
|
|
"locationName": "Authentication"
|
||
|
|
},
|
||
|
|
"FolderId": {
|
||
|
|
"location": "uri",
|
||
|
|
"locationName": "FolderId"
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"DeleteFolderContents": {
|
||
|
|
"http": {
|
||
|
|
"method": "DELETE",
|
||
|
|
"requestUri": "/api/v1/folders/{FolderId}/contents",
|
||
|
|
"responseCode": 204
|
||
|
|
},
|
||
|
|
"input": {
|
||
|
|
"type": "structure",
|
||
|
|
"required": [
|
||
|
|
"FolderId"
|
||
|
|
],
|
||
|
|
"members": {
|
||
|
|
"AuthenticationToken": {
|
||
|
|
"shape": "S2",
|
||
|
|
"location": "header",
|
||
|
|
"locationName": "Authentication"
|
||
|
|
},
|
||
|
|
"FolderId": {
|
||
|
|
"location": "uri",
|
||
|
|
"locationName": "FolderId"
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"DeleteLabels": {
|
||
|
|
"http": {
|
||
|
|
"method": "DELETE",
|
||
|
|
"requestUri": "/api/v1/resources/{ResourceId}/labels",
|
||
|
|
"responseCode": 200
|
||
|
|
},
|
||
|
|
"input": {
|
||
|
|
"type": "structure",
|
||
|
|
"required": [
|
||
|
|
"ResourceId"
|
||
|
|
],
|
||
|
|
"members": {
|
||
|
|
"ResourceId": {
|
||
|
|
"location": "uri",
|
||
|
|
"locationName": "ResourceId"
|
||
|
|
},
|
||
|
|
"AuthenticationToken": {
|
||
|
|
"shape": "S2",
|
||
|
|
"location": "header",
|
||
|
|
"locationName": "Authentication"
|
||
|
|
},
|
||
|
|
"Labels": {
|
||
|
|
"shape": "S1g",
|
||
|
|
"location": "querystring",
|
||
|
|
"locationName": "labels"
|
||
|
|
},
|
||
|
|
"DeleteAll": {
|
||
|
|
"location": "querystring",
|
||
|
|
"locationName": "deleteAll",
|
||
|
|
"type": "boolean"
|
||
|
|
}
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"output": {
|
||
|
|
"type": "structure",
|
||
|
|
"members": {}
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"DeleteNotificationSubscription": {
|
||
|
|
"http": {
|
||
|
|
"method": "DELETE",
|
||
|
|
"requestUri": "/api/v1/organizations/{OrganizationId}/subscriptions/{SubscriptionId}",
|
||
|
|
"responseCode": 200
|
||
|
|
},
|
||
|
|
"input": {
|
||
|
|
"type": "structure",
|
||
|
|
"required": [
|
||
|
|
"SubscriptionId",
|
||
|
|
"OrganizationId"
|
||
|
|
],
|
||
|
|
"members": {
|
||
|
|
"SubscriptionId": {
|
||
|
|
"location": "uri",
|
||
|
|
"locationName": "SubscriptionId"
|
||
|
|
},
|
||
|
|
"OrganizationId": {
|
||
|
|
"location": "uri",
|
||
|
|
"locationName": "OrganizationId"
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"DeleteUser": {
|
||
|
|
"http": {
|
||
|
|
"method": "DELETE",
|
||
|
|
"requestUri": "/api/v1/users/{UserId}",
|
||
|
|
"responseCode": 204
|
||
|
|
},
|
||
|
|
"input": {
|
||
|
|
"type": "structure",
|
||
|
|
"required": [
|
||
|
|
"UserId"
|
||
|
|
],
|
||
|
|
"members": {
|
||
|
|
"AuthenticationToken": {
|
||
|
|
"shape": "S2",
|
||
|
|
"location": "header",
|
||
|
|
"locationName": "Authentication"
|
||
|
|
},
|
||
|
|
"UserId": {
|
||
|
|
"location": "uri",
|
||
|
|
"locationName": "UserId"
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"DescribeActivities": {
|
||
|
|
"http": {
|
||
|
|
"method": "GET",
|
||
|
|
"requestUri": "/api/v1/activities",
|
||
|
|
"responseCode": 200
|
||
|
|
},
|
||
|
|
"input": {
|
||
|
|
"type": "structure",
|
||
|
|
"members": {
|
||
|
|
"AuthenticationToken": {
|
||
|
|
"shape": "S2",
|
||
|
|
"location": "header",
|
||
|
|
"locationName": "Authentication"
|
||
|
|
},
|
||
|
|
"StartTime": {
|
||
|
|
"location": "querystring",
|
||
|
|
"locationName": "startTime",
|
||
|
|
"type": "timestamp"
|
||
|
|
},
|
||
|
|
"EndTime": {
|
||
|
|
"location": "querystring",
|
||
|
|
"locationName": "endTime",
|
||
|
|
"type": "timestamp"
|
||
|
|
},
|
||
|
|
"OrganizationId": {
|
||
|
|
"location": "querystring",
|
||
|
|
"locationName": "organizationId"
|
||
|
|
},
|
||
|
|
"ActivityTypes": {
|
||
|
|
"location": "querystring",
|
||
|
|
"locationName": "activityTypes"
|
||
|
|
},
|
||
|
|
"ResourceId": {
|
||
|
|
"location": "querystring",
|
||
|
|
"locationName": "resourceId"
|
||
|
|
},
|
||
|
|
"UserId": {
|
||
|
|
"location": "querystring",
|
||
|
|
"locationName": "userId"
|
||
|
|
},
|
||
|
|
"IncludeIndirectActivities": {
|
||
|
|
"location": "querystring",
|
||
|
|
"locationName": "includeIndirectActivities",
|
||
|
|
"type": "boolean"
|
||
|
|
},
|
||
|
|
"Limit": {
|
||
|
|
"location": "querystring",
|
||
|
|
"locationName": "limit",
|
||
|
|
"type": "integer"
|
||
|
|
},
|
||
|
|
"Marker": {
|
||
|
|
"location": "querystring",
|
||
|
|
"locationName": "marker"
|
||
|
|
}
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"output": {
|
||
|
|
"type": "structure",
|
||
|
|
"members": {
|
||
|
|
"UserActivities": {
|
||
|
|
"type": "list",
|
||
|
|
"member": {
|
||
|
|
"type": "structure",
|
||
|
|
"members": {
|
||
|
|
"Type": {},
|
||
|
|
"TimeStamp": {
|
||
|
|
"type": "timestamp"
|
||
|
|
},
|
||
|
|
"IsIndirectActivity": {
|
||
|
|
"type": "boolean"
|
||
|
|
},
|
||
|
|
"OrganizationId": {},
|
||
|
|
"Initiator": {
|
||
|
|
"shape": "S2d"
|
||
|
|
},
|
||
|
|
"Participants": {
|
||
|
|
"type": "structure",
|
||
|
|
"members": {
|
||
|
|
"Users": {
|
||
|
|
"type": "list",
|
||
|
|
"member": {
|
||
|
|
"shape": "S2d"
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"Groups": {
|
||
|
|
"shape": "S2g"
|
||
|
|
}
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"ResourceMetadata": {
|
||
|
|
"shape": "S2j"
|
||
|
|
},
|
||
|
|
"OriginalParent": {
|
||
|
|
"shape": "S2j"
|
||
|
|
},
|
||
|
|
"CommentMetadata": {
|
||
|
|
"type": "structure",
|
||
|
|
"members": {
|
||
|
|
"CommentId": {},
|
||
|
|
"Contributor": {
|
||
|
|
"shape": "S8"
|
||
|
|
},
|
||
|
|
"CreatedTimestamp": {
|
||
|
|
"type": "timestamp"
|
||
|
|
},
|
||
|
|
"CommentStatus": {},
|
||
|
|
"RecipientId": {}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"Marker": {}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"DescribeComments": {
|
||
|
|
"http": {
|
||
|
|
"method": "GET",
|
||
|
|
"requestUri": "/api/v1/documents/{DocumentId}/versions/{VersionId}/comments",
|
||
|
|
"responseCode": 200
|
||
|
|
},
|
||
|
|
"input": {
|
||
|
|
"type": "structure",
|
||
|
|
"required": [
|
||
|
|
"DocumentId",
|
||
|
|
"VersionId"
|
||
|
|
],
|
||
|
|
"members": {
|
||
|
|
"AuthenticationToken": {
|
||
|
|
"shape": "S2",
|
||
|
|
"location": "header",
|
||
|
|
"locationName": "Authentication"
|
||
|
|
},
|
||
|
|
"DocumentId": {
|
||
|
|
"location": "uri",
|
||
|
|
"locationName": "DocumentId"
|
||
|
|
},
|
||
|
|
"VersionId": {
|
||
|
|
"location": "uri",
|
||
|
|
"locationName": "VersionId"
|
||
|
|
},
|
||
|
|
"Limit": {
|
||
|
|
"location": "querystring",
|
||
|
|
"locationName": "limit",
|
||
|
|
"type": "integer"
|
||
|
|
},
|
||
|
|
"Marker": {
|
||
|
|
"location": "querystring",
|
||
|
|
"locationName": "marker"
|
||
|
|
}
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"output": {
|
||
|
|
"type": "structure",
|
||
|
|
"members": {
|
||
|
|
"Comments": {
|
||
|
|
"type": "list",
|
||
|
|
"member": {
|
||
|
|
"shape": "S13"
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"Marker": {}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"DescribeDocumentVersions": {
|
||
|
|
"http": {
|
||
|
|
"method": "GET",
|
||
|
|
"requestUri": "/api/v1/documents/{DocumentId}/versions",
|
||
|
|
"responseCode": 200
|
||
|
|
},
|
||
|
|
"input": {
|
||
|
|
"type": "structure",
|
||
|
|
"required": [
|
||
|
|
"DocumentId"
|
||
|
|
],
|
||
|
|
"members": {
|
||
|
|
"AuthenticationToken": {
|
||
|
|
"shape": "S2",
|
||
|
|
"location": "header",
|
||
|
|
"locationName": "Authentication"
|
||
|
|
},
|
||
|
|
"DocumentId": {
|
||
|
|
"location": "uri",
|
||
|
|
"locationName": "DocumentId"
|
||
|
|
},
|
||
|
|
"Marker": {
|
||
|
|
"location": "querystring",
|
||
|
|
"locationName": "marker"
|
||
|
|
},
|
||
|
|
"Limit": {
|
||
|
|
"location": "querystring",
|
||
|
|
"locationName": "limit",
|
||
|
|
"type": "integer"
|
||
|
|
},
|
||
|
|
"Include": {
|
||
|
|
"location": "querystring",
|
||
|
|
"locationName": "include"
|
||
|
|
},
|
||
|
|
"Fields": {
|
||
|
|
"location": "querystring",
|
||
|
|
"locationName": "fields"
|
||
|
|
}
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"output": {
|
||
|
|
"type": "structure",
|
||
|
|
"members": {
|
||
|
|
"DocumentVersions": {
|
||
|
|
"type": "list",
|
||
|
|
"member": {
|
||
|
|
"shape": "S2u"
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"Marker": {}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"DescribeFolderContents": {
|
||
|
|
"http": {
|
||
|
|
"method": "GET",
|
||
|
|
"requestUri": "/api/v1/folders/{FolderId}/contents",
|
||
|
|
"responseCode": 200
|
||
|
|
},
|
||
|
|
"input": {
|
||
|
|
"type": "structure",
|
||
|
|
"required": [
|
||
|
|
"FolderId"
|
||
|
|
],
|
||
|
|
"members": {
|
||
|
|
"AuthenticationToken": {
|
||
|
|
"shape": "S2",
|
||
|
|
"location": "header",
|
||
|
|
"locationName": "Authentication"
|
||
|
|
},
|
||
|
|
"FolderId": {
|
||
|
|
"location": "uri",
|
||
|
|
"locationName": "FolderId"
|
||
|
|
},
|
||
|
|
"Sort": {
|
||
|
|
"location": "querystring",
|
||
|
|
"locationName": "sort"
|
||
|
|
},
|
||
|
|
"Order": {
|
||
|
|
"location": "querystring",
|
||
|
|
"locationName": "order"
|
||
|
|
},
|
||
|
|
"Limit": {
|
||
|
|
"location": "querystring",
|
||
|
|
"locationName": "limit",
|
||
|
|
"type": "integer"
|
||
|
|
},
|
||
|
|
"Marker": {
|
||
|
|
"location": "querystring",
|
||
|
|
"locationName": "marker"
|
||
|
|
},
|
||
|
|
"Type": {
|
||
|
|
"location": "querystring",
|
||
|
|
"locationName": "type"
|
||
|
|
},
|
||
|
|
"Include": {
|
||
|
|
"location": "querystring",
|
||
|
|
"locationName": "include"
|
||
|
|
}
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"output": {
|
||
|
|
"type": "structure",
|
||
|
|
"members": {
|
||
|
|
"Folders": {
|
||
|
|
"shape": "S37"
|
||
|
|
},
|
||
|
|
"Documents": {
|
||
|
|
"shape": "S38"
|
||
|
|
},
|
||
|
|
"Marker": {}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"DescribeGroups": {
|
||
|
|
"http": {
|
||
|
|
"method": "GET",
|
||
|
|
"requestUri": "/api/v1/groups",
|
||
|
|
"responseCode": 200
|
||
|
|
},
|
||
|
|
"input": {
|
||
|
|
"type": "structure",
|
||
|
|
"required": [
|
||
|
|
"SearchQuery"
|
||
|
|
],
|
||
|
|
"members": {
|
||
|
|
"AuthenticationToken": {
|
||
|
|
"shape": "S2",
|
||
|
|
"location": "header",
|
||
|
|
"locationName": "Authentication"
|
||
|
|
},
|
||
|
|
"SearchQuery": {
|
||
|
|
"shape": "S3b",
|
||
|
|
"location": "querystring",
|
||
|
|
"locationName": "searchQuery"
|
||
|
|
},
|
||
|
|
"OrganizationId": {
|
||
|
|
"location": "querystring",
|
||
|
|
"locationName": "organizationId"
|
||
|
|
},
|
||
|
|
"Marker": {
|
||
|
|
"location": "querystring",
|
||
|
|
"locationName": "marker"
|
||
|
|
},
|
||
|
|
"Limit": {
|
||
|
|
"location": "querystring",
|
||
|
|
"locationName": "limit",
|
||
|
|
"type": "integer"
|
||
|
|
}
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"output": {
|
||
|
|
"type": "structure",
|
||
|
|
"members": {
|
||
|
|
"Groups": {
|
||
|
|
"shape": "S2g"
|
||
|
|
},
|
||
|
|
"Marker": {}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"DescribeNotificationSubscriptions": {
|
||
|
|
"http": {
|
||
|
|
"method": "GET",
|
||
|
|
"requestUri": "/api/v1/organizations/{OrganizationId}/subscriptions",
|
||
|
|
"responseCode": 200
|
||
|
|
},
|
||
|
|
"input": {
|
||
|
|
"type": "structure",
|
||
|
|
"required": [
|
||
|
|
"OrganizationId"
|
||
|
|
],
|
||
|
|
"members": {
|
||
|
|
"OrganizationId": {
|
||
|
|
"location": "uri",
|
||
|
|
"locationName": "OrganizationId"
|
||
|
|
},
|
||
|
|
"Marker": {
|
||
|
|
"location": "querystring",
|
||
|
|
"locationName": "marker"
|
||
|
|
},
|
||
|
|
"Limit": {
|
||
|
|
"location": "querystring",
|
||
|
|
"locationName": "limit",
|
||
|
|
"type": "integer"
|
||
|
|
}
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"output": {
|
||
|
|
"type": "structure",
|
||
|
|
"members": {
|
||
|
|
"Subscriptions": {
|
||
|
|
"type": "list",
|
||
|
|
"member": {
|
||
|
|
"shape": "S1p"
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"Marker": {}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"DescribeResourcePermissions": {
|
||
|
|
"http": {
|
||
|
|
"method": "GET",
|
||
|
|
"requestUri": "/api/v1/resources/{ResourceId}/permissions",
|
||
|
|
"responseCode": 200
|
||
|
|
},
|
||
|
|
"input": {
|
||
|
|
"type": "structure",
|
||
|
|
"required": [
|
||
|
|
"ResourceId"
|
||
|
|
],
|
||
|
|
"members": {
|
||
|
|
"AuthenticationToken": {
|
||
|
|
"shape": "S2",
|
||
|
|
"location": "header",
|
||
|
|
"locationName": "Authentication"
|
||
|
|
},
|
||
|
|
"ResourceId": {
|
||
|
|
"location": "uri",
|
||
|
|
"locationName": "ResourceId"
|
||
|
|
},
|
||
|
|
"PrincipalId": {
|
||
|
|
"location": "querystring",
|
||
|
|
"locationName": "principalId"
|
||
|
|
},
|
||
|
|
"Limit": {
|
||
|
|
"location": "querystring",
|
||
|
|
"locationName": "limit",
|
||
|
|
"type": "integer"
|
||
|
|
},
|
||
|
|
"Marker": {
|
||
|
|
"location": "querystring",
|
||
|
|
"locationName": "marker"
|
||
|
|
}
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"output": {
|
||
|
|
"type": "structure",
|
||
|
|
"members": {
|
||
|
|
"Principals": {
|
||
|
|
"type": "list",
|
||
|
|
"member": {
|
||
|
|
"type": "structure",
|
||
|
|
"members": {
|
||
|
|
"Id": {},
|
||
|
|
"Type": {},
|
||
|
|
"Roles": {
|
||
|
|
"type": "list",
|
||
|
|
"member": {
|
||
|
|
"type": "structure",
|
||
|
|
"members": {
|
||
|
|
"Role": {},
|
||
|
|
"Type": {}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"Marker": {}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"DescribeRootFolders": {
|
||
|
|
"http": {
|
||
|
|
"method": "GET",
|
||
|
|
"requestUri": "/api/v1/me/root",
|
||
|
|
"responseCode": 200
|
||
|
|
},
|
||
|
|
"input": {
|
||
|
|
"type": "structure",
|
||
|
|
"required": [
|
||
|
|
"AuthenticationToken"
|
||
|
|
],
|
||
|
|
"members": {
|
||
|
|
"AuthenticationToken": {
|
||
|
|
"shape": "S2",
|
||
|
|
"location": "header",
|
||
|
|
"locationName": "Authentication"
|
||
|
|
},
|
||
|
|
"Limit": {
|
||
|
|
"location": "querystring",
|
||
|
|
"locationName": "limit",
|
||
|
|
"type": "integer"
|
||
|
|
},
|
||
|
|
"Marker": {
|
||
|
|
"location": "querystring",
|
||
|
|
"locationName": "marker"
|
||
|
|
}
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"output": {
|
||
|
|
"type": "structure",
|
||
|
|
"members": {
|
||
|
|
"Folders": {
|
||
|
|
"shape": "S37"
|
||
|
|
},
|
||
|
|
"Marker": {}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"DescribeUsers": {
|
||
|
|
"http": {
|
||
|
|
"method": "GET",
|
||
|
|
"requestUri": "/api/v1/users",
|
||
|
|
"responseCode": 200
|
||
|
|
},
|
||
|
|
"input": {
|
||
|
|
"type": "structure",
|
||
|
|
"members": {
|
||
|
|
"AuthenticationToken": {
|
||
|
|
"shape": "S2",
|
||
|
|
"location": "header",
|
||
|
|
"locationName": "Authentication"
|
||
|
|
},
|
||
|
|
"OrganizationId": {
|
||
|
|
"location": "querystring",
|
||
|
|
"locationName": "organizationId"
|
||
|
|
},
|
||
|
|
"UserIds": {
|
||
|
|
"location": "querystring",
|
||
|
|
"locationName": "userIds"
|
||
|
|
},
|
||
|
|
"Query": {
|
||
|
|
"shape": "S3b",
|
||
|
|
"location": "querystring",
|
||
|
|
"locationName": "query"
|
||
|
|
},
|
||
|
|
"Include": {
|
||
|
|
"location": "querystring",
|
||
|
|
"locationName": "include"
|
||
|
|
},
|
||
|
|
"Order": {
|
||
|
|
"location": "querystring",
|
||
|
|
"locationName": "order"
|
||
|
|
},
|
||
|
|
"Sort": {
|
||
|
|
"location": "querystring",
|
||
|
|
"locationName": "sort"
|
||
|
|
},
|
||
|
|
"Marker": {
|
||
|
|
"location": "querystring",
|
||
|
|
"locationName": "marker"
|
||
|
|
},
|
||
|
|
"Limit": {
|
||
|
|
"location": "querystring",
|
||
|
|
"locationName": "limit",
|
||
|
|
"type": "integer"
|
||
|
|
},
|
||
|
|
"Fields": {
|
||
|
|
"location": "querystring",
|
||
|
|
"locationName": "fields"
|
||
|
|
}
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"output": {
|
||
|
|
"type": "structure",
|
||
|
|
"members": {
|
||
|
|
"Users": {
|
||
|
|
"type": "list",
|
||
|
|
"member": {
|
||
|
|
"shape": "S8"
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"TotalNumberOfUsers": {
|
||
|
|
"deprecated": true,
|
||
|
|
"type": "long"
|
||
|
|
},
|
||
|
|
"Marker": {}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"GetCurrentUser": {
|
||
|
|
"http": {
|
||
|
|
"method": "GET",
|
||
|
|
"requestUri": "/api/v1/me",
|
||
|
|
"responseCode": 200
|
||
|
|
},
|
||
|
|
"input": {
|
||
|
|
"type": "structure",
|
||
|
|
"required": [
|
||
|
|
"AuthenticationToken"
|
||
|
|
],
|
||
|
|
"members": {
|
||
|
|
"AuthenticationToken": {
|
||
|
|
"shape": "S2",
|
||
|
|
"location": "header",
|
||
|
|
"locationName": "Authentication"
|
||
|
|
}
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"output": {
|
||
|
|
"type": "structure",
|
||
|
|
"members": {
|
||
|
|
"User": {
|
||
|
|
"shape": "S8"
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"GetDocument": {
|
||
|
|
"http": {
|
||
|
|
"method": "GET",
|
||
|
|
"requestUri": "/api/v1/documents/{DocumentId}",
|
||
|
|
"responseCode": 200
|
||
|
|
},
|
||
|
|
"input": {
|
||
|
|
"type": "structure",
|
||
|
|
"required": [
|
||
|
|
"DocumentId"
|
||
|
|
],
|
||
|
|
"members": {
|
||
|
|
"AuthenticationToken": {
|
||
|
|
"shape": "S2",
|
||
|
|
"location": "header",
|
||
|
|
"locationName": "Authentication"
|
||
|
|
},
|
||
|
|
"DocumentId": {
|
||
|
|
"location": "uri",
|
||
|
|
"locationName": "DocumentId"
|
||
|
|
},
|
||
|
|
"IncludeCustomMetadata": {
|
||
|
|
"location": "querystring",
|
||
|
|
"locationName": "includeCustomMetadata",
|
||
|
|
"type": "boolean"
|
||
|
|
}
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"output": {
|
||
|
|
"type": "structure",
|
||
|
|
"members": {
|
||
|
|
"Metadata": {
|
||
|
|
"shape": "S39"
|
||
|
|
},
|
||
|
|
"CustomMetadata": {
|
||
|
|
"shape": "S16"
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"GetDocumentPath": {
|
||
|
|
"http": {
|
||
|
|
"method": "GET",
|
||
|
|
"requestUri": "/api/v1/documents/{DocumentId}/path",
|
||
|
|
"responseCode": 200
|
||
|
|
},
|
||
|
|
"input": {
|
||
|
|
"type": "structure",
|
||
|
|
"required": [
|
||
|
|
"DocumentId"
|
||
|
|
],
|
||
|
|
"members": {
|
||
|
|
"AuthenticationToken": {
|
||
|
|
"shape": "S2",
|
||
|
|
"location": "header",
|
||
|
|
"locationName": "Authentication"
|
||
|
|
},
|
||
|
|
"DocumentId": {
|
||
|
|
"location": "uri",
|
||
|
|
"locationName": "DocumentId"
|
||
|
|
},
|
||
|
|
"Limit": {
|
||
|
|
"location": "querystring",
|
||
|
|
"locationName": "limit",
|
||
|
|
"type": "integer"
|
||
|
|
},
|
||
|
|
"Fields": {
|
||
|
|
"location": "querystring",
|
||
|
|
"locationName": "fields"
|
||
|
|
},
|
||
|
|
"Marker": {
|
||
|
|
"location": "querystring",
|
||
|
|
"locationName": "marker"
|
||
|
|
}
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"output": {
|
||
|
|
"type": "structure",
|
||
|
|
"members": {
|
||
|
|
"Path": {
|
||
|
|
"shape": "S42"
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"GetDocumentVersion": {
|
||
|
|
"http": {
|
||
|
|
"method": "GET",
|
||
|
|
"requestUri": "/api/v1/documents/{DocumentId}/versions/{VersionId}",
|
||
|
|
"responseCode": 200
|
||
|
|
},
|
||
|
|
"input": {
|
||
|
|
"type": "structure",
|
||
|
|
"required": [
|
||
|
|
"DocumentId",
|
||
|
|
"VersionId"
|
||
|
|
],
|
||
|
|
"members": {
|
||
|
|
"AuthenticationToken": {
|
||
|
|
"shape": "S2",
|
||
|
|
"location": "header",
|
||
|
|
"locationName": "Authentication"
|
||
|
|
},
|
||
|
|
"DocumentId": {
|
||
|
|
"location": "uri",
|
||
|
|
"locationName": "DocumentId"
|
||
|
|
},
|
||
|
|
"VersionId": {
|
||
|
|
"location": "uri",
|
||
|
|
"locationName": "VersionId"
|
||
|
|
},
|
||
|
|
"Fields": {
|
||
|
|
"location": "querystring",
|
||
|
|
"locationName": "fields"
|
||
|
|
},
|
||
|
|
"IncludeCustomMetadata": {
|
||
|
|
"location": "querystring",
|
||
|
|
"locationName": "includeCustomMetadata",
|
||
|
|
"type": "boolean"
|
||
|
|
}
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"output": {
|
||
|
|
"type": "structure",
|
||
|
|
"members": {
|
||
|
|
"Metadata": {
|
||
|
|
"shape": "S2u"
|
||
|
|
},
|
||
|
|
"CustomMetadata": {
|
||
|
|
"shape": "S16"
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"GetFolder": {
|
||
|
|
"http": {
|
||
|
|
"method": "GET",
|
||
|
|
"requestUri": "/api/v1/folders/{FolderId}",
|
||
|
|
"responseCode": 200
|
||
|
|
},
|
||
|
|
"input": {
|
||
|
|
"type": "structure",
|
||
|
|
"required": [
|
||
|
|
"FolderId"
|
||
|
|
],
|
||
|
|
"members": {
|
||
|
|
"AuthenticationToken": {
|
||
|
|
"shape": "S2",
|
||
|
|
"location": "header",
|
||
|
|
"locationName": "Authentication"
|
||
|
|
},
|
||
|
|
"FolderId": {
|
||
|
|
"location": "uri",
|
||
|
|
"locationName": "FolderId"
|
||
|
|
},
|
||
|
|
"IncludeCustomMetadata": {
|
||
|
|
"location": "querystring",
|
||
|
|
"locationName": "includeCustomMetadata",
|
||
|
|
"type": "boolean"
|
||
|
|
}
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"output": {
|
||
|
|
"type": "structure",
|
||
|
|
"members": {
|
||
|
|
"Metadata": {
|
||
|
|
"shape": "S1d"
|
||
|
|
},
|
||
|
|
"CustomMetadata": {
|
||
|
|
"shape": "S16"
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"GetFolderPath": {
|
||
|
|
"http": {
|
||
|
|
"method": "GET",
|
||
|
|
"requestUri": "/api/v1/folders/{FolderId}/path",
|
||
|
|
"responseCode": 200
|
||
|
|
},
|
||
|
|
"input": {
|
||
|
|
"type": "structure",
|
||
|
|
"required": [
|
||
|
|
"FolderId"
|
||
|
|
],
|
||
|
|
"members": {
|
||
|
|
"AuthenticationToken": {
|
||
|
|
"shape": "S2",
|
||
|
|
"location": "header",
|
||
|
|
"locationName": "Authentication"
|
||
|
|
},
|
||
|
|
"FolderId": {
|
||
|
|
"location": "uri",
|
||
|
|
"locationName": "FolderId"
|
||
|
|
},
|
||
|
|
"Limit": {
|
||
|
|
"location": "querystring",
|
||
|
|
"locationName": "limit",
|
||
|
|
"type": "integer"
|
||
|
|
},
|
||
|
|
"Fields": {
|
||
|
|
"location": "querystring",
|
||
|
|
"locationName": "fields"
|
||
|
|
},
|
||
|
|
"Marker": {
|
||
|
|
"location": "querystring",
|
||
|
|
"locationName": "marker"
|
||
|
|
}
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"output": {
|
||
|
|
"type": "structure",
|
||
|
|
"members": {
|
||
|
|
"Path": {
|
||
|
|
"shape": "S42"
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"GetResources": {
|
||
|
|
"http": {
|
||
|
|
"method": "GET",
|
||
|
|
"requestUri": "/api/v1/resources",
|
||
|
|
"responseCode": 200
|
||
|
|
},
|
||
|
|
"input": {
|
||
|
|
"type": "structure",
|
||
|
|
"members": {
|
||
|
|
"AuthenticationToken": {
|
||
|
|
"shape": "S2",
|
||
|
|
"location": "header",
|
||
|
|
"locationName": "Authentication"
|
||
|
|
},
|
||
|
|
"UserId": {
|
||
|
|
"location": "querystring",
|
||
|
|
"locationName": "userId"
|
||
|
|
},
|
||
|
|
"CollectionType": {
|
||
|
|
"location": "querystring",
|
||
|
|
"locationName": "collectionType"
|
||
|
|
},
|
||
|
|
"Limit": {
|
||
|
|
"location": "querystring",
|
||
|
|
"locationName": "limit",
|
||
|
|
"type": "integer"
|
||
|
|
},
|
||
|
|
"Marker": {
|
||
|
|
"location": "querystring",
|
||
|
|
"locationName": "marker"
|
||
|
|
}
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"output": {
|
||
|
|
"type": "structure",
|
||
|
|
"members": {
|
||
|
|
"Folders": {
|
||
|
|
"shape": "S37"
|
||
|
|
},
|
||
|
|
"Documents": {
|
||
|
|
"shape": "S38"
|
||
|
|
},
|
||
|
|
"Marker": {}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"InitiateDocumentVersionUpload": {
|
||
|
|
"http": {
|
||
|
|
"requestUri": "/api/v1/documents",
|
||
|
|
"responseCode": 201
|
||
|
|
},
|
||
|
|
"input": {
|
||
|
|
"type": "structure",
|
||
|
|
"required": [
|
||
|
|
"ParentFolderId"
|
||
|
|
],
|
||
|
|
"members": {
|
||
|
|
"AuthenticationToken": {
|
||
|
|
"shape": "S2",
|
||
|
|
"location": "header",
|
||
|
|
"locationName": "Authentication"
|
||
|
|
},
|
||
|
|
"Id": {},
|
||
|
|
"Name": {},
|
||
|
|
"ContentCreatedTimestamp": {
|
||
|
|
"type": "timestamp"
|
||
|
|
},
|
||
|
|
"ContentModifiedTimestamp": {
|
||
|
|
"type": "timestamp"
|
||
|
|
},
|
||
|
|
"ContentType": {},
|
||
|
|
"DocumentSizeInBytes": {
|
||
|
|
"type": "long"
|
||
|
|
},
|
||
|
|
"ParentFolderId": {}
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"output": {
|
||
|
|
"type": "structure",
|
||
|
|
"members": {
|
||
|
|
"Metadata": {
|
||
|
|
"shape": "S39"
|
||
|
|
},
|
||
|
|
"UploadMetadata": {
|
||
|
|
"type": "structure",
|
||
|
|
"members": {
|
||
|
|
"UploadUrl": {
|
||
|
|
"shape": "S2z"
|
||
|
|
},
|
||
|
|
"SignedHeaders": {
|
||
|
|
"type": "map",
|
||
|
|
"key": {},
|
||
|
|
"value": {}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"RemoveAllResourcePermissions": {
|
||
|
|
"http": {
|
||
|
|
"method": "DELETE",
|
||
|
|
"requestUri": "/api/v1/resources/{ResourceId}/permissions",
|
||
|
|
"responseCode": 204
|
||
|
|
},
|
||
|
|
"input": {
|
||
|
|
"type": "structure",
|
||
|
|
"required": [
|
||
|
|
"ResourceId"
|
||
|
|
],
|
||
|
|
"members": {
|
||
|
|
"AuthenticationToken": {
|
||
|
|
"shape": "S2",
|
||
|
|
"location": "header",
|
||
|
|
"locationName": "Authentication"
|
||
|
|
},
|
||
|
|
"ResourceId": {
|
||
|
|
"location": "uri",
|
||
|
|
"locationName": "ResourceId"
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"RemoveResourcePermission": {
|
||
|
|
"http": {
|
||
|
|
"method": "DELETE",
|
||
|
|
"requestUri": "/api/v1/resources/{ResourceId}/permissions/{PrincipalId}",
|
||
|
|
"responseCode": 204
|
||
|
|
},
|
||
|
|
"input": {
|
||
|
|
"type": "structure",
|
||
|
|
"required": [
|
||
|
|
"ResourceId",
|
||
|
|
"PrincipalId"
|
||
|
|
],
|
||
|
|
"members": {
|
||
|
|
"AuthenticationToken": {
|
||
|
|
"shape": "S2",
|
||
|
|
"location": "header",
|
||
|
|
"locationName": "Authentication"
|
||
|
|
},
|
||
|
|
"ResourceId": {
|
||
|
|
"location": "uri",
|
||
|
|
"locationName": "ResourceId"
|
||
|
|
},
|
||
|
|
"PrincipalId": {
|
||
|
|
"location": "uri",
|
||
|
|
"locationName": "PrincipalId"
|
||
|
|
},
|
||
|
|
"PrincipalType": {
|
||
|
|
"location": "querystring",
|
||
|
|
"locationName": "type"
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"UpdateDocument": {
|
||
|
|
"http": {
|
||
|
|
"method": "PATCH",
|
||
|
|
"requestUri": "/api/v1/documents/{DocumentId}",
|
||
|
|
"responseCode": 200
|
||
|
|
},
|
||
|
|
"input": {
|
||
|
|
"type": "structure",
|
||
|
|
"required": [
|
||
|
|
"DocumentId"
|
||
|
|
],
|
||
|
|
"members": {
|
||
|
|
"AuthenticationToken": {
|
||
|
|
"shape": "S2",
|
||
|
|
"location": "header",
|
||
|
|
"locationName": "Authentication"
|
||
|
|
},
|
||
|
|
"DocumentId": {
|
||
|
|
"location": "uri",
|
||
|
|
"locationName": "DocumentId"
|
||
|
|
},
|
||
|
|
"Name": {},
|
||
|
|
"ParentFolderId": {},
|
||
|
|
"ResourceState": {}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"UpdateDocumentVersion": {
|
||
|
|
"http": {
|
||
|
|
"method": "PATCH",
|
||
|
|
"requestUri": "/api/v1/documents/{DocumentId}/versions/{VersionId}",
|
||
|
|
"responseCode": 200
|
||
|
|
},
|
||
|
|
"input": {
|
||
|
|
"type": "structure",
|
||
|
|
"required": [
|
||
|
|
"DocumentId",
|
||
|
|
"VersionId"
|
||
|
|
],
|
||
|
|
"members": {
|
||
|
|
"AuthenticationToken": {
|
||
|
|
"shape": "S2",
|
||
|
|
"location": "header",
|
||
|
|
"locationName": "Authentication"
|
||
|
|
},
|
||
|
|
"DocumentId": {
|
||
|
|
"location": "uri",
|
||
|
|
"locationName": "DocumentId"
|
||
|
|
},
|
||
|
|
"VersionId": {
|
||
|
|
"location": "uri",
|
||
|
|
"locationName": "VersionId"
|
||
|
|
},
|
||
|
|
"VersionStatus": {}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"UpdateFolder": {
|
||
|
|
"http": {
|
||
|
|
"method": "PATCH",
|
||
|
|
"requestUri": "/api/v1/folders/{FolderId}",
|
||
|
|
"responseCode": 200
|
||
|
|
},
|
||
|
|
"input": {
|
||
|
|
"type": "structure",
|
||
|
|
"required": [
|
||
|
|
"FolderId"
|
||
|
|
],
|
||
|
|
"members": {
|
||
|
|
"AuthenticationToken": {
|
||
|
|
"shape": "S2",
|
||
|
|
"location": "header",
|
||
|
|
"locationName": "Authentication"
|
||
|
|
},
|
||
|
|
"FolderId": {
|
||
|
|
"location": "uri",
|
||
|
|
"locationName": "FolderId"
|
||
|
|
},
|
||
|
|
"Name": {},
|
||
|
|
"ParentFolderId": {},
|
||
|
|
"ResourceState": {}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"UpdateUser": {
|
||
|
|
"http": {
|
||
|
|
"method": "PATCH",
|
||
|
|
"requestUri": "/api/v1/users/{UserId}",
|
||
|
|
"responseCode": 200
|
||
|
|
},
|
||
|
|
"input": {
|
||
|
|
"type": "structure",
|
||
|
|
"required": [
|
||
|
|
"UserId"
|
||
|
|
],
|
||
|
|
"members": {
|
||
|
|
"AuthenticationToken": {
|
||
|
|
"shape": "S2",
|
||
|
|
"location": "header",
|
||
|
|
"locationName": "Authentication"
|
||
|
|
},
|
||
|
|
"UserId": {
|
||
|
|
"location": "uri",
|
||
|
|
"locationName": "UserId"
|
||
|
|
},
|
||
|
|
"GivenName": {},
|
||
|
|
"Surname": {},
|
||
|
|
"Type": {},
|
||
|
|
"StorageRule": {
|
||
|
|
"shape": "Sj"
|
||
|
|
},
|
||
|
|
"TimeZoneId": {},
|
||
|
|
"Locale": {},
|
||
|
|
"GrantPoweruserPrivileges": {}
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"output": {
|
||
|
|
"type": "structure",
|
||
|
|
"members": {
|
||
|
|
"User": {
|
||
|
|
"shape": "S8"
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"shapes": {
|
||
|
|
"S2": {
|
||
|
|
"type": "string",
|
||
|
|
"sensitive": true
|
||
|
|
},
|
||
|
|
"S8": {
|
||
|
|
"type": "structure",
|
||
|
|
"members": {
|
||
|
|
"Id": {},
|
||
|
|
"Username": {},
|
||
|
|
"EmailAddress": {},
|
||
|
|
"GivenName": {},
|
||
|
|
"Surname": {},
|
||
|
|
"OrganizationId": {},
|
||
|
|
"RootFolderId": {},
|
||
|
|
"RecycleBinFolderId": {},
|
||
|
|
"Status": {},
|
||
|
|
"Type": {},
|
||
|
|
"CreatedTimestamp": {
|
||
|
|
"type": "timestamp"
|
||
|
|
},
|
||
|
|
"ModifiedTimestamp": {
|
||
|
|
"type": "timestamp"
|
||
|
|
},
|
||
|
|
"TimeZoneId": {},
|
||
|
|
"Locale": {},
|
||
|
|
"Storage": {
|
||
|
|
"type": "structure",
|
||
|
|
"members": {
|
||
|
|
"StorageUtilizedInBytes": {
|
||
|
|
"type": "long"
|
||
|
|
},
|
||
|
|
"StorageRule": {
|
||
|
|
"shape": "Sj"
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"Sj": {
|
||
|
|
"type": "structure",
|
||
|
|
"members": {
|
||
|
|
"StorageAllocatedInBytes": {
|
||
|
|
"type": "long"
|
||
|
|
},
|
||
|
|
"StorageType": {}
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"St": {
|
||
|
|
"type": "string",
|
||
|
|
"sensitive": true
|
||
|
|
},
|
||
|
|
"S10": {
|
||
|
|
"type": "string",
|
||
|
|
"sensitive": true
|
||
|
|
},
|
||
|
|
"S13": {
|
||
|
|
"type": "structure",
|
||
|
|
"required": [
|
||
|
|
"CommentId"
|
||
|
|
],
|
||
|
|
"members": {
|
||
|
|
"CommentId": {},
|
||
|
|
"ParentId": {},
|
||
|
|
"ThreadId": {},
|
||
|
|
"Text": {
|
||
|
|
"shape": "S10"
|
||
|
|
},
|
||
|
|
"Contributor": {
|
||
|
|
"shape": "S8"
|
||
|
|
},
|
||
|
|
"CreatedTimestamp": {
|
||
|
|
"type": "timestamp"
|
||
|
|
},
|
||
|
|
"Status": {},
|
||
|
|
"Visibility": {},
|
||
|
|
"RecipientId": {}
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"S16": {
|
||
|
|
"type": "map",
|
||
|
|
"key": {},
|
||
|
|
"value": {}
|
||
|
|
},
|
||
|
|
"S1d": {
|
||
|
|
"type": "structure",
|
||
|
|
"members": {
|
||
|
|
"Id": {},
|
||
|
|
"Name": {},
|
||
|
|
"CreatorId": {},
|
||
|
|
"ParentFolderId": {},
|
||
|
|
"CreatedTimestamp": {
|
||
|
|
"type": "timestamp"
|
||
|
|
},
|
||
|
|
"ModifiedTimestamp": {
|
||
|
|
"type": "timestamp"
|
||
|
|
},
|
||
|
|
"ResourceState": {},
|
||
|
|
"Signature": {},
|
||
|
|
"Labels": {
|
||
|
|
"shape": "S1g"
|
||
|
|
},
|
||
|
|
"Size": {
|
||
|
|
"type": "long"
|
||
|
|
},
|
||
|
|
"LatestVersionSize": {
|
||
|
|
"type": "long"
|
||
|
|
}
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"S1g": {
|
||
|
|
"type": "list",
|
||
|
|
"member": {}
|
||
|
|
},
|
||
|
|
"S1p": {
|
||
|
|
"type": "structure",
|
||
|
|
"members": {
|
||
|
|
"SubscriptionId": {},
|
||
|
|
"EndPoint": {},
|
||
|
|
"Protocol": {}
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"S2d": {
|
||
|
|
"type": "structure",
|
||
|
|
"members": {
|
||
|
|
"Id": {},
|
||
|
|
"Username": {},
|
||
|
|
"GivenName": {},
|
||
|
|
"Surname": {},
|
||
|
|
"EmailAddress": {}
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"S2g": {
|
||
|
|
"type": "list",
|
||
|
|
"member": {
|
||
|
|
"type": "structure",
|
||
|
|
"members": {
|
||
|
|
"Id": {},
|
||
|
|
"Name": {}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"S2j": {
|
||
|
|
"type": "structure",
|
||
|
|
"members": {
|
||
|
|
"Type": {},
|
||
|
|
"Name": {},
|
||
|
|
"OriginalName": {},
|
||
|
|
"Id": {},
|
||
|
|
"VersionId": {},
|
||
|
|
"Owner": {
|
||
|
|
"shape": "S2d"
|
||
|
|
},
|
||
|
|
"ParentId": {}
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"S2u": {
|
||
|
|
"type": "structure",
|
||
|
|
"members": {
|
||
|
|
"Id": {},
|
||
|
|
"Name": {},
|
||
|
|
"ContentType": {},
|
||
|
|
"Size": {
|
||
|
|
"type": "long"
|
||
|
|
},
|
||
|
|
"Signature": {},
|
||
|
|
"Status": {},
|
||
|
|
"CreatedTimestamp": {
|
||
|
|
"type": "timestamp"
|
||
|
|
},
|
||
|
|
"ModifiedTimestamp": {
|
||
|
|
"type": "timestamp"
|
||
|
|
},
|
||
|
|
"ContentCreatedTimestamp": {
|
||
|
|
"type": "timestamp"
|
||
|
|
},
|
||
|
|
"ContentModifiedTimestamp": {
|
||
|
|
"type": "timestamp"
|
||
|
|
},
|
||
|
|
"CreatorId": {},
|
||
|
|
"Thumbnail": {
|
||
|
|
"type": "map",
|
||
|
|
"key": {},
|
||
|
|
"value": {
|
||
|
|
"shape": "S2z"
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"Source": {
|
||
|
|
"type": "map",
|
||
|
|
"key": {},
|
||
|
|
"value": {
|
||
|
|
"shape": "S2z"
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"S2z": {
|
||
|
|
"type": "string",
|
||
|
|
"sensitive": true
|
||
|
|
},
|
||
|
|
"S37": {
|
||
|
|
"type": "list",
|
||
|
|
"member": {
|
||
|
|
"shape": "S1d"
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"S38": {
|
||
|
|
"type": "list",
|
||
|
|
"member": {
|
||
|
|
"shape": "S39"
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"S39": {
|
||
|
|
"type": "structure",
|
||
|
|
"members": {
|
||
|
|
"Id": {},
|
||
|
|
"CreatorId": {},
|
||
|
|
"ParentFolderId": {},
|
||
|
|
"CreatedTimestamp": {
|
||
|
|
"type": "timestamp"
|
||
|
|
},
|
||
|
|
"ModifiedTimestamp": {
|
||
|
|
"type": "timestamp"
|
||
|
|
},
|
||
|
|
"LatestVersionMetadata": {
|
||
|
|
"shape": "S2u"
|
||
|
|
},
|
||
|
|
"ResourceState": {},
|
||
|
|
"Labels": {
|
||
|
|
"shape": "S1g"
|
||
|
|
}
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"S3b": {
|
||
|
|
"type": "string",
|
||
|
|
"sensitive": true
|
||
|
|
},
|
||
|
|
"S42": {
|
||
|
|
"type": "structure",
|
||
|
|
"members": {
|
||
|
|
"Components": {
|
||
|
|
"type": "list",
|
||
|
|
"member": {
|
||
|
|
"type": "structure",
|
||
|
|
"members": {
|
||
|
|
"Id": {},
|
||
|
|
"Name": {}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|