{ "x-generator": "On Key REST API Docs Generator", "swagger": "2.0", "info": { "title": "On Key DM API Specification", "description": "Better and smarter enterprise asset management with one of the world's leading Enterprise Asset Management (EAM) systems.", "termsOfService": "https://www.onkey.com/", "contact": { "name": "On Key Support", "url": "https://www.onkey.com/", "email": "onkey.support@pragmaworld.net" }, "license": { "name": "On Key Licence", "url": "https://www.onkey.com/" }, "version": "1.0.0" }, "host": ":443", "basePath": "/api/tenants/{client}/{connection}", "schemes": [ "https" ], "consumes": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.entitypatch+json", "application/vnd.onkey.entitydelete+json", "application/vnd.onkey.entitycollection+json", "application/vnd.onkey.entitypatchcollection+json", "application/vnd.onkey.entitydeletecollection+json", "multipart/form-data" ], "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json", "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.entitycollection+json", "*/*" ], "paths": { "/Modules/DM/DocumentFolders/{id}": { "get": { "tags": [ "Document Folder" ], "summary": "Get a Document Folder resource.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| createdByUserId | DocumentFolder->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | DocumentFolder->CreatedByUser_Code | string | |\r\n| createdByUserFullName | DocumentFolder->CreatedByUser_FullName | string | |\r\n| createdOn | DocumentFolder->CreatedOn | string | date-time |\r\n| modifiedByUserId | DocumentFolder->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | DocumentFolder->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | DocumentFolder->ModifiedByUser_FullName | string | |\r\n| modifiedOn | DocumentFolder->ModifiedOn | string | date-time |\r\n| version | DocumentFolder->Version | integer | int32 |\r\n| id | DocumentFolder->Id | integer | int64 |\r\n| description | DocumentFolder->Description | string | |\r\n| notes | DocumentFolder->Notes | string | |\r\n| parentDocumentFolderId | DocumentFolder->ParentDocumentFolder_Id | integer | int64 |\r\n| parentDocumentFolderDescription | DocumentFolder->ParentDocumentFolder_Description | string | |\r\n| sequenceNumber | DocumentFolder->SequenceNumber | integer | int32 |\r\n", "operationId": "GetDocumentFolder", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Document Folder Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Document Folder", "schema": { "$ref": "#/definitions/GetDocumentFolderResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Document Folder" ], "summary": "Update an existing Document Folder resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | DocumentFolder->Version | integer | int32 |\r\n| description | DocumentFolder->Description | string | |\r\n| parentDocumentFolderId | DocumentFolder->ParentDocumentFolder_Id | integer | int64 |\r\n| sequenceNumber | DocumentFolder->SequenceNumber | integer | int32 |\r\n| notes | DocumentFolder->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 500 chars| |\r\n\r\n", "operationId": "UpdateDocumentFolder", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Document Folder Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateDocumentFolderResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Document Folder was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "Document Folder" ], "summary": "Delete an existing Document Folder resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | DocumentFolder->Version | integer | int32 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "DeleteDocumentFolder", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Document Folder Id", "format": "int64", "x-nullable": false }, { "name": "input", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteDocumentFolderResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Document Folder was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/DM/DocumentFolders": { "get": { "tags": [ "Document Folder" ], "summary": "Get a collection of Document Folder resources.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | DocumentFolder->Version | integer | int32 |\r\n| id | DocumentFolder->Id | integer | int64 |\r\n| description | DocumentFolder->Description | string | |\r\n| sequenceNumber | DocumentFolder->SequenceNumber | integer | int32 |\r\n| parentDocumentFolderId | DocumentFolder->ParentDocumentFolder_Id | integer | int64 |\r\n| parentDocumentFolderDescription | DocumentFolder->ParentDocumentFolder_Description | string | |\r\n", "operationId": "GetDocumentFolderCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Document Folder collection", "schema": { "$ref": "#/definitions/GetDocumentFolderCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Document Folder" ], "summary": "Create a new Document Folder resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| description | DocumentFolder->Description | string | |\r\n| parentDocumentFolderId | DocumentFolder->ParentDocumentFolder_Id | integer | int64 |\r\n| sequenceNumber | DocumentFolder->SequenceNumber | integer | int32 |\r\n| notes | DocumentFolder->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| description | Required | True | |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 500 chars| |\r\n\r\n", "operationId": "CreateDocumentFolder", "consumes": [ "application/vnd.onkey.entity+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "post", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/CreateDocumentFolderResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - resource was successfully created", "headers": { "OnKey-Resource-Id": { "type": "integer", "description": "Id of the resource created", "format": "Int64" }, "OnKey-Resource-Location": { "type": "string", "description": "Uri to fetch the created resource" } } }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/DM/DocumentFolders/Lookups/LookupDocumentFolderParentDocumentFolder": { "get": { "tags": [ "Document Folder" ], "summary": "Lookup the Document Folder for the Document Folder.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | DocumentFolder->Id | integer | int64 |\r\n| description | DocumentFolder->Description | string | |\r\n", "operationId": "LookupDocumentFolderParentDocumentFolder", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Document Folder collection", "schema": { "$ref": "#/definitions/DocumentFolderParentDocumentFolderLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/DM/DocumentFolders/Batch/{ids}": { "get": { "tags": [ "Document Folder" ], "summary": "Get a collection of Document Folder resources for the set of id's.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| createdByUserId | DocumentFolder->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | DocumentFolder->CreatedByUser_Code | string | |\r\n| createdByUserFullName | DocumentFolder->CreatedByUser_FullName | string | |\r\n| createdOn | DocumentFolder->CreatedOn | string | date-time |\r\n| modifiedByUserId | DocumentFolder->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | DocumentFolder->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | DocumentFolder->ModifiedByUser_FullName | string | |\r\n| modifiedOn | DocumentFolder->ModifiedOn | string | date-time |\r\n| version | DocumentFolder->Version | integer | int32 |\r\n| id | DocumentFolder->Id | integer | int64 |\r\n| description | DocumentFolder->Description | string | |\r\n| notes | DocumentFolder->Notes | string | |\r\n| parentDocumentFolderId | DocumentFolder->ParentDocumentFolder_Id | integer | int64 |\r\n| parentDocumentFolderDescription | DocumentFolder->ParentDocumentFolder_Description | string | |\r\n| sequenceNumber | DocumentFolder->SequenceNumber | integer | int32 |\r\n", "operationId": "BatchGetDocumentFolder", "produces": [ "application/vnd.onkey.entitycollection+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Document Folder id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Document Folder collection", "schema": { "$ref": "#/definitions/BatchGetDocumentFolderResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/DM/DocumentFolders/Batch": { "post": { "tags": [ "Document Folder" ], "summary": "Create a new collection of Document Folder resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| description | DocumentFolder->Description | string | |\r\n| parentDocumentFolderId | DocumentFolder->ParentDocumentFolder_Id | integer | int64 |\r\n| sequenceNumber | DocumentFolder->SequenceNumber | integer | int32 |\r\n| notes | DocumentFolder->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| description | Required | True | |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 500 chars| |\r\n\r\n", "operationId": "BatchCreateDocumentFolder", "consumes": [ "application/vnd.onkey.entitycollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "posts", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchCreateDocumentFolderRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Document Folder batch was successfully created" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Document Folder" ], "summary": "Update a collection of existing Document Folder resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | DocumentFolder->Id | integer | int64 |\r\n| version | DocumentFolder->Version | integer | int32 |\r\n| description | DocumentFolder->Description | string | |\r\n| parentDocumentFolderId | DocumentFolder->ParentDocumentFolder_Id | integer | int64 |\r\n| sequenceNumber | DocumentFolder->SequenceNumber | integer | int32 |\r\n| notes | DocumentFolder->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 500 chars| |\r\n\r\n", "operationId": "BatchUpdateDocumentFolder", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchUpdateDocumentFolderResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Document Folder batch was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "Document Folder" ], "summary": "Delete a collection of existing Document Folder resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | DocumentFolder->Id | integer | int64 |\r\n| version | DocumentFolder->Version | integer | int32 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "BatchDeleteDocumentFolder", "consumes": [ "application/vnd.onkey.entitydeletecollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "deletes", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchDeleteDocumentFolderResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Document Folder batch was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/DM/DocumentRecords/{id}/DownloadFile": { "get": { "tags": [ "Document Record" ], "summary": "Download the content for a Document Record resource.", "description": "", "operationId": "GetDocumentRecordFile", "produces": [ "*/*", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "format": "int64", "x-nullable": false }, { "type": "integer", "name": "cv", "in": "query", "description": "Return older version of file content", "format": "int32", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains file content", "schema": { "type": "string", "format": "binary" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/DM/DocumentRecords/{id}": { "get": { "tags": [ "Document Record" ], "summary": "Get a Document Record resource.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| code | DocumentRecord->Code | string | |\r\n| isActive | DocumentRecord->IsActive | boolean | |\r\n| createdByUserId | DocumentRecord->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | DocumentRecord->CreatedByUser_Code | string | |\r\n| createdByUserFullName | DocumentRecord->CreatedByUser_FullName | string | |\r\n| createdOn | DocumentRecord->CreatedOn | string | date-time |\r\n| modifiedByUserId | DocumentRecord->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | DocumentRecord->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | DocumentRecord->ModifiedByUser_FullName | string | |\r\n| modifiedOn | DocumentRecord->ModifiedOn | string | date-time |\r\n| version | DocumentRecord->Version | integer | int32 |\r\n| permissionTreeId | DocumentRecord->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | DocumentRecord->PermissionTree_Code | string | |\r\n| permissionTreeDescription | DocumentRecord->PermissionTree_Description | string | |\r\n| id | DocumentRecord->Id | integer | int64 |\r\n| approvedByUserId | DocumentRecord->ApprovedByUser_Id | integer | int64 |\r\n| approvedByUserCode | DocumentRecord->ApprovedByUser_Code | string | |\r\n| approvedByUserFullName | DocumentRecord->ApprovedByUser_FullName | string | |\r\n| approvedFrom | DocumentRecord->ApprovedFrom | string | date-time |\r\n| approvedTo | DocumentRecord->ApprovedTo | string | date-time |\r\n| description | DocumentRecord->Description | string | |\r\n| documentFolderId | DocumentRecord->DocumentFolder_Id | integer | int64 |\r\n| documentFolderDescription | DocumentRecord->DocumentFolder_Description | string | |\r\n| contentId | DocumentRecord->Content_Id | integer | int64 |\r\n| contentFileLocationId | DocumentRecord->Content_FileLocation_Id | integer | int64 |\r\n| contentFileLocationDescription | DocumentRecord->Content_FileLocation_Description | string | |\r\n| contentFileLocationFileLocationType | DocumentRecord->Content_FileLocation_FileLocationType | string (Allowed values: [FileSystem, Database]) | enum |\r\n| contentFileLocationOnKeyFileStoreId | DocumentRecord->Content_FileLocation_OnKeyFileStoreId | string | uuid |\r\n| contentSizeInBytes | DocumentRecord->Content_SizeInBytes | integer | int64 |\r\n| contentSizeInKb | DocumentRecord->Content_SizeInKb | number | decimal |\r\n| contentSizeInMb | DocumentRecord->Content_SizeInMb | number | decimal |\r\n| contentVersion | DocumentRecord->ContentVersion | integer | int32 |\r\n| fileFullName | DocumentRecord->FileFullName | string | |\r\n| fileName | DocumentRecord->FileName | string | |\r\n| fileTypeId | DocumentRecord->FileType_Id | integer | int64 |\r\n| fileTypeExtension | DocumentRecord->FileType_Extension | string | |\r\n| fileLocation | DocumentRecord->FileLocation | string | |\r\n| isApproved | DocumentRecord->IsApproved | boolean | |\r\n| notes | DocumentRecord->Notes | string | |\r\n| revisedBy | DocumentRecord->RevisedBy | string | |\r\n| revisionDate | DocumentRecord->RevisionDate | string | date-time |\r\n| revisionNumber | DocumentRecord->RevisionNumber | integer | int32 |\r\n", "operationId": "GetDocumentRecord", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Document Record Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Document Record", "schema": { "$ref": "#/definitions/GetDocumentRecordResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Document Record" ], "summary": "Update an existing Document Record resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | DocumentRecord->Version | integer | int32 |\r\n| code | DocumentRecord->Code | string | |\r\n| description | DocumentRecord->Description | string | |\r\n| revisionNumber | DocumentRecord->RevisionNumber | integer | int32 |\r\n| revisionDate | DocumentRecord->RevisionDate | string | date-time |\r\n| revisedBy | DocumentRecord->RevisedBy | string | |\r\n| isApproved | DocumentRecord->IsApproved | boolean | |\r\n| approvedFrom | DocumentRecord->ApprovedFrom | string | date-time |\r\n| approvedTo | DocumentRecord->ApprovedTo | string | date-time |\r\n| fileLocation | DocumentRecord->FileLocation | string | |\r\n| documentFolderId | DocumentRecord->DocumentFolder_Id | integer | int64 |\r\n| notes | DocumentRecord->Notes | string | |\r\n| fileName | DocumentRecord->FileName | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n| revisionNumber | Nullable | False | |\r\n| revisionDate | Nullable | False | |\r\n| revisedBy | Nullable | False | |\r\n| isApproved | Nullable | False | |\r\n| documentFolderId | Nullable | False | |\r\n| fileName | Nullable | False | |\r\n\r\n", "operationId": "UpdateDocumentRecord", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Document Record Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateDocumentRecordResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Document Record was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "Document Record" ], "summary": "Delete an existing Document Record resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | DocumentRecord->Version | integer | int32 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "DeleteDocumentRecord", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Document Record Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteDocumentRecordResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Document Record was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/DM/DocumentRecords": { "get": { "tags": [ "Document Record" ], "summary": "Get a collection of Document Record resources.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | DocumentRecord->Version | integer | int32 |\r\n| id | DocumentRecord->Id | integer | int64 |\r\n| code | DocumentRecord->Code | string | |\r\n| description | DocumentRecord->Description | string | |\r\n| revisionNumber | DocumentRecord->RevisionNumber | integer | int32 |\r\n| revisionDate | DocumentRecord->RevisionDate | string | date-time |\r\n| revisedBy | DocumentRecord->RevisedBy | string | |\r\n| isApproved | DocumentRecord->IsApproved | boolean | |\r\n| approvedFrom | DocumentRecord->ApprovedFrom | string | date-time |\r\n| approvedTo | DocumentRecord->ApprovedTo | string | date-time |\r\n| approvedByUserId | DocumentRecord->ApprovedByUser_Id | integer | int64 |\r\n| approvedByUserFullName | DocumentRecord->ApprovedByUser_FullName | string | |\r\n| fileLocation | DocumentRecord->FileLocation | string | |\r\n| fileFullName | DocumentRecord->FileFullName | string | |\r\n| contentSizeInMb | DocumentRecord->Content_SizeInMb | number | decimal |\r\n| fileTypeExtension | DocumentRecord->FileType_Extension | string | |\r\n| documentFolderId | DocumentRecord->DocumentFolder_Id | integer | int64 |\r\n| documentFolderDescription | DocumentRecord->DocumentFolder_Description | string | |\r\n| notes | DocumentRecord->Notes | string | |\r\n| createdOn | DocumentRecord->CreatedOn | string | date-time |\r\n| modifiedOn | DocumentRecord->ModifiedOn | string | date-time |\r\n", "operationId": "GetDocumentRecordCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Document Record collection", "schema": { "$ref": "#/definitions/GetDocumentRecordCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Document Record" ], "summary": "Create a new Document Record resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| permissionTreeId | DocumentRecord->PermissionTree_Id | integer | int64 |\r\n| code | DocumentRecord->Code | string | |\r\n| description | DocumentRecord->Description | string | |\r\n| revisionNumber | DocumentRecord->RevisionNumber | integer | int32 |\r\n| revisionDate | DocumentRecord->RevisionDate | string | date-time |\r\n| revisedBy | DocumentRecord->RevisedBy | string | |\r\n| isApproved | DocumentRecord->IsApproved | boolean | |\r\n| approvedFrom | DocumentRecord->ApprovedFrom | string | date-time |\r\n| approvedTo | DocumentRecord->ApprovedTo | string | date-time |\r\n| fileLocation | DocumentRecord->FileLocation | string | |\r\n| documentFolderId | DocumentRecord->DocumentFolder_Id | integer | int64 |\r\n| notes | DocumentRecord->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n| code | Required | True | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Required | True | |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n| revisionNumber | Required | True | |\r\n| revisionNumber | Nullable | False | |\r\n| revisionDate | Required | True | |\r\n| revisionDate | Nullable | False | |\r\n| revisedBy | Required | True | |\r\n| revisedBy | Nullable | False | |\r\n| isApproved | Nullable | False | |\r\n| documentFolderId | Required | True | |\r\n| documentFolderId | Nullable | False | |\r\n\r\n", "operationId": "CreateDocumentRecord", "consumes": [ "application/vnd.onkey.entity+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "post", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/CreateDocumentRecordResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - resource was successfully created", "headers": { "OnKey-Resource-Id": { "type": "integer", "description": "Id of the resource created", "format": "Int64" }, "OnKey-Resource-Location": { "type": "string", "description": "Uri to fetch the created resource" } } }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/DM/DocumentRecords/Lookups/LookupDocumentRecordChangePermissionTree": { "get": { "tags": [ "Document Record" ], "summary": "Lookup the permission set for changing the Document Record.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupDocumentRecordChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable collection", "schema": { "$ref": "#/definitions/DocumentRecordChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/DM/DocumentRecords/Lookups/LookupDocumentRecordDocumentFolder": { "get": { "tags": [ "Document Record" ], "summary": "Lookup the Document Folder for the Document Record.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | DocumentFolder->Id | integer | int64 |\r\n| description | DocumentFolder->Description | string | |\r\n", "operationId": "LookupDocumentRecordDocumentFolder", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Document Folder collection", "schema": { "$ref": "#/definitions/DocumentRecordDocumentFolderLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/DM/DocumentRecords/Lookups/LookupDocumentRecordInsertPermissionTree": { "get": { "tags": [ "Document Record" ], "summary": "Lookup the permission set for creating the Document Record.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupDocumentRecordInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable collection", "schema": { "$ref": "#/definitions/DocumentRecordInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/DM/DocumentRecords/Batch/{ids}": { "get": { "tags": [ "Document Record" ], "summary": "Get a collection of Document Record resources for the set of id's.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| code | DocumentRecord->Code | string | |\r\n| isActive | DocumentRecord->IsActive | boolean | |\r\n| createdByUserId | DocumentRecord->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | DocumentRecord->CreatedByUser_Code | string | |\r\n| createdByUserFullName | DocumentRecord->CreatedByUser_FullName | string | |\r\n| createdOn | DocumentRecord->CreatedOn | string | date-time |\r\n| modifiedByUserId | DocumentRecord->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | DocumentRecord->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | DocumentRecord->ModifiedByUser_FullName | string | |\r\n| modifiedOn | DocumentRecord->ModifiedOn | string | date-time |\r\n| version | DocumentRecord->Version | integer | int32 |\r\n| permissionTreeId | DocumentRecord->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | DocumentRecord->PermissionTree_Code | string | |\r\n| permissionTreeDescription | DocumentRecord->PermissionTree_Description | string | |\r\n| id | DocumentRecord->Id | integer | int64 |\r\n| approvedByUserId | DocumentRecord->ApprovedByUser_Id | integer | int64 |\r\n| approvedByUserCode | DocumentRecord->ApprovedByUser_Code | string | |\r\n| approvedByUserFullName | DocumentRecord->ApprovedByUser_FullName | string | |\r\n| approvedFrom | DocumentRecord->ApprovedFrom | string | date-time |\r\n| approvedTo | DocumentRecord->ApprovedTo | string | date-time |\r\n| description | DocumentRecord->Description | string | |\r\n| documentFolderId | DocumentRecord->DocumentFolder_Id | integer | int64 |\r\n| documentFolderDescription | DocumentRecord->DocumentFolder_Description | string | |\r\n| fileInfoId | DocumentRecord->FileInfoId | integer | int64 |\r\n| bytes | DocumentRecord->Bytes | array | array |\r\n| contentId | DocumentRecord->Content_Id | integer | int64 |\r\n| contentFileLocationId | DocumentRecord->Content_FileLocation_Id | integer | int64 |\r\n| contentFileLocationDescription | DocumentRecord->Content_FileLocation_Description | string | |\r\n| contentFileLocationFileLocationType | DocumentRecord->Content_FileLocation_FileLocationType | string (Allowed values: [FileSystem, Database]) | enum |\r\n| contentFileLocationOnKeyFileStoreId | DocumentRecord->Content_FileLocation_OnKeyFileStoreId | string | uuid |\r\n| contentSizeInBytes | DocumentRecord->Content_SizeInBytes | integer | int64 |\r\n| contentSizeInKb | DocumentRecord->Content_SizeInKb | number | decimal |\r\n| contentSizeInMb | DocumentRecord->Content_SizeInMb | number | decimal |\r\n| contentVersion | DocumentRecord->ContentVersion | integer | int32 |\r\n| fileFullName | DocumentRecord->FileFullName | string | |\r\n| fileName | DocumentRecord->FileName | string | |\r\n| fileTypeId | DocumentRecord->FileType_Id | integer | int64 |\r\n| fileTypeExtension | DocumentRecord->FileType_Extension | string | |\r\n| fileLocation | DocumentRecord->FileLocation | string | |\r\n| isApproved | DocumentRecord->IsApproved | boolean | |\r\n| notes | DocumentRecord->Notes | string | |\r\n| revisedBy | DocumentRecord->RevisedBy | string | |\r\n| revisionDate | DocumentRecord->RevisionDate | string | date-time |\r\n| revisionNumber | DocumentRecord->RevisionNumber | integer | int32 |\r\n", "operationId": "BatchGetDocumentRecord", "produces": [ "application/vnd.onkey.entitycollection+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Document Record id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Document Record collection", "schema": { "$ref": "#/definitions/BatchGetDocumentRecordResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/DM/DocumentRecords/{id}/FileContentHistory": { "get": { "tags": [ "Document Record" ], "summary": "Get a collection of Document Record File History resources for the Document Record File History.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | DocumentRecordFileHistory->Id | integer | int64 |\r\n| version | DocumentRecordFileHistory->Version | integer | int32 |\r\n| contentId | DocumentRecordFileHistory->Content_Id | integer | int64 |\r\n| contentFileLocationId | DocumentRecordFileHistory->Content_FileLocation_Id | integer | int64 |\r\n| contentFileLocationDescription | DocumentRecordFileHistory->Content_FileLocation_Description | string | |\r\n| contentFileLocationFileLocationType | DocumentRecordFileHistory->Content_FileLocation_FileLocationType | string (Allowed values: [FileSystem, Database]) | enum |\r\n| contentFileLocationOnKeyFileStoreId | DocumentRecordFileHistory->Content_FileLocation_OnKeyFileStoreId | string | uuid |\r\n| contentSizeInBytes | DocumentRecordFileHistory->Content_SizeInBytes | integer | int64 |\r\n| contentSizeInKb | DocumentRecordFileHistory->Content_SizeInKb | number | decimal |\r\n| contentSizeInMb | DocumentRecordFileHistory->Content_SizeInMb | number | decimal |\r\n| contentVersion | DocumentRecordFileHistory->ContentVersion | integer | int32 |\r\n| createdOn | DocumentRecordFileHistory->CreatedOn | string | date-time |\r\n| documentRecordId | DocumentRecordFileHistory->DocumentRecord_Id | integer | int64 |\r\n| documentRecordCode | DocumentRecordFileHistory->DocumentRecord_Code | string | |\r\n| documentRecordDescription | DocumentRecordFileHistory->DocumentRecord_Description | string | |\r\n", "operationId": "GetDocumentRecordFileHistory", "produces": [ "application/vnd.onkey.entitycollection+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Document Record collection", "schema": { "$ref": "#/definitions/GetDocumentRecordFileHistoryResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/DM/DocumentRecords/Batch": { "post": { "tags": [ "Document Record" ], "summary": "Create a new collection of Document Record resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| permissionTreeId | DocumentRecord->PermissionTree_Id | integer | int64 |\r\n| code | DocumentRecord->Code | string | |\r\n| description | DocumentRecord->Description | string | |\r\n| revisionNumber | DocumentRecord->RevisionNumber | integer | int32 |\r\n| revisionDate | DocumentRecord->RevisionDate | string | date-time |\r\n| revisedBy | DocumentRecord->RevisedBy | string | |\r\n| isApproved | DocumentRecord->IsApproved | boolean | |\r\n| approvedFrom | DocumentRecord->ApprovedFrom | string | date-time |\r\n| approvedTo | DocumentRecord->ApprovedTo | string | date-time |\r\n| fileLocation | DocumentRecord->FileLocation | string | |\r\n| documentFolderId | DocumentRecord->DocumentFolder_Id | integer | int64 |\r\n| notes | DocumentRecord->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n| code | Required | True | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Required | True | |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n| revisionNumber | Required | True | |\r\n| revisionNumber | Nullable | False | |\r\n| revisionDate | Required | True | |\r\n| revisionDate | Nullable | False | |\r\n| revisedBy | Required | True | |\r\n| revisedBy | Nullable | False | |\r\n| isApproved | Nullable | False | |\r\n| documentFolderId | Required | True | |\r\n| documentFolderId | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateDocumentRecord", "consumes": [ "application/vnd.onkey.entitycollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "posts", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchCreateDocumentRecordResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Document Record batch was successfully created" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Document Record" ], "summary": "Update a collection of existing Document Record resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | DocumentRecord->Id | integer | int64 |\r\n| version | DocumentRecord->Version | integer | int32 |\r\n| code | DocumentRecord->Code | string | |\r\n| description | DocumentRecord->Description | string | |\r\n| revisionNumber | DocumentRecord->RevisionNumber | integer | int32 |\r\n| revisionDate | DocumentRecord->RevisionDate | string | date-time |\r\n| revisedBy | DocumentRecord->RevisedBy | string | |\r\n| isApproved | DocumentRecord->IsApproved | boolean | |\r\n| approvedFrom | DocumentRecord->ApprovedFrom | string | date-time |\r\n| approvedTo | DocumentRecord->ApprovedTo | string | date-time |\r\n| fileLocation | DocumentRecord->FileLocation | string | |\r\n| documentFolderId | DocumentRecord->DocumentFolder_Id | integer | int64 |\r\n| notes | DocumentRecord->Notes | string | |\r\n| fileName | DocumentRecord->FileName | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n| revisionNumber | Nullable | False | |\r\n| revisionDate | Nullable | False | |\r\n| revisedBy | Nullable | False | |\r\n| isApproved | Nullable | False | |\r\n| documentFolderId | Nullable | False | |\r\n| fileName | Nullable | False | |\r\n\r\n", "operationId": "BatchUpdateDocumentRecord", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchUpdateDocumentRecordResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Document Record batch was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "Document Record" ], "summary": "Delete a collection of existing Document Record resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | DocumentRecord->Id | integer | int64 |\r\n| version | DocumentRecord->Version | integer | int32 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "BatchDeleteDocumentRecord", "consumes": [ "application/vnd.onkey.entitydeletecollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "deletes", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchDeleteDocumentRecordResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Document Record batch was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/DM/DocumentRecords/{id}/Active": { "patch": { "tags": [ "Document Record" ], "summary": "Change the IsActive status for an existing Document Record resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | DocumentRecord->Version | integer | int32 |\r\n| isActive | DocumentRecord->IsActive | boolean | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| isActive | Required | True | |\r\n| isActive | Nullable | False | |\r\n\r\n", "operationId": "ChangeDocumentRecordIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Document Record Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeDocumentRecordIsActiveResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/DM/DocumentRecords/{id}/PermissionTree": { "patch": { "tags": [ "Document Record" ], "summary": "Change the PermissionTree for an existing Document Record resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | DocumentRecord->Version | integer | int32 |\r\n| permissionTreeId | DocumentRecord->PermissionTree_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "ChangeDocumentRecordPermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Document Record Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeDocumentRecordPermissionTreeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/DM/DocumentRecords/{id}/RemoveFile": { "patch": { "tags": [ "Document Record" ], "summary": "Document Record", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | DocumentRecord->Version | integer | int32 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "RemoveDocumentRecordFile", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Document Record Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/RemoveDocumentRecordFileResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/DM/DocumentRecords/{id}/UploadFile": { "put": { "tags": [ "Document Record" ], "summary": "Document Record", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | DocumentRecord->Version | integer | int32 |\r\n| fileName | DocumentRecord->FileName | string | |\r\n| bytes | DocumentRecord->Bytes | array | array |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| fileName | Nullable | False | |\r\n\r\n", "operationId": "UploadDocumentRecordFile", "consumes": [ "multipart/form-data" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Document Record Id", "format": "int64", "x-nullable": false }, { "name": "entityFilePatch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UploadDocumentRecordFileResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/DM/DocumentRecords/Batch/Active": { "patch": { "tags": [ "Document Record" ], "summary": "Change the IsActive status for a collection of existing Document Record resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | DocumentRecord->Id | integer | int64 |\r\n| version | DocumentRecord->Version | integer | int32 |\r\n| isActive | DocumentRecord->IsActive | boolean | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| isActive | Required | True | |\r\n| isActive | Nullable | False | |\r\n\r\n", "operationId": "BatchChangeDocumentRecordIsActive", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangeDocumentRecordIsActiveResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/DM/DocumentRecords/Batch/PermissionTree": { "patch": { "tags": [ "Document Record" ], "summary": "Change the PermissionTree status for a collection of existing Document Record resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | DocumentRecord->Id | integer | int64 |\r\n| version | DocumentRecord->Version | integer | int32 |\r\n| permissionTreeId | DocumentRecord->PermissionTree_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "BatchChangeDocumentRecordPermissionTree", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangeDocumentRecordPermissionTreeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/DM/DocumentRecords/Attributes/{id}": { "get": { "tags": [ "Document Record Attribute" ], "summary": "Get a Document Record Attribute resource.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| documentRecordId | DocumentRecordAttribute->DocumentRecord_Id | integer | int64 |\r\n| documentRecordCode | DocumentRecordAttribute->DocumentRecord_Code | string | |\r\n| documentRecordDescription | DocumentRecordAttribute->DocumentRecord_Description | string | |\r\n| createdByUserId | DocumentRecordAttribute->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | DocumentRecordAttribute->CreatedByUser_Code | string | |\r\n| createdByUserFullName | DocumentRecordAttribute->CreatedByUser_FullName | string | |\r\n| createdOn | DocumentRecordAttribute->CreatedOn | string | date-time |\r\n| isActive | DocumentRecordAttribute->IsActive | boolean | |\r\n| modifiedByUserId | DocumentRecordAttribute->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | DocumentRecordAttribute->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | DocumentRecordAttribute->ModifiedByUser_FullName | string | |\r\n| modifiedOn | DocumentRecordAttribute->ModifiedOn | string | date-time |\r\n| permissionTreeId | DocumentRecordAttribute->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | DocumentRecordAttribute->PermissionTree_Code | string | |\r\n| permissionTreeDescription | DocumentRecordAttribute->PermissionTree_Description | string | |\r\n| version | DocumentRecordAttribute->Version | integer | int32 |\r\n| id | DocumentRecordAttribute->Id | integer | int64 |\r\n| attributeId | DocumentRecordAttribute->Attribute_Id | integer | int64 |\r\n| attributeCode | DocumentRecordAttribute->Attribute_Code | string | |\r\n| attributeDescription | DocumentRecordAttribute->Attribute_Description | string | |\r\n| attributeAllowAnyValue | DocumentRecordAttribute->Attribute_AllowAnyValue | boolean | |\r\n| attributeDataType | DocumentRecordAttribute->Attribute_DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| attributeDefaultValue | DocumentRecordAttribute->Attribute_DefaultValue | object | composite |\r\n| attributeDefaultAllowedValueId | DocumentRecordAttribute->Attribute_DefaultAllowedValue_Id | integer | int64 |\r\n| attributeDefaultAllowedValueDescription | DocumentRecordAttribute->Attribute_DefaultAllowedValue_Description | string | |\r\n| attributeDefaultAllowedValueValue | DocumentRecordAttribute->Attribute_DefaultAllowedValue_Value | object | composite |\r\n| notes | DocumentRecordAttribute->Notes | string | |\r\n| predefinedValueId | DocumentRecordAttribute->PredefinedValue_Id | integer | int64 |\r\n| predefinedValueDescription | DocumentRecordAttribute->PredefinedValue_Description | string | |\r\n| predefinedValueValue | DocumentRecordAttribute->PredefinedValue_Value | object | composite |\r\n| sequenceNumber | DocumentRecordAttribute->SequenceNumber | integer | int32 |\r\n| value | DocumentRecordAttribute->Value | object | composite |\r\n", "operationId": "GetDocumentRecordAttribute", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Document Record Attribute Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Document Record Attribute", "schema": { "$ref": "#/definitions/GetDocumentRecordAttributeResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Document Record Attribute" ], "summary": "Update an existing Document Record Attribute resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | DocumentRecordAttribute->Version | integer | int32 |\r\n| value | DocumentRecordAttribute->Value | object | composite |\r\n| predefinedValueId | DocumentRecordAttribute->PredefinedValue_Id | integer | int64 |\r\n| sequenceNumber | DocumentRecordAttribute->SequenceNumber | integer | int32 |\r\n| notes | DocumentRecordAttribute->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| value | Nullable | True | |\r\n| predefinedValueId | Nullable | True | |\r\n\r\n", "operationId": "UpdateDocumentRecordAttribute", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Document Record Attribute Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateDocumentRecordAttributeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Document Record Attribute was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "Document Record Attribute" ], "summary": "Delete an existing Document Record Attribute resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | DocumentRecordAttribute->Version | integer | int32 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "DeleteDocumentRecordAttribute", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Document Record Attribute Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteDocumentRecordAttributeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Document Record Attribute was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/DM/DocumentRecords/{documentRecordId}/Attributes": { "get": { "tags": [ "Document Record Attribute" ], "summary": "Get a collection of Document Record Attribute resources for the Document Record.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | DocumentRecordAttribute->Id | integer | int64 |\r\n| version | DocumentRecordAttribute->Version | integer | int32 |\r\n| sequenceNumber | DocumentRecordAttribute->SequenceNumber | integer | int32 |\r\n| attributeId | DocumentRecordAttribute->Attribute_Id | integer | int64 |\r\n| attributeCode | DocumentRecordAttribute->Attribute_Code | string | |\r\n| attributeDescription | DocumentRecordAttribute->Attribute_Description | string | |\r\n| attributeDataType | DocumentRecordAttribute->Attribute_DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| predefinedValueId | DocumentRecordAttribute->PredefinedValue_Id | integer | int64 |\r\n| predefinedValueDescription | DocumentRecordAttribute->PredefinedValue_Description | string | |\r\n| predefinedValueValue | DocumentRecordAttribute->PredefinedValue_Value | object | composite |\r\n| value | DocumentRecordAttribute->Value | object | composite |\r\n| notes | DocumentRecordAttribute->Notes | string | |\r\n| createdOn | DocumentRecordAttribute->CreatedOn | string | date-time |\r\n| modifiedOn | DocumentRecordAttribute->ModifiedOn | string | date-time |\r\n", "operationId": "GetDocumentRecordAttributeCollectionForDocumentRecord", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "documentRecordId", "in": "path", "required": true, "description": "Document Record Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Document Record Attribute collection", "schema": { "$ref": "#/definitions/GetDocumentRecordAttributeCollectionForDocumentRecordResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/DM/DocumentRecords/Attributes": { "get": { "tags": [ "Document Record Attribute" ], "summary": "Get a collection of Document Record Attribute resources.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | DocumentRecordAttribute->Id | integer | int64 |\r\n| version | DocumentRecordAttribute->Version | integer | int32 |\r\n| sequenceNumber | DocumentRecordAttribute->SequenceNumber | integer | int32 |\r\n| documentRecordCode | DocumentRecordAttribute->DocumentRecord_Code | string | |\r\n| documentRecordDescription | DocumentRecordAttribute->DocumentRecord_Description | string | |\r\n| attributeId | DocumentRecordAttribute->Attribute_Id | integer | int64 |\r\n| attributeCode | DocumentRecordAttribute->Attribute_Code | string | |\r\n| attributeDescription | DocumentRecordAttribute->Attribute_Description | string | |\r\n| attributeDataType | DocumentRecordAttribute->Attribute_DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| predefinedValueId | DocumentRecordAttribute->PredefinedValue_Id | integer | int64 |\r\n| predefinedValueDescription | DocumentRecordAttribute->PredefinedValue_Description | string | |\r\n| predefinedValueValue | DocumentRecordAttribute->PredefinedValue_Value | object | composite |\r\n| value | DocumentRecordAttribute->Value | object | composite |\r\n| notes | DocumentRecordAttribute->Notes | string | |\r\n| createdOn | DocumentRecordAttribute->CreatedOn | string | date-time |\r\n| modifiedOn | DocumentRecordAttribute->ModifiedOn | string | date-time |\r\n", "operationId": "GetDocumentRecordAttributeCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Document Record Attribute collection", "schema": { "$ref": "#/definitions/GetDocumentRecordAttributeCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Document Record Attribute" ], "summary": "Create a new Document Record Attribute resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| documentRecordId | DocumentRecordAttribute->DocumentRecord_Id | integer | int64 |\r\n| attributeId | DocumentRecordAttribute->Attribute_Id | integer | int64 |\r\n| value | DocumentRecordAttribute->Value | object | composite |\r\n| predefinedValueId | DocumentRecordAttribute->PredefinedValue_Id | integer | int64 |\r\n| permissionTreeId | DocumentRecordAttribute->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | DocumentRecordAttribute->SequenceNumber | integer | int32 |\r\n| notes | DocumentRecordAttribute->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| documentRecordId | Required | True | |\r\n| documentRecordId | Nullable | False | |\r\n| attributeId | Required | True | |\r\n| attributeId | Nullable | False | |\r\n| value | Nullable | True | |\r\n| predefinedValueId | Nullable | True | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "CreateDocumentRecordAttribute", "consumes": [ "application/vnd.onkey.entity+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "post", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/CreateDocumentRecordAttributeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - resource was successfully created", "headers": { "OnKey-Resource-Id": { "type": "integer", "description": "Id of the resource created", "format": "Int64" }, "OnKey-Resource-Location": { "type": "string", "description": "Uri to fetch the created resource" } } }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/DM/DocumentRecords/Attributes/Lookups/LookupDocumentRecordAttributeAllowedValue": { "get": { "tags": [ "Document Record Attribute" ], "summary": "Lookup the Attribute Allowed Value for the Document Record Attribute.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | AttributeAllowedValue->Id | integer | int64 |\r\n| description | AttributeAllowedValue->Description | string | |\r\n| value | AttributeAllowedValue->Value | object | composite |\r\n", "operationId": "LookupDocumentRecordAttributeAllowedValue", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Attribute Allowed Value collection", "schema": { "$ref": "#/definitions/DocumentRecordAttributeAttributeAllowedValueLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/DM/DocumentRecords/Attributes/Lookups/LookupDocumentRecordAttribute": { "get": { "tags": [ "Document Record Attribute" ], "summary": "Lookup the Attribute for the Document Record Attribute.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | Attribute->Id | integer | int64 |\r\n| code | Attribute->Code | string | |\r\n| description | Attribute->Description | string | |\r\n| allowAnyValue | Attribute->AllowAnyValue | boolean | |\r\n| dataType | Attribute->DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| defaultValue | Attribute->DefaultValue | object | composite |\r\n| defaultAllowedValueId | Attribute->DefaultAllowedValue_Id | integer | int64 |\r\n| defaultAllowedValueValue | Attribute->DefaultAllowedValue_Value | object | composite |\r\n| defaultAllowedValueDescription | Attribute->DefaultAllowedValue_Description | string | |\r\n| explanation | Attribute->Explanation | string | |\r\n", "operationId": "LookupDocumentRecordAttribute", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Attribute collection", "schema": { "$ref": "#/definitions/DocumentRecordAttributeAttributeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/DM/DocumentRecords/Attributes/Lookups/LookupDocumentRecordAttributeDocumentRecord": { "get": { "tags": [ "Document Record Attribute" ], "summary": "Lookup the Document Record Attribute for the Document Record Attribute.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | DocumentRecord->Id | integer | int64 |\r\n| code | DocumentRecord->Code | string | |\r\n| description | DocumentRecord->Description | string | |\r\n", "operationId": "LookupDocumentRecordAttributeDocumentRecord", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Document Record collection", "schema": { "$ref": "#/definitions/DocumentRecordAttributeDocumentRecordLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/DM/DocumentRecords/Attributes/Lookups/LookupDocumentRecordAttributeInsertPermissionTree": { "get": { "tags": [ "Document Record Attribute" ], "summary": "Lookup the permission set for creating the Document Record Attribute.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupDocumentRecordAttributeInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable collection", "schema": { "$ref": "#/definitions/DocumentRecordAttributeInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/DM/DocumentRecords/Attributes/Batch/{ids}": { "get": { "tags": [ "Document Record Attribute" ], "summary": "Get a collection of Document Record Attribute resources for the set of id's.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| documentRecordId | DocumentRecordAttribute->DocumentRecord_Id | integer | int64 |\r\n| documentRecordCode | DocumentRecordAttribute->DocumentRecord_Code | string | |\r\n| documentRecordDescription | DocumentRecordAttribute->DocumentRecord_Description | string | |\r\n| createdByUserId | DocumentRecordAttribute->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | DocumentRecordAttribute->CreatedByUser_Code | string | |\r\n| createdByUserFullName | DocumentRecordAttribute->CreatedByUser_FullName | string | |\r\n| createdOn | DocumentRecordAttribute->CreatedOn | string | date-time |\r\n| isActive | DocumentRecordAttribute->IsActive | boolean | |\r\n| modifiedByUserId | DocumentRecordAttribute->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | DocumentRecordAttribute->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | DocumentRecordAttribute->ModifiedByUser_FullName | string | |\r\n| modifiedOn | DocumentRecordAttribute->ModifiedOn | string | date-time |\r\n| permissionTreeId | DocumentRecordAttribute->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | DocumentRecordAttribute->PermissionTree_Code | string | |\r\n| permissionTreeDescription | DocumentRecordAttribute->PermissionTree_Description | string | |\r\n| version | DocumentRecordAttribute->Version | integer | int32 |\r\n| id | DocumentRecordAttribute->Id | integer | int64 |\r\n| attributeId | DocumentRecordAttribute->Attribute_Id | integer | int64 |\r\n| attributeCode | DocumentRecordAttribute->Attribute_Code | string | |\r\n| attributeDescription | DocumentRecordAttribute->Attribute_Description | string | |\r\n| attributeAllowAnyValue | DocumentRecordAttribute->Attribute_AllowAnyValue | boolean | |\r\n| attributeDataType | DocumentRecordAttribute->Attribute_DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| attributeDefaultValue | DocumentRecordAttribute->Attribute_DefaultValue | object | composite |\r\n| attributeDefaultAllowedValueId | DocumentRecordAttribute->Attribute_DefaultAllowedValue_Id | integer | int64 |\r\n| attributeDefaultAllowedValueDescription | DocumentRecordAttribute->Attribute_DefaultAllowedValue_Description | string | |\r\n| attributeDefaultAllowedValueValue | DocumentRecordAttribute->Attribute_DefaultAllowedValue_Value | object | composite |\r\n| notes | DocumentRecordAttribute->Notes | string | |\r\n| predefinedValueId | DocumentRecordAttribute->PredefinedValue_Id | integer | int64 |\r\n| predefinedValueDescription | DocumentRecordAttribute->PredefinedValue_Description | string | |\r\n| predefinedValueValue | DocumentRecordAttribute->PredefinedValue_Value | object | composite |\r\n| sequenceNumber | DocumentRecordAttribute->SequenceNumber | integer | int32 |\r\n| value | DocumentRecordAttribute->Value | object | composite |\r\n", "operationId": "BatchGetDocumentRecordAttribute", "produces": [ "application/vnd.onkey.entitycollection+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Document Record Attribute id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Document Record Attribute collection", "schema": { "$ref": "#/definitions/BatchGetDocumentRecordAttributeResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/DM/DocumentRecords/Attributes/Batch": { "post": { "tags": [ "Document Record Attribute" ], "summary": "Create a new collection of Document Record Attribute resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| documentRecordId | DocumentRecordAttribute->DocumentRecord_Id | integer | int64 |\r\n| attributeId | DocumentRecordAttribute->Attribute_Id | integer | int64 |\r\n| value | DocumentRecordAttribute->Value | object | composite |\r\n| predefinedValueId | DocumentRecordAttribute->PredefinedValue_Id | integer | int64 |\r\n| permissionTreeId | DocumentRecordAttribute->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | DocumentRecordAttribute->SequenceNumber | integer | int32 |\r\n| notes | DocumentRecordAttribute->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| documentRecordId | Required | True | |\r\n| documentRecordId | Nullable | False | |\r\n| attributeId | Required | True | |\r\n| attributeId | Nullable | False | |\r\n| value | Nullable | True | |\r\n| predefinedValueId | Nullable | True | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateDocumentRecordAttribute", "consumes": [ "application/vnd.onkey.entitycollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "posts", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchCreateDocumentRecordAttributeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Document Record Attribute batch was successfully created" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Document Record Attribute" ], "summary": "Update a collection of existing Document Record Attribute resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | DocumentRecordAttribute->Id | integer | int64 |\r\n| version | DocumentRecordAttribute->Version | integer | int32 |\r\n| value | DocumentRecordAttribute->Value | object | composite |\r\n| predefinedValueId | DocumentRecordAttribute->PredefinedValue_Id | integer | int64 |\r\n| sequenceNumber | DocumentRecordAttribute->SequenceNumber | integer | int32 |\r\n| notes | DocumentRecordAttribute->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| value | Nullable | True | |\r\n| predefinedValueId | Nullable | True | |\r\n\r\n", "operationId": "BatchUpdateDocumentRecordAttribute", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchUpdateDocumentRecordAttributeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Document Record Attribute batch was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "Document Record Attribute" ], "summary": "Delete a collection of existing Document Record Attribute resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | DocumentRecordAttribute->Id | integer | int64 |\r\n| version | DocumentRecordAttribute->Version | integer | int32 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "BatchDeleteDocumentRecordAttribute", "consumes": [ "application/vnd.onkey.entitydeletecollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "deletes", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchDeleteDocumentRecordAttributeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Document Record Attribute batch was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/DM/DocumentRecords/Attributes/{id}/Active": { "patch": { "tags": [ "Document Record Attribute" ], "summary": "Change the IsActive status for an existing Document Record Attribute resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | DocumentRecordAttribute->Version | integer | int32 |\r\n| isActive | DocumentRecordAttribute->IsActive | boolean | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| isActive | Required | True | |\r\n| isActive | Nullable | False | |\r\n\r\n", "operationId": "ChangeDocumentRecordAttributeIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Document Record Attribute Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeDocumentRecordAttributeIsActiveResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/DM/DocumentRecords/Attributes/Batch/Active": { "patch": { "tags": [ "Document Record Attribute" ], "summary": "Change the IsActive status for a collection of existing Document Record Attribute resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | DocumentRecordAttribute->Id | integer | int64 |\r\n| version | DocumentRecordAttribute->Version | integer | int32 |\r\n| isActive | DocumentRecordAttribute->IsActive | boolean | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| isActive | Required | True | |\r\n| isActive | Nullable | False | |\r\n\r\n", "operationId": "BatchChangeDocumentRecordAttributeIsActive", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangeDocumentRecordAttributeIsActiveResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/DM/FileAttachmentCategories/{id}": { "get": { "tags": [ "File Attachment Category" ], "summary": "Get a File Attachment Category resource.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| code | FileAttachmentCategory->Code | string | |\r\n| isActive | FileAttachmentCategory->IsActive | boolean | |\r\n| createdByUserId | FileAttachmentCategory->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | FileAttachmentCategory->CreatedByUser_Code | string | |\r\n| createdByUserFullName | FileAttachmentCategory->CreatedByUser_FullName | string | |\r\n| createdOn | FileAttachmentCategory->CreatedOn | string | date-time |\r\n| modifiedByUserId | FileAttachmentCategory->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | FileAttachmentCategory->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | FileAttachmentCategory->ModifiedByUser_FullName | string | |\r\n| modifiedOn | FileAttachmentCategory->ModifiedOn | string | date-time |\r\n| version | FileAttachmentCategory->Version | integer | int32 |\r\n| permissionTreeId | FileAttachmentCategory->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | FileAttachmentCategory->PermissionTree_Code | string | |\r\n| permissionTreeDescription | FileAttachmentCategory->PermissionTree_Description | string | |\r\n| id | FileAttachmentCategory->Id | integer | int64 |\r\n| autoIsRestricted | FileAttachmentCategory->AutoIsRestricted | boolean | |\r\n| description | FileAttachmentCategory->Description | string | |\r\n| notes | FileAttachmentCategory->Notes | string | |\r\n", "operationId": "GetFileAttachmentCategory", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "File Attachment Category Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains File Attachment Category", "schema": { "$ref": "#/definitions/GetFileAttachmentCategoryResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "File Attachment Category" ], "summary": "Update an existing File Attachment Category resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | FileAttachmentCategory->Version | integer | int32 |\r\n| code | FileAttachmentCategory->Code | string | |\r\n| description | FileAttachmentCategory->Description | string | |\r\n| notes | FileAttachmentCategory->Notes | string | |\r\n| autoIsRestricted | FileAttachmentCategory->AutoIsRestricted | boolean | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 250 chars| |\r\n\r\n", "operationId": "UpdateFileAttachmentCategory", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "File Attachment Category Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateFileAttachmentCategoryResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - File Attachment Category was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "File Attachment Category" ], "summary": "Delete an existing File Attachment Category resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | FileAttachmentCategory->Version | integer | int32 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "DeleteFileAttachmentCategory", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "File Attachment Category Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteFileAttachmentCategoryResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - File Attachment Category was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/DM/FileAttachmentCategories": { "get": { "tags": [ "File Attachment Category" ], "summary": "Get a collection of File Attachment Category resources.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | FileAttachmentCategory->Id | integer | int64 |\r\n| code | FileAttachmentCategory->Code | string | |\r\n| description | FileAttachmentCategory->Description | string | |\r\n| autoIsRestricted | FileAttachmentCategory->AutoIsRestricted | boolean | |\r\n| createdOn | FileAttachmentCategory->CreatedOn | string | date-time |\r\n| modifiedOn | FileAttachmentCategory->ModifiedOn | string | date-time |\r\n| version | FileAttachmentCategory->Version | integer | int32 |\r\n", "operationId": "GetFileAttachmentCategoryCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable File Attachment Category collection", "schema": { "$ref": "#/definitions/GetFileAttachmentCategoryCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "File Attachment Category" ], "summary": "Create a new File Attachment Category resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| permissionTreeId | FileAttachmentCategory->PermissionTree_Id | integer | int64 |\r\n| code | FileAttachmentCategory->Code | string | |\r\n| description | FileAttachmentCategory->Description | string | |\r\n| notes | FileAttachmentCategory->Notes | string | |\r\n| autoIsRestricted | FileAttachmentCategory->AutoIsRestricted | boolean | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n| code | Required | True | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Required | True | |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 250 chars| |\r\n\r\n", "operationId": "CreateFileAttachmentCategory", "consumes": [ "application/vnd.onkey.entity+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "post", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/CreateFileAttachmentCategoryResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - resource was successfully created", "headers": { "OnKey-Resource-Id": { "type": "integer", "description": "Id of the resource created", "format": "Int64" }, "OnKey-Resource-Location": { "type": "string", "description": "Uri to fetch the created resource" } } }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/DM/FileAttachmentCategories/Lookups/LookupFileAttachmentCategoryChangePermissionTree": { "get": { "tags": [ "File Attachment Category" ], "summary": "Lookup the permission set for changing the File Attachment Category.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupFileAttachmentCategoryChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable collection", "schema": { "$ref": "#/definitions/FileAttachmentCategoryChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/DM/FileAttachmentCategories/Lookups/LookupFileAttachmentCategoryInsertPermissionTree": { "get": { "tags": [ "File Attachment Category" ], "summary": "Lookup the permission set for creating the File Attachment Category.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupFileAttachmentCategoryInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable collection", "schema": { "$ref": "#/definitions/FileAttachmentCategoryInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/DM/FileAttachmentCategories/Lookups/LookupFileAttachmentCategory": { "get": { "tags": [ "File Attachment Category" ], "summary": "Lookup the FileAttachmentCategory", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | FileAttachmentCategory->Id | integer | int64 |\r\n| code | FileAttachmentCategory->Code | string | |\r\n| description | FileAttachmentCategory->Description | string | |\r\n| autoIsRestricted | FileAttachmentCategory->AutoIsRestricted | boolean | |\r\n", "operationId": "LookupFileAttachmentCategory", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable File Attachment Category collection", "schema": { "$ref": "#/definitions/FileAttachmentCategoryLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/DM/FileAttachmentCategories/Batch/{ids}": { "get": { "tags": [ "File Attachment Category" ], "summary": "Get a collection of File Attachment Category resources for the set of id's.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| code | FileAttachmentCategory->Code | string | |\r\n| isActive | FileAttachmentCategory->IsActive | boolean | |\r\n| createdByUserId | FileAttachmentCategory->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | FileAttachmentCategory->CreatedByUser_Code | string | |\r\n| createdByUserFullName | FileAttachmentCategory->CreatedByUser_FullName | string | |\r\n| createdOn | FileAttachmentCategory->CreatedOn | string | date-time |\r\n| modifiedByUserId | FileAttachmentCategory->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | FileAttachmentCategory->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | FileAttachmentCategory->ModifiedByUser_FullName | string | |\r\n| modifiedOn | FileAttachmentCategory->ModifiedOn | string | date-time |\r\n| version | FileAttachmentCategory->Version | integer | int32 |\r\n| permissionTreeId | FileAttachmentCategory->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | FileAttachmentCategory->PermissionTree_Code | string | |\r\n| permissionTreeDescription | FileAttachmentCategory->PermissionTree_Description | string | |\r\n| id | FileAttachmentCategory->Id | integer | int64 |\r\n| autoIsRestricted | FileAttachmentCategory->AutoIsRestricted | boolean | |\r\n| description | FileAttachmentCategory->Description | string | |\r\n| notes | FileAttachmentCategory->Notes | string | |\r\n", "operationId": "BatchGetFileAttachmentCategory", "produces": [ "application/vnd.onkey.entitycollection+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of File Attachment Category id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains File Attachment Category collection", "schema": { "$ref": "#/definitions/BatchGetFileAttachmentCategoryResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/DM/FileAttachmentCategories/Batch": { "post": { "tags": [ "File Attachment Category" ], "summary": "Create a new collection of File Attachment Category resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| permissionTreeId | FileAttachmentCategory->PermissionTree_Id | integer | int64 |\r\n| code | FileAttachmentCategory->Code | string | |\r\n| description | FileAttachmentCategory->Description | string | |\r\n| notes | FileAttachmentCategory->Notes | string | |\r\n| autoIsRestricted | FileAttachmentCategory->AutoIsRestricted | boolean | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n| code | Required | True | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Required | True | |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 250 chars| |\r\n\r\n", "operationId": "BatchCreateFileAttachmentCategory", "consumes": [ "application/vnd.onkey.entitycollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "posts", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchCreateFileAttachmentCategoryResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - File Attachment Category batch was successfully created" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "File Attachment Category" ], "summary": "Update a collection of existing File Attachment Category resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | FileAttachmentCategory->Id | integer | int64 |\r\n| version | FileAttachmentCategory->Version | integer | int32 |\r\n| code | FileAttachmentCategory->Code | string | |\r\n| description | FileAttachmentCategory->Description | string | |\r\n| notes | FileAttachmentCategory->Notes | string | |\r\n| autoIsRestricted | FileAttachmentCategory->AutoIsRestricted | boolean | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 250 chars| |\r\n\r\n", "operationId": "BatchUpdateFileAttachmentCategory", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchUpdateFileAttachmentCategoryResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - File Attachment Category batch was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "File Attachment Category" ], "summary": "Delete a collection of existing File Attachment Category resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | FileAttachmentCategory->Id | integer | int64 |\r\n| version | FileAttachmentCategory->Version | integer | int32 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "BatchDeleteFileAttachmentCategory", "consumes": [ "application/vnd.onkey.entitydeletecollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "deletes", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchDeleteFileAttachmentCategoryResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - File Attachment Category batch was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/DM/FileAttachmentCategories/{id}/Active": { "patch": { "tags": [ "File Attachment Category" ], "summary": "Change the IsActive status for an existing File Attachment Category resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | FileAttachmentCategory->Version | integer | int32 |\r\n| isActive | FileAttachmentCategory->IsActive | boolean | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| isActive | Required | True | |\r\n| isActive | Nullable | False | |\r\n\r\n", "operationId": "ChangeFileAttachmentCategoryIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "File Attachment Category Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeFileAttachmentCategoryIsActiveResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/DM/FileAttachmentCategories/{id}/PermissionTree": { "patch": { "tags": [ "File Attachment Category" ], "summary": "Change the PermissionTree for an existing File Attachment Category resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | FileAttachmentCategory->Version | integer | int32 |\r\n| permissionTreeId | FileAttachmentCategory->PermissionTree_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "ChangeFileAttachmentCategoryPermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "File Attachment Category Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeFileAttachmentCategoryPermissionTreeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/DM/FileAttachmentCategories/Batch/Active": { "patch": { "tags": [ "File Attachment Category" ], "summary": "Change the IsActive status for a collection of existing File Attachment Category resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | FileAttachmentCategory->Id | integer | int64 |\r\n| version | FileAttachmentCategory->Version | integer | int32 |\r\n| isActive | FileAttachmentCategory->IsActive | boolean | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| isActive | Required | True | |\r\n| isActive | Nullable | False | |\r\n\r\n", "operationId": "BatchChangeFileAttachmentCategoryIsActive", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangeFileAttachmentCategoryIsActiveResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/DM/FileAttachmentCategories/Batch/PermissionTree": { "patch": { "tags": [ "File Attachment Category" ], "summary": "Change the PermissionTree status for a collection of existing File Attachment Category resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | FileAttachmentCategory->Id | integer | int64 |\r\n| version | FileAttachmentCategory->Version | integer | int32 |\r\n| permissionTreeId | FileAttachmentCategory->PermissionTree_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "BatchChangeFileAttachmentCategoryPermissionTree", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangeFileAttachmentCategoryPermissionTreeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } } }, "definitions": { "OperationExecutionMode": { "type": "string", "description": "", "x-enumNames": [ "AllOrNone", "PerRecord" ], "enum": [ "AllOrNone", "PerRecord" ] }, "SeverityType": { "type": "string", "description": "", "x-nullable": false, "x-enumNames": [ "Error", "Warning", "Information" ], "enum": [ "error", "warning", "information" ] }, "NotificationItemSchema": { "title": "NotificationItemSchema", "type": "object", "properties": { "code": { "title": "code", "type": "string", "description": "Unique code for message", "x-nullable": false }, "message": { "title": "message", "type": "string", "x-nullable": false }, "objectId": { "title": "objectId", "type": "string", "description": "Optional id of record to which the message applies", "x-nullable": true }, "objectType": { "title": "objectType", "type": "string", "format": "enum", "x-nullable": true, "x-formatSpecifier": "EntityType" }, "properties": { "title": "properties", "type": "array", "description": "Collection of properties referenced by the message using property path syntax", "x-nullable": true, "example": [ "Asset->Code" ], "items": { "type": "string" } }, "severity": { "$ref": "#/definitions/SeverityType" }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Optional provided unique external record identifier to echo back with message", "x-nullable": true } } }, "NotificationSchema": { "title": "NotificationSchema", "type": "object", "properties": { "messages": { "title": "messages", "type": "array", "description": "Collection of messages", "x-nullable": false, "items": { "$ref": "#/definitions/NotificationItemSchema" } } } }, "EntityPermissionViolationSchema": { "type": "object", "required": [ "permissionId", "permissionTreeId", "propertyPaths" ], "properties": { "permissionId": { "type": "integer", "format": "int64" }, "permissionTreeId": { "type": "integer", "format": "int64" }, "propertyPaths": { "type": "array", "items": { "type": "string" } } } }, "EntityPhraseTranslationSchema": { "type": "object", "required": [ "phrase", "translation", "propertyPaths" ], "properties": { "phrase": { "type": "string" }, "translation": { "type": "string" }, "propertyPaths": { "type": "array", "items": { "type": "string" } } } }, "Link": { "type": "object", "required": [ "href", "method" ], "properties": { "doc": { "type": "string", "description": "Documentation endpoint that describes the link" }, "href": { "type": "string", "description": "Endpoint to invoke link", "minLength": 1 }, "mapping": { "type": "array", "items": { "$ref": "#/definitions/LinkMapping" } }, "method": { "type": "string", "description": "HTTP method used for link", "minLength": 1 }, "module": { "type": "string", "description": "Module used by link" }, "rel": { "type": "string" }, "resource": { "type": "string", "description": "Resource used by link" }, "resourceAction": { "type": "string", "description": "Resource Action used by link" }, "title": { "type": "string", "description": "Title" }, "type": { "description": "Type of link", "$ref": "#/definitions/ResourceLinkType" } } }, "LinkMapping": { "type": "object", "required": [ "source" ], "properties": { "source": { "type": "string" }, "target": { "type": "string" } } }, "ResourceLinkType": { "type": "string", "description": "", "x-enumNames": [ "Association", "PrimaryAction", "CustomAction", "Collection", "Detail", "Lookup", "Documentation", "Navigation", "Specification" ], "enum": [ "association", "primaryAction", "customAction", "collection", "detail", "lookup", "documentation", "navigation", "specification" ] }, "GetDocumentFolderResourceActionResponse": { "title": "GetDocumentFolderResourceActionResponse", "type": "object", "required": [ "properties" ], "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "format": "int64", "x-nullable": false, "example": 13243893 }, "version": { "title": "version", "type": "integer", "format": "int32", "x-nullable": false, "example": 1 }, "properties": { "title": "GetDocumentFolderResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "DocumentFolder->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "DocumentFolder->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "DocumentFolder->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "DocumentFolder->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "DocumentFolder->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "DocumentFolder->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "DocumentFolder->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "DocumentFolder->ModifiedOn" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "DocumentFolder->Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "DocumentFolder->Notes" }, "parentDocumentFolderId": { "title": "parentDocumentFolderId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "DocumentFolder->ParentDocumentFolder_Id" }, "parentDocumentFolderDescription": { "title": "parentDocumentFolderDescription", "type": "string", "x-nullable": true, "x-propertyPath": "DocumentFolder->ParentDocumentFolder_Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "DocumentFolder->SequenceNumber" } } }, "permissionViolations": { "title": "permissionViolations", "type": "array", "description": "Permissions violations for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/EntityPermissionViolationSchema" } }, "translations": { "title": "translations", "type": "array", "description": "Custom translations for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/EntityPhraseTranslationSchema" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } }, "self": { "$ref": "#/definitions/Link" } } }, "GetDocumentFolderCollectionResourceActionResponse": { "title": "GetDocumentFolderCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetDocumentFolderCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetDocumentFolderCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "DocumentFolder->Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "DocumentFolder->SequenceNumber" }, "parentDocumentFolderId": { "title": "parentDocumentFolderId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "DocumentFolder->ParentDocumentFolder_Id" }, "parentDocumentFolderDescription": { "title": "parentDocumentFolderDescription", "type": "string", "x-nullable": false, "x-propertyPath": "DocumentFolder->ParentDocumentFolder_Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "DocumentFolderParentDocumentFolderLookupResourceActionResponse": { "title": "DocumentFolderParentDocumentFolderLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "DocumentFolderParentDocumentFolderLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "DocumentFolderParentDocumentFolderLookupResourceActionResponseItemProperties", "type": "object", "properties": { "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "DocumentFolder->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "CreateDocumentFolderResourceActionRequest": { "title": "CreateDocumentFolderResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateDocumentFolderResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "description" ], "properties": { "description": { "title": "description", "type": "string", "maxLength": 500, "minLength": 1, "x-nullable": false, "x-propertyPath": "DocumentFolder->Description" }, "parentDocumentFolderId": { "title": "parentDocumentFolderId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "DocumentFolder->ParentDocumentFolder_Id" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "DocumentFolder->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "DocumentFolder->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "PatchOperationType": { "type": "string", "description": "", "x-nullable": true, "x-enumNames": [ "Replace", "Add", "Remove" ], "enum": [ "replace", "add", "remove" ] }, "EntityPatchOperationSchema": { "type": "object", "required": [ "path", "value" ], "properties": { "op": { "title": "op", "description": "Type of operation to apply", "example": "replace", "$ref": "#/definitions/PatchOperationType" }, "path": { "title": "path", "type": "string", "description": "Property path for the property being updated", "x-nullable": false, "example": "Asset->Code" }, "value": { "title": "value", "type": "object", "description": "Value for the property being updated", "x-nullable": true, "example": "BOILER" } } }, "UpdateDocumentFolderResourceActionRequest": { "title": "UpdateDocumentFolderResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "description", "type": "string", "maxLength": 500, "minLength": 1, "x-nullable": false, "x-propertyPath": "DocumentFolder->Description" }, { "title": "parentDocumentFolderId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "DocumentFolder->ParentDocumentFolder_Id" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "DocumentFolder->SequenceNumber" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "DocumentFolder->Notes" } ] } } }, "DeleteDocumentFolderResourceActionRequest": { "title": "DeleteDocumentFolderResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to delete. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to delete", "format": "int32", "example": 1 } } }, "BatchGetDocumentFolderResourceAction": { "title": "BatchGetDocumentFolderResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Document Folder entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Document Folder entities", "items": { "$ref": "#/definitions/GetDocumentFolderResourceActionResponse" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "self": { "$ref": "#/definitions/Link" } } }, "BatchCreateDocumentFolderRequest": { "title": "BatchCreateDocumentFolderRequest", "type": "array", "items": { "$ref": "#/definitions/CreateDocumentFolderResourceActionRequest" } }, "BatchUpdateDocumentFolderResourceActionRequest": { "title": "BatchUpdateDocumentFolderResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateDocumentFolderResourceActionRequest" } }, "BatchDeleteDocumentFolderResourceActionRequest": { "title": "BatchDeleteDocumentFolderResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteDocumentFolderResourceActionRequest" } }, "GetDocumentRecordResourceActionResponse": { "title": "GetDocumentRecordResourceActionResponse", "type": "object", "required": [ "properties" ], "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "format": "int64", "x-nullable": false, "example": 13243893 }, "version": { "title": "version", "type": "integer", "format": "int32", "x-nullable": false, "example": 1 }, "properties": { "title": "GetDocumentRecordResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "DocumentRecord->Code" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "DocumentRecord->IsActive" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "DocumentRecord->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "DocumentRecord->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "DocumentRecord->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "DocumentRecord->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "DocumentRecord->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "DocumentRecord->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "DocumentRecord->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "DocumentRecord->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "DocumentRecord->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "DocumentRecord->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "DocumentRecord->PermissionTree_Description" }, "approvedByUserId": { "title": "approvedByUserId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "DocumentRecord->ApprovedByUser_Id" }, "approvedByUserCode": { "title": "approvedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "DocumentRecord->ApprovedByUser_Code" }, "approvedByUserFullName": { "title": "approvedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "DocumentRecord->ApprovedByUser_FullName" }, "approvedFrom": { "title": "approvedFrom", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "DocumentRecord->ApprovedFrom" }, "approvedTo": { "title": "approvedTo", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "DocumentRecord->ApprovedTo" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "DocumentRecord->Description" }, "documentFolderId": { "title": "documentFolderId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "DocumentRecord->DocumentFolder_Id" }, "documentFolderDescription": { "title": "documentFolderDescription", "type": "string", "x-nullable": true, "x-propertyPath": "DocumentRecord->DocumentFolder_Description" }, "contentId": { "title": "contentId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "DocumentRecord->Content_Id" }, "contentFileLocationId": { "title": "contentFileLocationId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "DocumentRecord->Content_FileLocation_Id" }, "contentFileLocationDescription": { "title": "contentFileLocationDescription", "type": "string", "x-nullable": true, "x-propertyPath": "DocumentRecord->Content_FileLocation_Description" }, "contentFileLocationFileLocationType": { "title": "contentFileLocationFileLocationType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "DocumentRecord->Content_FileLocation_FileLocationType", "x-formatSpecifier": "FileContentStoreLocationType" }, "contentFileLocationOnKeyFileStoreId": { "title": "contentFileLocationOnKeyFileStoreId", "type": "string", "format": "uuid", "x-nullable": true, "example": "f81d4fae-7dec-11d0-a765-00a0c91e6bf6", "x-propertyPath": "DocumentRecord->Content_FileLocation_OnKeyFileStoreId" }, "contentSizeInBytes": { "title": "contentSizeInBytes", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "DocumentRecord->Content_SizeInBytes" }, "contentSizeInKb": { "title": "contentSizeInKb", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "DocumentRecord->Content_SizeInKb" }, "contentSizeInMb": { "title": "contentSizeInMb", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "DocumentRecord->Content_SizeInMb" }, "contentVersion": { "title": "contentVersion", "type": "integer", "format": "int32", "x-nullable": false, "x-propertyPath": "DocumentRecord->ContentVersion" }, "fileFullName": { "title": "fileFullName", "type": "string", "x-nullable": true, "x-propertyPath": "DocumentRecord->FileFullName" }, "fileName": { "title": "fileName", "type": "string", "x-nullable": false, "x-propertyPath": "DocumentRecord->FileName" }, "fileTypeId": { "title": "fileTypeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "DocumentRecord->FileType_Id" }, "fileTypeExtension": { "title": "fileTypeExtension", "type": "string", "x-nullable": true, "x-propertyPath": "DocumentRecord->FileType_Extension" }, "fileLocation": { "title": "fileLocation", "type": "string", "x-nullable": true, "x-propertyPath": "DocumentRecord->FileLocation" }, "isApproved": { "title": "isApproved", "type": "boolean", "x-nullable": false, "x-propertyPath": "DocumentRecord->IsApproved" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "DocumentRecord->Notes" }, "revisedBy": { "title": "revisedBy", "type": "string", "x-nullable": false, "x-propertyPath": "DocumentRecord->RevisedBy" }, "revisionDate": { "title": "revisionDate", "type": "string", "format": "date-time", "x-nullable": false, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "DocumentRecord->RevisionDate" }, "revisionNumber": { "title": "revisionNumber", "type": "integer", "format": "int32", "x-nullable": false, "x-propertyPath": "DocumentRecord->RevisionNumber" } } }, "permissionViolations": { "title": "permissionViolations", "type": "array", "description": "Permissions violations for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/EntityPermissionViolationSchema" } }, "translations": { "title": "translations", "type": "array", "description": "Custom translations for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/EntityPhraseTranslationSchema" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } }, "self": { "$ref": "#/definitions/Link" } } }, "GetDocumentRecordCollectionResourceActionResponse": { "title": "GetDocumentRecordCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetDocumentRecordCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetDocumentRecordCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "DocumentRecord->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "DocumentRecord->Description" }, "revisionNumber": { "title": "revisionNumber", "type": "integer", "format": "int32", "x-nullable": false, "x-propertyPath": "DocumentRecord->RevisionNumber" }, "revisionDate": { "title": "revisionDate", "type": "string", "format": "date-time", "x-nullable": false, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "DocumentRecord->RevisionDate" }, "revisedBy": { "title": "revisedBy", "type": "string", "x-nullable": false, "x-propertyPath": "DocumentRecord->RevisedBy" }, "isApproved": { "title": "isApproved", "type": "boolean", "x-nullable": false, "x-propertyPath": "DocumentRecord->IsApproved" }, "approvedFrom": { "title": "approvedFrom", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "DocumentRecord->ApprovedFrom" }, "approvedTo": { "title": "approvedTo", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "DocumentRecord->ApprovedTo" }, "approvedByUserId": { "title": "approvedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "DocumentRecord->ApprovedByUser_Id" }, "approvedByUserFullName": { "title": "approvedByUserFullName", "type": "string", "x-nullable": false, "x-propertyPath": "DocumentRecord->ApprovedByUser_FullName" }, "fileLocation": { "title": "fileLocation", "type": "string", "x-nullable": true, "x-propertyPath": "DocumentRecord->FileLocation" }, "fileFullName": { "title": "fileFullName", "type": "string", "x-nullable": true, "x-propertyPath": "DocumentRecord->FileFullName" }, "contentSizeInMb": { "title": "contentSizeInMb", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "DocumentRecord->Content_SizeInMb" }, "fileTypeExtension": { "title": "fileTypeExtension", "type": "string", "x-nullable": true, "x-propertyPath": "DocumentRecord->FileType_Extension" }, "documentFolderId": { "title": "documentFolderId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "DocumentRecord->DocumentFolder_Id" }, "documentFolderDescription": { "title": "documentFolderDescription", "type": "string", "x-nullable": false, "x-propertyPath": "DocumentRecord->DocumentFolder_Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "DocumentRecord->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "DocumentRecord->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "DocumentRecord->ModifiedOn" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "DocumentRecordChangePermissionTreeLookupResourceActionResponse": { "title": "DocumentRecordChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "DocumentRecordChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "DocumentRecordChangePermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "DocumentRecordDocumentFolderLookupResourceActionResponse": { "title": "DocumentRecordDocumentFolderLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "DocumentRecordDocumentFolderLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "DocumentRecordDocumentFolderLookupResourceActionResponseItemProperties", "type": "object", "properties": { "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "DocumentFolder->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "DocumentRecordInsertPermissionTreeLookupResourceActionResponse": { "title": "DocumentRecordInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "DocumentRecordInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "DocumentRecordInsertPermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "CreateDocumentRecordResourceActionRequest": { "title": "CreateDocumentRecordResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateDocumentRecordResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "permissionTreeId", "code", "description", "revisionNumber", "revisionDate", "revisedBy", "documentFolderId" ], "properties": { "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "DocumentRecord->PermissionTree_Id" }, "code": { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "DocumentRecord->Code" }, "description": { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "DocumentRecord->Description" }, "revisionNumber": { "title": "revisionNumber", "type": "integer", "format": "int32", "x-nullable": false, "x-propertyPath": "DocumentRecord->RevisionNumber" }, "revisionDate": { "title": "revisionDate", "type": "string", "format": "date-time", "x-nullable": false, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "DocumentRecord->RevisionDate" }, "revisedBy": { "title": "revisedBy", "type": "string", "x-nullable": false, "x-propertyPath": "DocumentRecord->RevisedBy" }, "isApproved": { "title": "isApproved", "type": "boolean", "x-nullable": false, "x-propertyPath": "DocumentRecord->IsApproved" }, "approvedFrom": { "title": "approvedFrom", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "DocumentRecord->ApprovedFrom" }, "approvedTo": { "title": "approvedTo", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "DocumentRecord->ApprovedTo" }, "fileLocation": { "title": "fileLocation", "type": "string", "x-nullable": true, "x-propertyPath": "DocumentRecord->FileLocation" }, "documentFolderId": { "title": "documentFolderId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "DocumentRecord->DocumentFolder_Id" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "DocumentRecord->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateDocumentRecordResourceActionRequest": { "title": "UpdateDocumentRecordResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "DocumentRecord->Code" }, { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "DocumentRecord->Description" }, { "title": "revisionNumber", "type": "integer", "format": "int32", "x-nullable": false, "x-propertyPath": "DocumentRecord->RevisionNumber" }, { "title": "revisionDate", "type": "string", "format": "date-time", "x-nullable": false, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "DocumentRecord->RevisionDate" }, { "title": "revisedBy", "type": "string", "x-nullable": false, "x-propertyPath": "DocumentRecord->RevisedBy" }, { "title": "isApproved", "type": "boolean", "x-nullable": false, "x-propertyPath": "DocumentRecord->IsApproved" }, { "title": "approvedFrom", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "DocumentRecord->ApprovedFrom" }, { "title": "approvedTo", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "DocumentRecord->ApprovedTo" }, { "title": "fileLocation", "type": "string", "x-nullable": true, "x-propertyPath": "DocumentRecord->FileLocation" }, { "title": "documentFolderId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "DocumentRecord->DocumentFolder_Id" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "DocumentRecord->Notes" }, { "title": "fileName", "type": "string", "x-nullable": false, "x-propertyPath": "DocumentRecord->FileName" } ] } } }, "DeleteDocumentRecordResourceActionRequest": { "title": "DeleteDocumentRecordResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to delete. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to delete", "format": "int32", "example": 1 } } }, "BatchGetDocumentRecordResourceAction": { "title": "BatchGetDocumentRecordResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Document Record entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Document Record entities", "items": { "$ref": "#/definitions/GetDocumentRecordResourceActionResponse" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "self": { "$ref": "#/definitions/Link" } } }, "GetDocumentRecordFileHistoryResourceActionResponse": { "title": "GetDocumentRecordFileHistoryResourceActionResponse", "type": "object", "properties": { "id": { "title": "id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "DocumentRecordFileHistory->Id" }, "version": { "title": "version", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "DocumentRecordFileHistory->Version" }, "contentId": { "title": "contentId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "DocumentRecordFileHistory->Content_Id" }, "contentFileLocationId": { "title": "contentFileLocationId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "DocumentRecordFileHistory->Content_FileLocation_Id" }, "contentFileLocationDescription": { "title": "contentFileLocationDescription", "type": "string", "x-nullable": true, "x-propertyPath": "DocumentRecordFileHistory->Content_FileLocation_Description" }, "contentFileLocationFileLocationType": { "title": "contentFileLocationFileLocationType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "DocumentRecordFileHistory->Content_FileLocation_FileLocationType", "x-formatSpecifier": "FileContentStoreLocationType" }, "contentFileLocationOnKeyFileStoreId": { "title": "contentFileLocationOnKeyFileStoreId", "type": "string", "format": "uuid", "x-nullable": true, "example": "f81d4fae-7dec-11d0-a765-00a0c91e6bf6", "x-propertyPath": "DocumentRecordFileHistory->Content_FileLocation_OnKeyFileStoreId" }, "contentSizeInBytes": { "title": "contentSizeInBytes", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "DocumentRecordFileHistory->Content_SizeInBytes" }, "contentSizeInKb": { "title": "contentSizeInKb", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "DocumentRecordFileHistory->Content_SizeInKb" }, "contentSizeInMb": { "title": "contentSizeInMb", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "DocumentRecordFileHistory->Content_SizeInMb" }, "contentVersion": { "title": "contentVersion", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "DocumentRecordFileHistory->ContentVersion" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "DocumentRecordFileHistory->CreatedOn" }, "documentRecordId": { "title": "documentRecordId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "DocumentRecordFileHistory->DocumentRecord_Id" }, "documentRecordCode": { "title": "documentRecordCode", "type": "string", "x-nullable": true, "x-propertyPath": "DocumentRecordFileHistory->DocumentRecord_Code" }, "documentRecordDescription": { "title": "documentRecordDescription", "type": "string", "x-nullable": true, "x-propertyPath": "DocumentRecordFileHistory->DocumentRecord_Description" } } }, "GetDocumentRecordFileHistoryResourceAction": { "title": "GetDocumentRecordFileHistoryResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Document Record entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Document Record entities", "items": { "$ref": "#/definitions/GetDocumentRecordFileHistoryResourceActionResponse" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "self": { "$ref": "#/definitions/Link" } } }, "BatchCreateDocumentRecordResourceActionRequest": { "title": "BatchCreateDocumentRecordResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateDocumentRecordResourceActionRequest" } }, "BatchUpdateDocumentRecordResourceActionRequest": { "title": "BatchUpdateDocumentRecordResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateDocumentRecordResourceActionRequest" } }, "BatchDeleteDocumentRecordResourceActionRequest": { "title": "BatchDeleteDocumentRecordResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteDocumentRecordResourceActionRequest" } }, "ChangeDocumentRecordIsActiveResourceActionRequest": { "title": "ChangeDocumentRecordIsActiveResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "DocumentRecord->IsActive" } ] } } }, "ChangeDocumentRecordPermissionTreeResourceActionRequest": { "title": "ChangeDocumentRecordPermissionTreeResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "DocumentRecord->PermissionTree_Id" } ] } } }, "RemoveDocumentRecordFileResourceActionRequest": { "title": "RemoveDocumentRecordFileResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/definitions/EntityPatchOperationSchema" } } } }, "UploadDocumentRecordFileResourceActionRequest": { "title": "UploadDocumentRecordFileResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "version": { "title": "version", "type": "integer", "format": "int32", "x-nullable": false, "x-propertyPath": "DocumentRecord->Version" }, "fileName": { "title": "fileName", "type": "string", "x-nullable": false, "x-propertyPath": "DocumentRecord->FileName" }, "file": { "type": "string", "format": "binary" } } }, "BatchChangeDocumentRecordIsActiveResourceActionRequest": { "title": "BatchChangeDocumentRecordIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeDocumentRecordIsActiveResourceActionRequest" } }, "BatchChangeDocumentRecordPermissionTreeResourceActionRequest": { "title": "BatchChangeDocumentRecordPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeDocumentRecordPermissionTreeResourceActionRequest" } }, "DynamicValueSchema": { "title": "DynamicValueSchema", "type": "object", "properties": { "type": { "title": "type", "type": "string", "format": "enum", "x-nullable": false, "x-formatSpecifier": "DynamicValueType", "x-enumNames": [ "String", "Email", "Integer", "Long", "Float", "Currency", "DateTime", "Date", "Time", "Duration", "Boolean" ] }, "value": { "title": "value", "type": "object" } } }, "GetDocumentRecordAttributeResourceActionResponse": { "title": "GetDocumentRecordAttributeResourceActionResponse", "type": "object", "required": [ "properties" ], "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "format": "int64", "x-nullable": false, "example": 13243893 }, "version": { "title": "version", "type": "integer", "format": "int32", "x-nullable": false, "example": 1 }, "properties": { "title": "GetDocumentRecordAttributeResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "documentRecordId": { "title": "documentRecordId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "DocumentRecordAttribute->DocumentRecord_Id" }, "documentRecordCode": { "title": "documentRecordCode", "type": "string", "x-nullable": true, "x-propertyPath": "DocumentRecordAttribute->DocumentRecord_Code" }, "documentRecordDescription": { "title": "documentRecordDescription", "type": "string", "x-nullable": true, "x-propertyPath": "DocumentRecordAttribute->DocumentRecord_Description" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "DocumentRecordAttribute->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "DocumentRecordAttribute->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "DocumentRecordAttribute->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "DocumentRecordAttribute->CreatedOn" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": true, "x-propertyPath": "DocumentRecordAttribute->IsActive" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "DocumentRecordAttribute->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "DocumentRecordAttribute->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "DocumentRecordAttribute->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "DocumentRecordAttribute->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "DocumentRecordAttribute->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "DocumentRecordAttribute->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "DocumentRecordAttribute->PermissionTree_Description" }, "attributeId": { "title": "attributeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "DocumentRecordAttribute->Attribute_Id" }, "attributeCode": { "title": "attributeCode", "type": "string", "x-nullable": true, "x-propertyPath": "DocumentRecordAttribute->Attribute_Code" }, "attributeDescription": { "title": "attributeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "DocumentRecordAttribute->Attribute_Description" }, "attributeAllowAnyValue": { "title": "attributeAllowAnyValue", "type": "boolean", "x-nullable": true, "x-propertyPath": "DocumentRecordAttribute->Attribute_AllowAnyValue" }, "attributeDataType": { "title": "attributeDataType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "DocumentRecordAttribute->Attribute_DataType", "x-formatSpecifier": "DynamicValueType" }, "attributeDefaultValue": { "title": "attributeDefaultValue", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "DocumentRecordAttribute->Attribute_DefaultValue", "x-formatSpecifier": "DynamicValue" }, "attributeDefaultAllowedValueId": { "title": "attributeDefaultAllowedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "DocumentRecordAttribute->Attribute_DefaultAllowedValue_Id" }, "attributeDefaultAllowedValueDescription": { "title": "attributeDefaultAllowedValueDescription", "type": "string", "x-nullable": true, "x-propertyPath": "DocumentRecordAttribute->Attribute_DefaultAllowedValue_Description" }, "attributeDefaultAllowedValueValue": { "title": "attributeDefaultAllowedValueValue", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "DocumentRecordAttribute->Attribute_DefaultAllowedValue_Value", "x-formatSpecifier": "DynamicValue" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "DocumentRecordAttribute->Notes" }, "predefinedValueId": { "title": "predefinedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "DocumentRecordAttribute->PredefinedValue_Id" }, "predefinedValueDescription": { "title": "predefinedValueDescription", "type": "string", "x-nullable": true, "x-propertyPath": "DocumentRecordAttribute->PredefinedValue_Description" }, "predefinedValueValue": { "title": "predefinedValueValue", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "DocumentRecordAttribute->PredefinedValue_Value", "x-formatSpecifier": "DynamicValue" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "DocumentRecordAttribute->SequenceNumber" }, "value": { "title": "value", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "DocumentRecordAttribute->Value", "x-formatSpecifier": "DynamicValue" } } }, "permissionViolations": { "title": "permissionViolations", "type": "array", "description": "Permissions violations for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/EntityPermissionViolationSchema" } }, "translations": { "title": "translations", "type": "array", "description": "Custom translations for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/EntityPhraseTranslationSchema" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } }, "self": { "$ref": "#/definitions/Link" } } }, "GetDocumentRecordAttributeCollectionForDocumentRecordResourceActionResponse": { "title": "GetDocumentRecordAttributeCollectionForDocumentRecordResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetDocumentRecordAttributeCollectionForDocumentRecordResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetDocumentRecordAttributeCollectionForDocumentRecordResourceActionResponseItemProperties", "type": "object", "properties": { "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "DocumentRecordAttribute->SequenceNumber" }, "attributeId": { "title": "attributeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "DocumentRecordAttribute->Attribute_Id" }, "attributeCode": { "title": "attributeCode", "type": "string", "x-nullable": false, "x-propertyPath": "DocumentRecordAttribute->Attribute_Code" }, "attributeDescription": { "title": "attributeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "DocumentRecordAttribute->Attribute_Description" }, "attributeDataType": { "title": "attributeDataType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "DocumentRecordAttribute->Attribute_DataType", "x-formatSpecifier": "DynamicValueType" }, "predefinedValueId": { "title": "predefinedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "DocumentRecordAttribute->PredefinedValue_Id" }, "predefinedValueDescription": { "title": "predefinedValueDescription", "type": "string", "x-nullable": true, "x-propertyPath": "DocumentRecordAttribute->PredefinedValue_Description" }, "predefinedValueValue": { "title": "predefinedValueValue", "format": "composite", "x-nullable": false, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "DocumentRecordAttribute->PredefinedValue_Value", "x-formatSpecifier": "DynamicValue" }, "value": { "title": "value", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "DocumentRecordAttribute->Value", "x-formatSpecifier": "DynamicValue" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "DocumentRecordAttribute->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "DocumentRecordAttribute->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "DocumentRecordAttribute->ModifiedOn" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "GetDocumentRecordAttributeCollectionResourceActionResponse": { "title": "GetDocumentRecordAttributeCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetDocumentRecordAttributeCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetDocumentRecordAttributeCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "DocumentRecordAttribute->SequenceNumber" }, "documentRecordCode": { "title": "documentRecordCode", "type": "string", "x-nullable": false, "x-propertyPath": "DocumentRecordAttribute->DocumentRecord_Code" }, "documentRecordDescription": { "title": "documentRecordDescription", "type": "string", "x-nullable": false, "x-propertyPath": "DocumentRecordAttribute->DocumentRecord_Description" }, "attributeId": { "title": "attributeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "DocumentRecordAttribute->Attribute_Id" }, "attributeCode": { "title": "attributeCode", "type": "string", "x-nullable": false, "x-propertyPath": "DocumentRecordAttribute->Attribute_Code" }, "attributeDescription": { "title": "attributeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "DocumentRecordAttribute->Attribute_Description" }, "attributeDataType": { "title": "attributeDataType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "DocumentRecordAttribute->Attribute_DataType", "x-formatSpecifier": "DynamicValueType" }, "predefinedValueId": { "title": "predefinedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "DocumentRecordAttribute->PredefinedValue_Id" }, "predefinedValueDescription": { "title": "predefinedValueDescription", "type": "string", "x-nullable": true, "x-propertyPath": "DocumentRecordAttribute->PredefinedValue_Description" }, "predefinedValueValue": { "title": "predefinedValueValue", "format": "composite", "x-nullable": false, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "DocumentRecordAttribute->PredefinedValue_Value", "x-formatSpecifier": "DynamicValue" }, "value": { "title": "value", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "DocumentRecordAttribute->Value", "x-formatSpecifier": "DynamicValue" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "DocumentRecordAttribute->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "DocumentRecordAttribute->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "DocumentRecordAttribute->ModifiedOn" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "DocumentRecordAttributeAttributeAllowedValueLookupResourceActionResponse": { "title": "DocumentRecordAttributeAttributeAllowedValueLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "DocumentRecordAttributeAttributeAllowedValueLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "DocumentRecordAttributeAttributeAllowedValueLookupResourceActionResponseItemProperties", "type": "object", "properties": { "description": { "title": "description", "type": "string", "x-nullable": true, "x-propertyPath": "AttributeAllowedValue->Description" }, "value": { "title": "value", "format": "composite", "x-nullable": false, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "AttributeAllowedValue->Value", "x-formatSpecifier": "DynamicValue" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "DocumentRecordAttributeAttributeLookupResourceActionResponse": { "title": "DocumentRecordAttributeAttributeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "DocumentRecordAttributeAttributeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "DocumentRecordAttributeAttributeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Attribute->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "Attribute->Description" }, "allowAnyValue": { "title": "allowAnyValue", "type": "boolean", "x-nullable": false, "x-propertyPath": "Attribute->AllowAnyValue" }, "dataType": { "title": "dataType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "Attribute->DataType", "x-formatSpecifier": "DynamicValueType" }, "defaultValue": { "title": "defaultValue", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "Attribute->DefaultValue", "x-formatSpecifier": "DynamicValue", "x-NullExpression": "Attribute->AllowAnyValue eq false" }, "defaultAllowedValueId": { "title": "defaultAllowedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Attribute->DefaultAllowedValue_Id" }, "defaultAllowedValueValue": { "title": "defaultAllowedValueValue", "format": "composite", "x-nullable": false, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "Attribute->DefaultAllowedValue_Value", "x-formatSpecifier": "DynamicValue" }, "defaultAllowedValueDescription": { "title": "defaultAllowedValueDescription", "type": "string", "x-nullable": true, "x-propertyPath": "Attribute->DefaultAllowedValue_Description" }, "explanation": { "title": "explanation", "type": "string", "x-nullable": true, "x-propertyPath": "Attribute->Explanation" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "DocumentRecordAttributeDocumentRecordLookupResourceActionResponse": { "title": "DocumentRecordAttributeDocumentRecordLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "DocumentRecordAttributeDocumentRecordLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "DocumentRecordAttributeDocumentRecordLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "DocumentRecord->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "DocumentRecord->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "DocumentRecordAttributeInsertPermissionTreeLookupResourceActionResponse": { "title": "DocumentRecordAttributeInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "DocumentRecordAttributeInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "DocumentRecordAttributeInsertPermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "CreateDocumentRecordAttributeResourceActionRequest": { "title": "CreateDocumentRecordAttributeResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateDocumentRecordAttributeResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "documentRecordId", "attributeId" ], "properties": { "documentRecordId": { "title": "documentRecordId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "DocumentRecordAttribute->DocumentRecord_Id" }, "attributeId": { "title": "attributeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "DocumentRecordAttribute->Attribute_Id" }, "value": { "title": "value", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "DocumentRecordAttribute->Value", "x-formatSpecifier": "DynamicValue" }, "predefinedValueId": { "title": "predefinedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "DocumentRecordAttribute->PredefinedValue_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "DocumentRecordAttribute->PermissionTree_Id", "x-systemGenerated": true }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "DocumentRecordAttribute->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "DocumentRecordAttribute->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateDocumentRecordAttributeResourceActionRequest": { "title": "UpdateDocumentRecordAttributeResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "value", "format": "composite", "x-nullable": true, "x-propertyPath": "DocumentRecordAttribute->Value", "x-formatSpecifier": "DynamicValue" }, { "title": "predefinedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "DocumentRecordAttribute->PredefinedValue_Id" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "DocumentRecordAttribute->SequenceNumber" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "DocumentRecordAttribute->Notes" } ] } } }, "DeleteDocumentRecordAttributeResourceActionRequest": { "title": "DeleteDocumentRecordAttributeResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to delete. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to delete", "format": "int32", "example": 1 } } }, "BatchGetDocumentRecordAttributeResourceAction": { "title": "BatchGetDocumentRecordAttributeResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Document Record Attribute entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Document Record Attribute entities", "items": { "$ref": "#/definitions/GetDocumentRecordAttributeResourceActionResponse" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "self": { "$ref": "#/definitions/Link" } } }, "BatchCreateDocumentRecordAttributeResourceActionRequest": { "title": "BatchCreateDocumentRecordAttributeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateDocumentRecordAttributeResourceActionRequest" } }, "BatchUpdateDocumentRecordAttributeResourceActionRequest": { "title": "BatchUpdateDocumentRecordAttributeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateDocumentRecordAttributeResourceActionRequest" } }, "BatchDeleteDocumentRecordAttributeResourceActionRequest": { "title": "BatchDeleteDocumentRecordAttributeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteDocumentRecordAttributeResourceActionRequest" } }, "ChangeDocumentRecordAttributeIsActiveResourceActionRequest": { "title": "ChangeDocumentRecordAttributeIsActiveResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "DocumentRecordAttribute->IsActive" } ] } } }, "BatchChangeDocumentRecordAttributeIsActiveResourceActionRequest": { "title": "BatchChangeDocumentRecordAttributeIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeDocumentRecordAttributeIsActiveResourceActionRequest" } }, "GetFileAttachmentCategoryResourceActionResponse": { "title": "GetFileAttachmentCategoryResourceActionResponse", "type": "object", "required": [ "properties" ], "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "format": "int64", "x-nullable": false, "example": 13243893 }, "version": { "title": "version", "type": "integer", "format": "int32", "x-nullable": false, "example": 1 }, "properties": { "title": "GetFileAttachmentCategoryResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "FileAttachmentCategory->Code" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "FileAttachmentCategory->IsActive" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "FileAttachmentCategory->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "FileAttachmentCategory->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "FileAttachmentCategory->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "FileAttachmentCategory->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "FileAttachmentCategory->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "FileAttachmentCategory->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "FileAttachmentCategory->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "FileAttachmentCategory->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "FileAttachmentCategory->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "FileAttachmentCategory->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "FileAttachmentCategory->PermissionTree_Description" }, "autoIsRestricted": { "title": "autoIsRestricted", "type": "boolean", "x-nullable": true, "x-propertyPath": "FileAttachmentCategory->AutoIsRestricted" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "FileAttachmentCategory->Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "FileAttachmentCategory->Notes" } } }, "permissionViolations": { "title": "permissionViolations", "type": "array", "description": "Permissions violations for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/EntityPermissionViolationSchema" } }, "translations": { "title": "translations", "type": "array", "description": "Custom translations for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/EntityPhraseTranslationSchema" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } }, "self": { "$ref": "#/definitions/Link" } } }, "GetFileAttachmentCategoryCollectionResourceActionResponse": { "title": "GetFileAttachmentCategoryCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetFileAttachmentCategoryCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetFileAttachmentCategoryCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "FileAttachmentCategory->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "FileAttachmentCategory->Description" }, "autoIsRestricted": { "title": "autoIsRestricted", "type": "boolean", "x-nullable": true, "x-propertyPath": "FileAttachmentCategory->AutoIsRestricted" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "FileAttachmentCategory->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "FileAttachmentCategory->ModifiedOn" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "FileAttachmentCategoryChangePermissionTreeLookupResourceActionResponse": { "title": "FileAttachmentCategoryChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "FileAttachmentCategoryChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "FileAttachmentCategoryChangePermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "FileAttachmentCategoryInsertPermissionTreeLookupResourceActionResponse": { "title": "FileAttachmentCategoryInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "FileAttachmentCategoryInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "FileAttachmentCategoryInsertPermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "FileAttachmentCategoryLookupResourceActionResponse": { "title": "FileAttachmentCategoryLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "FileAttachmentCategoryLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "FileAttachmentCategoryLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "FileAttachmentCategory->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "FileAttachmentCategory->Description" }, "autoIsRestricted": { "title": "autoIsRestricted", "type": "boolean", "x-nullable": true, "x-propertyPath": "FileAttachmentCategory->AutoIsRestricted" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "CreateFileAttachmentCategoryResourceActionRequest": { "title": "CreateFileAttachmentCategoryResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateFileAttachmentCategoryResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "permissionTreeId", "code", "description" ], "properties": { "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "FileAttachmentCategory->PermissionTree_Id" }, "code": { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "FileAttachmentCategory->Code" }, "description": { "title": "description", "type": "string", "maxLength": 250, "minLength": 1, "x-nullable": false, "x-propertyPath": "FileAttachmentCategory->Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "FileAttachmentCategory->Notes" }, "autoIsRestricted": { "title": "autoIsRestricted", "type": "boolean", "x-nullable": true, "x-propertyPath": "FileAttachmentCategory->AutoIsRestricted" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateFileAttachmentCategoryResourceActionRequest": { "title": "UpdateFileAttachmentCategoryResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "FileAttachmentCategory->Code" }, { "title": "description", "type": "string", "maxLength": 250, "minLength": 1, "x-nullable": false, "x-propertyPath": "FileAttachmentCategory->Description" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "FileAttachmentCategory->Notes" }, { "title": "autoIsRestricted", "type": "boolean", "x-nullable": true, "x-propertyPath": "FileAttachmentCategory->AutoIsRestricted" } ] } } }, "DeleteFileAttachmentCategoryResourceActionRequest": { "title": "DeleteFileAttachmentCategoryResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to delete. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to delete", "format": "int32", "example": 1 } } }, "BatchGetFileAttachmentCategoryResourceAction": { "title": "BatchGetFileAttachmentCategoryResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of File Attachment Category entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of File Attachment Category entities", "items": { "$ref": "#/definitions/GetFileAttachmentCategoryResourceActionResponse" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "self": { "$ref": "#/definitions/Link" } } }, "BatchCreateFileAttachmentCategoryResourceActionRequest": { "title": "BatchCreateFileAttachmentCategoryResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateFileAttachmentCategoryResourceActionRequest" } }, "BatchUpdateFileAttachmentCategoryResourceActionRequest": { "title": "BatchUpdateFileAttachmentCategoryResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateFileAttachmentCategoryResourceActionRequest" } }, "BatchDeleteFileAttachmentCategoryResourceActionRequest": { "title": "BatchDeleteFileAttachmentCategoryResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteFileAttachmentCategoryResourceActionRequest" } }, "ChangeFileAttachmentCategoryIsActiveResourceActionRequest": { "title": "ChangeFileAttachmentCategoryIsActiveResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "FileAttachmentCategory->IsActive" } ] } } }, "ChangeFileAttachmentCategoryPermissionTreeResourceActionRequest": { "title": "ChangeFileAttachmentCategoryPermissionTreeResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "FileAttachmentCategory->PermissionTree_Id" } ] } } }, "BatchChangeFileAttachmentCategoryIsActiveResourceActionRequest": { "title": "BatchChangeFileAttachmentCategoryIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeFileAttachmentCategoryIsActiveResourceActionRequest" } }, "BatchChangeFileAttachmentCategoryPermissionTreeResourceActionRequest": { "title": "BatchChangeFileAttachmentCategoryPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeFileAttachmentCategoryPermissionTreeResourceActionRequest" } } }, "parameters": { "ExecutionMode": { "type": "string", "name": "mode", "in": "query", "description": "Execution mode to use for executing the batch operation", "enum": [ "AllOrNone", "PerRecord" ] }, "Async": { "type": "boolean", "name": "async", "in": "query", "description": "Enqueue the operation asynchronously using a Background Task." }, "AsyncDescription": { "type": "string", "name": "description", "in": "query", "description": "Optional description for the asynchronous execution of the Background Task." }, "Schedule": { "type": "string", "name": "schedule", "in": "query", "description": "Optional cron expression to schedule the asynchronous execution of the Background Task." }, "ScheduleFrom": { "type": "string", "name": "from", "in": "query", "description": "Optional future date at which a recurring schedule for the asynchronous execution of the Background Task should start. If no value is provided the current UTC date and time is used." }, "Filter": { "type": "string", "name": "$filter", "in": "query", "description": "Filter expression to apply on the resource to limit the response data returned, e.g. $filter=id gt 0 and code startswith 'ABCD'" }, "OrderBy": { "type": "string", "name": "$orderby", "in": "query", "description": "Comma separated list of the data properties on the resource to order the response data returned, e.g. $orderby=id DESC,code ASC" }, "Param": { "type": "string", "name": "$param", "in": "query", "description": "Comma separated list of key/value pairs to parameterise `$filter` expressions to limit the response data returned, e.g. $param=@code:'JUMA'" }, "Select": { "type": "string", "name": "$select", "in": "query", "description": "Comma separated list of the data properties on the resource to return, e.g. $select=id,code,description" }, "Skip": { "type": "string", "name": "$skip", "in": "query", "description": "Number of items to skip. Use in combination with `$top` to page through the response data returned, e.g. $skip=20" }, "Top": { "type": "string", "name": "$top", "in": "query", "description": "Number of items to return in the response data, e.g. $top=20" } }, "responses": { "default": { "x-nullable": true, "description": "Error response - operation failed" }, "created": { "x-nullable": true, "description": "Success response - resource was successfully created", "headers": { "OnKey-Resource-Id": { "type": "integer", "description": "Id of the resource created", "format": "Int64" }, "OnKey-Resource-Location": { "type": "string", "description": "Uri to fetch the created resource" } } }, "accepted": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "scheduled": { "description": "Request was successfully scheduled for asynchronous execution using a Scheduled Background Task", "headers": { "OnKey-Resource-Id": { "type": "integer", "description": "Id of the Scheduled Background Task resource created", "format": "Int64" }, "OnKey-Resource-Location": { "type": "string", "description": "Uri to fetch the Scheduled Background Task resource" }, "OnKey-Job-Id": { "type": "string", "description": "Job id of the job schedule created", "format": "Uuid" }, "OnKey-Job-Schedule-Location": { "type": "string", "description": "URI to fetch the job schedule for the asynchronous execution of the request" } } } }, "securityDefinitions": { "Bearer": { "type": "basic", "description": "Use the JWT access token received by authenticating with your configured On Key Identity Provider" } }, "security": [ { "Bearer": [] } ], "tags": [ { "name": "Document Folder" }, { "name": "Document Record" }, { "name": "Document Record Attribute" }, { "name": "File Attachment Category" } ], "x-tagGroups": [ { "name": "DM", "tags": [ "Document Folder", "Document Record", "Document Record Attribute", "File Attachment Category" ] } ] }