{ "x-generator": "On Key REST API Docs Generator", "swagger": "2.0", "info": { "title": "On Key IDENTITY 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.entitydelete+json", "application/vnd.onkey.entitydeletecollection+json", "application/vnd.onkey.entitypatch+json", "application/vnd.onkey.entitypatchcollection+json", "application/vnd.onkey.entity+json" ], "produces": [ "application/vnd.onkey.translationset+json", "application/vnd.onkey.notification+json", "application/vnd.onkey.entity+json", "application/vnd.onkey.entitycollection+json", "application/vnd.onkey.entitycollectionpage+json" ], "paths": { "/Modules/IDENTITY/Localisations/Sets/{name}/Translations": { "get": { "tags": [ "My Identity" ], "summary": "Get a collection of translations for the Localisation Set", "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 | TranslationSet->Id | integer | int64 |\r\n| languageCode | TranslationSet->LanguageCode | string | |\r\n| languageId | TranslationSet->LanguageId | integer | int64 |\r\n| name | TranslationSet->Name | string | |\r\n| translations | TranslationSet->Translations | object | |\r\n", "operationId": "GetLocalisationSetTranslations", "produces": [ "application/vnd.onkey.translationset+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "Name of Localisation Set", "x-nullable": false }, { "type": "integer", "name": "langId", "in": "query", "description": "Language Id (default=0)", "format": "int64", "x-nullable": false }, { "type": "string", "name": "lang", "in": "query", "description": "Language Code (default=en)", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Translation Set definition", "schema": { "$ref": "#/definitions/TranslationSetSchema" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/IDENTITY/BackgroundTasks/Summary": { "get": { "tags": [ "My Identity" ], "summary": "Get a summary of my Background Task resources for the last 24 hours.", "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 | BackgroundTasksSummary->Id | integer | int64 |\r\n| abortedCount | BackgroundTasksSummary->AbortedCount | integer | int64 |\r\n| cancelledCount | BackgroundTasksSummary->CancelledCount | integer | int64 |\r\n| completedCount | BackgroundTasksSummary->CompletedCount | integer | int64 |\r\n| notStartedCount | BackgroundTasksSummary->NotStartedCount | integer | int64 |\r\n| runningCount | BackgroundTasksSummary->RunningCount | integer | int64 |\r\n| totalCount | BackgroundTasksSummary->TotalCount | integer | int64 |\r\n", "operationId": "GetMyBackgroundTasksSummary", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains My Identity", "schema": { "$ref": "#/definitions/GetMyBackgroundTasksSummaryResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/IDENTITY/Options/AMPC": { "get": { "tags": [ "My Identity" ], "summary": "Get a My Identity 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| taskResponsibleSectionId | GetMyDefaultAMPCUserOptionsValues->TaskResponsibleSectionId | integer | int64 |\r\n| taskResponsibleStaffId | GetMyDefaultAMPCUserOptionsValues->TaskResponsibleStaffId | integer | int64 |\r\n| taskResponsibleTradeId | GetMyDefaultAMPCUserOptionsValues->TaskResponsibleTradeId | integer | int64 |\r\n", "operationId": "GetMyDefaultAMPCUserOptions", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains My Identity", "schema": { "$ref": "#/definitions/GetMyDefaultAMPCUserOptionsResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/IDENTITY/Options/FIN": { "get": { "tags": [ "My Identity" ], "summary": "Get a My Identity 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| enableCosting | GetMyDefaultFINUserOptionsValues->EnableCosting | boolean | |\r\n", "operationId": "GetMyDefaultFINUserOptions", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains My Identity", "schema": { "$ref": "#/definitions/GetMyDefaultFINUserOptionsResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/IDENTITY/Options/MM": { "get": { "tags": [ "My Identity" ], "summary": "Get a My Identity 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| enableRequisitions | GetMyDefaultMMUserOptionsValues->EnableRequisitions | boolean | |\r\n", "operationId": "GetMyDefaultMMUserOptions", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains My Identity", "schema": { "$ref": "#/definitions/GetMyDefaultMMUserOptionsResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/IDENTITY/Options": { "get": { "tags": [ "My Identity" ], "summary": "Get a My Identity 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| enableCosting | GetMyDefaultUserOptionsValues->EnableCosting | boolean | |\r\n| enableRequisitions | GetMyDefaultUserOptionsValues->EnableRequisitions | boolean | |\r\n| applyWorkOrderStatusRules | GetMyDefaultUserOptionsValues->ApplyWorkOrderStatusRules | boolean | |\r\n| defaultWorkOrderTaskResourceCostElementId | GetMyDefaultUserOptionsValues->DefaultWorkOrderTaskResourceCostElementId | integer | int64 |\r\n| taskResponsibleSectionId | GetMyDefaultUserOptionsValues->TaskResponsibleSectionId | integer | int64 |\r\n| taskResponsibleStaffId | GetMyDefaultUserOptionsValues->TaskResponsibleStaffId | integer | int64 |\r\n| taskResponsibleTradeId | GetMyDefaultUserOptionsValues->TaskResponsibleTradeId | integer | int64 |\r\n| workClassification1Id | GetMyDefaultUserOptionsValues->WorkClassification1Id | integer | int64 |\r\n| workClassification2Id | GetMyDefaultUserOptionsValues->WorkClassification2Id | integer | int64 |\r\n| workClassification3Id | GetMyDefaultUserOptionsValues->WorkClassification3Id | integer | int64 |\r\n| workClassification4Id | GetMyDefaultUserOptionsValues->WorkClassification4Id | integer | int64 |\r\n| workClassification5Id | GetMyDefaultUserOptionsValues->WorkClassification5Id | integer | int64 |\r\n| workOrderCanBeQueued | GetMyDefaultUserOptionsValues->WorkOrderCanBeQueued | boolean | |\r\n| workOrderImportanceId | GetMyDefaultUserOptionsValues->WorkOrderImportanceId | integer | int64 |\r\n| workOrderLimit | GetMyDefaultUserOptionsValues->WorkOrderLimit | number | decimal |\r\n| workOrderResponsibleSectionId | GetMyDefaultUserOptionsValues->WorkOrderResponsibleSectionId | integer | int64 |\r\n| workOrderResponsibleStaffId | GetMyDefaultUserOptionsValues->WorkOrderResponsibleStaffId | integer | int64 |\r\n| workOrderResponsibleTradeId | GetMyDefaultUserOptionsValues->WorkOrderResponsibleTradeId | integer | int64 |\r\n| workOrderTypeOfWorkForConditionMonitoringId | GetMyDefaultUserOptionsValues->WorkOrderTypeOfWorkForConditionMonitoringId | integer | int64 |\r\n| workOrderTypeOfWorkId | GetMyDefaultUserOptionsValues->WorkOrderTypeOfWorkId | integer | int64 |\r\n", "operationId": "GetMyDefaultUserOptions", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains My Identity", "schema": { "$ref": "#/definitions/GetMyDefaultUserOptionsResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/IDENTITY/Options/WM": { "get": { "tags": [ "My Identity" ], "summary": "Get a My Identity 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| applyWorkOrderStatusRules | GetMyDefaultWMUserOptionsValues->ApplyWorkOrderStatusRules | boolean | |\r\n| defaultWorkOrderTaskResourceCostElementId | GetMyDefaultWMUserOptionsValues->DefaultWorkOrderTaskResourceCostElementId | integer | int64 |\r\n| workClassification1Id | GetMyDefaultWMUserOptionsValues->WorkClassification1Id | integer | int64 |\r\n| workClassification2Id | GetMyDefaultWMUserOptionsValues->WorkClassification2Id | integer | int64 |\r\n| workClassification3Id | GetMyDefaultWMUserOptionsValues->WorkClassification3Id | integer | int64 |\r\n| workClassification4Id | GetMyDefaultWMUserOptionsValues->WorkClassification4Id | integer | int64 |\r\n| workClassification5Id | GetMyDefaultWMUserOptionsValues->WorkClassification5Id | integer | int64 |\r\n| workOrderCanBeQueued | GetMyDefaultWMUserOptionsValues->WorkOrderCanBeQueued | boolean | |\r\n| workOrderImportanceId | GetMyDefaultWMUserOptionsValues->WorkOrderImportanceId | integer | int64 |\r\n| workOrderLimit | GetMyDefaultWMUserOptionsValues->WorkOrderLimit | number | decimal |\r\n| workOrderResponsibleSectionId | GetMyDefaultWMUserOptionsValues->WorkOrderResponsibleSectionId | integer | int64 |\r\n| workOrderResponsibleStaffId | GetMyDefaultWMUserOptionsValues->WorkOrderResponsibleStaffId | integer | int64 |\r\n| workOrderResponsibleTradeId | GetMyDefaultWMUserOptionsValues->WorkOrderResponsibleTradeId | integer | int64 |\r\n| workOrderTypeOfWorkForConditionMonitoringId | GetMyDefaultWMUserOptionsValues->WorkOrderTypeOfWorkForConditionMonitoringId | integer | int64 |\r\n| workOrderTypeOfWorkId | GetMyDefaultWMUserOptionsValues->WorkOrderTypeOfWorkId | integer | int64 |\r\n", "operationId": "GetMyDefaultWMUserOptions", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains My Identity", "schema": { "$ref": "#/definitions/GetMyDefaultWMUserOptionsResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/IDENTITY/OperationalRoles/{id}/Resources/{resourceName}/{resourceActionName}/{resourceActionCustomisationId}": { "get": { "tags": [ "My Identity" ], "summary": "Get my customised User Operational Role Resource resource for the Operational Role Resource resource", "description": "", "operationId": "GetMyOperationalRoleResourceCustomisationForOperationalRole", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Operational Role Id", "format": "int64", "x-nullable": false }, { "type": "string", "name": "resourceName", "in": "path", "required": true, "description": "Name of Resource", "x-nullable": false }, { "type": "string", "name": "resourceActionName", "in": "path", "required": true, "description": "Name of Resource Action", "x-nullable": false }, { "type": "integer", "name": "resourceActionCustomisationId", "in": "path", "required": true, "description": "API Resource Action Customisation Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains My Identity", "schema": { "$ref": "#/definitions/GetMyOperationalRoleResourceCustomisationForOperationalRoleResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/IDENTITY/OperationalRoles/{id}/Resources/{resourceName}/{resourceActionName}": { "get": { "tags": [ "My Identity" ], "summary": "Get my system defined User Operational Role Resource resource for the Operational Role Resource resource", "description": "", "operationId": "GetMyOperationalRoleResourceForOperationalRole", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Operational Role Id", "format": "int64", "x-nullable": false }, { "type": "string", "name": "resourceName", "in": "path", "required": true, "description": "Name of Resource", "x-nullable": false }, { "type": "string", "name": "resourceActionName", "in": "path", "required": true, "description": "Name of Resource Action", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains My Identity", "schema": { "$ref": "#/definitions/GetMyOperationalRoleResourceForOperationalRoleResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/IDENTITY/OperationalRoles/Resources/{resourceName}/{resourceActionName}/{id}": { "get": { "tags": [ "My Identity" ], "summary": "Get my User Operational Role Resource resource.", "description": "", "operationId": "GetMyOperationalRoleResource", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "string", "name": "resourceName", "in": "path", "required": true, "description": "Name of Resource", "x-nullable": false }, { "type": "string", "name": "resourceActionName", "in": "path", "required": true, "description": "Name of Resource Action", "x-nullable": false }, { "type": "integer", "name": "id", "in": "path", "required": true, "description": "User Operational Role Resource Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains My Identity", "schema": { "$ref": "#/definitions/GetMyOperationalRoleResourceResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "My Identity" ], "summary": "Delete my User Operational Role Resource 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 | UserOperationalRoleResource->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": "DeleteMyOperationalRoleResource", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "string", "name": "resourceName", "in": "path", "required": true, "description": "Name of Resource", "x-nullable": false }, { "type": "string", "name": "resourceActionName", "in": "path", "required": true, "description": "Name of Resource Action", "x-nullable": false }, { "type": "integer", "name": "id", "in": "path", "required": true, "description": "User Operational Role Resource Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteMyOperationalRoleResourceResourceActionRequest" } } ], "responses": { "204": { "x-nullable": true, "description": "Success response - My Identity was successfully deleted" }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/IDENTITY/OperationalRoles/Templates/{templateName}/{id}": { "get": { "tags": [ "My Identity" ], "summary": "Get my User Operational Role Template resource.", "description": "", "operationId": "GetMyOperationalRoleTemplate", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "string", "name": "templateName", "in": "path", "required": true, "description": "Name of Template", "x-nullable": false }, { "type": "integer", "name": "id", "in": "path", "required": true, "description": "User Operational Role Template Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains My Identity", "schema": { "$ref": "#/definitions/GetMyOperationalRoleTemplateResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "My Identity" ], "summary": "Delete my User Operational Role Template 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 | UserOperationalRoleTemplate->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": "DeleteMyOperationalRoleTemplate", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "string", "name": "templateName", "in": "path", "required": true, "description": "Name of Template", "x-nullable": false }, { "type": "integer", "name": "id", "in": "path", "required": true, "description": "User Operational Role Template Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteMyOperationalRoleTemplateResourceActionRequest" } } ], "responses": { "204": { "x-nullable": true, "description": "Success response - My Identity was successfully deleted" }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/IDENTITY/TermsAndConditions/{id}": { "get": { "tags": [ "My Identity" ], "summary": "Get my User Terms And Conditions Version 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 | UserTermsAndConditionVersion->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | UserTermsAndConditionVersion->CreatedByUser_Code | string | |\r\n| createdByUserFullName | UserTermsAndConditionVersion->CreatedByUser_FullName | string | |\r\n| createdOn | UserTermsAndConditionVersion->CreatedOn | string | date-time |\r\n| permissionTreeId | UserTermsAndConditionVersion->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | UserTermsAndConditionVersion->PermissionTree_Code | string | |\r\n| permissionTreeDescription | UserTermsAndConditionVersion->PermissionTree_Description | string | |\r\n| id | UserTermsAndConditionVersion->Id | integer | int64 |\r\n| version | UserTermsAndConditionVersion->Version | integer | int32 |\r\n| accepted | UserTermsAndConditionVersion->Accepted | boolean | |\r\n| acceptedDate | UserTermsAndConditionVersion->AcceptedDate | string | date |\r\n| deprecated | UserTermsAndConditionVersion->Deprecated | boolean | |\r\n| termsAndConditionVersionId | UserTermsAndConditionVersion->TermsAndConditionVersion_Id | integer | int64 |\r\n| termsAndConditionVersionContentVersion | UserTermsAndConditionVersion->TermsAndConditionVersion_ContentVersion | integer | int32 |\r\n| termsAndConditionVersionLanguageId | UserTermsAndConditionVersion->TermsAndConditionVersion_Language_Id | integer | int64 |\r\n| termsAndConditionVersionLanguageCode | UserTermsAndConditionVersion->TermsAndConditionVersion_Language_Code | string | |\r\n| termsAndConditionVersionTermsAndConditionId | UserTermsAndConditionVersion->TermsAndConditionVersion_TermsAndCondition_Id | integer | int64 |\r\n| termsAndConditionVersionTermsAndConditionName | UserTermsAndConditionVersion->TermsAndConditionVersion_TermsAndCondition_Name | string | |\r\n| termsAndConditionVersionContent | UserTermsAndConditionVersion->TermsAndConditionVersion_Content | string | |\r\n| userId | UserTermsAndConditionVersion->User_Id | integer | int64 |\r\n| userCode | UserTermsAndConditionVersion->User_Code | string | |\r\n| userFullName | UserTermsAndConditionVersion->User_FullName | string | |\r\n", "operationId": "GetMyTermsAndCondition", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "User Terms And Conditions Version Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains My Identity", "schema": { "$ref": "#/definitions/GetMyTermsAndConditionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/IDENTITY": { "get": { "tags": [ "My Identity" ], "summary": "Get a summary of my User information.", "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 | MyUserSummary->Id | integer | int64 |\r\n| allowWorkOrdersWithoutAssets | MyUserSummary->AllowWorkOrdersWithoutAssets | boolean | |\r\n| applyWorkOrderStatusRules | MyUserSummary->ApplyWorkOrderStatusRules | boolean | |\r\n| autoPopulateStartOnAndCompleteByDates | MyUserSummary->AutoPopulateStartOnAndCompleteByDates | boolean | |\r\n| code | MyUserSummary->Code | string | |\r\n| contentTranslate | MyUserSummary->ContentTranslate | boolean | |\r\n| dateFormat | MyUserSummary->DateFormat | string (Allowed values: [YYYYMMDD, YYYYDDMM, DDMMYYYY, MMDDYYYY]) | enum |\r\n| dateSeparator | MyUserSummary->DateSeparator | string (Allowed values: [Slash, Dot]) | enum |\r\n| defaultAssetDevelopmentStatusApplyToChildren | MyUserSummary->DefaultAssetDevelopmentStatusApplyToChildren | boolean | |\r\n| defaultAssetTypeDevelopmentStatusApplyToChildren | MyUserSummary->DefaultAssetTypeDevelopmentStatusApplyToChildren | boolean | |\r\n| defaultAssetTypeDevelopmentStatusApplyToDescendants | MyUserSummary->DefaultAssetTypeDevelopmentStatusApplyToDescendants | boolean | |\r\n| defaultCreateSaveAction | MyUserSummary->DefaultCreateSaveAction | string (Allowed values: [SaveAndClose, SaveAndNew, SaveAndUpdate]) | enum |\r\n| defaultIsActiveApplyToChildren | MyUserSummary->DefaultIsActiveApplyToChildren | boolean | |\r\n| defaultIsActiveApplyToDescendants | MyUserSummary->DefaultIsActiveApplyToDescendants | boolean | |\r\n| defaultIsActiveApplyToDetails | MyUserSummary->DefaultIsActiveApplyToDetails | boolean | |\r\n| defaultLanguageId | MyUserSummary->DefaultLanguage_Id | integer | int64 |\r\n| defaultLanguageCode | MyUserSummary->DefaultLanguage_Code | string | |\r\n| defaultLanguageDescription | MyUserSummary->DefaultLanguage_Description | string | |\r\n| defaultSyncDevelopmentStatusApplyToChildren | MyUserSummary->DefaultSyncDevelopmentStatusApplyToChildren | boolean | |\r\n| defaultTradeLookup | MyUserSummary->DefaultTradeLookup | string (Allowed values: [AllTrades, SectionTrades]) | enum |\r\n| defaultUpdateSaveAction | MyUserSummary->DefaultUpdateSaveAction | string (Allowed values: [SaveAndClose, Save]) | enum |\r\n| enforceAssetWarranty | MyUserSummary->EnforceAssetWarranty | boolean | |\r\n| fullName | MyUserSummary->FullName | string | |\r\n| isReportUser | MyUserSummary->IsReportUser | boolean | |\r\n| mergeAllowedWorkOrderStatus | MyUserSummary->MergeAllowedWorkOrderStatus | string (Allowed values: [AwaitingApproval, Approved, AwaitingApprovalOrApproved]) | enum |\r\n| mergeTypeOfWorkOption | MyUserSummary->MergeTypeOfWorkOption | string (Allowed values: [NoRestriction, TypeOfWorkClass, TypeOfWork]) | enum |\r\n| operationalRoleRule | MyUserSummary->OperationalRoleRule | string (Allowed values: [Strict, Limited, Open]) | enum |\r\n| primaryEmail | MyUserSummary->PrimaryEmail | string | email |\r\n| reportServerReportLanguage | MyUserSummary->ReportServerReportLanguage | string | |\r\n| reportServerUILanguage | MyUserSummary->ReportServerUILanguage | string | |\r\n| reportUserName | MyUserSummary->ReportUserName | string | |\r\n| reportUserOrganizations | MyUserSummary->ReportUserOrganizations | array | array |\r\n| reportUserRoles | MyUserSummary->ReportUserRoles | array | array |\r\n| siteId | MyUserSummary->Site_Id | integer | int64 |\r\n| siteCode | MyUserSummary->Site_Code | string | |\r\n| siteDescription | MyUserSummary->Site_Description | string | |\r\n| systemDateFormat | MyUserSummary->SystemDateFormat | string (Allowed values: [YYYYMMDD, YYYYDDMM, DDMMYYYY, MMDDYYYY]) | enum |\r\n| systemDateSeparator | MyUserSummary->SystemDateSeparator | string (Allowed values: [Slash, Dot]) | enum |\r\n| systemDefaultCreateSaveAction | MyUserSummary->SystemDefaultCreateSaveAction | string (Allowed values: [SaveAndClose, SaveAndNew, SaveAndUpdate]) | enum |\r\n| systemDefaultLanguageId | MyUserSummary->SystemDefaultLanguage_Id | integer | int64 |\r\n| systemDefaultLanguageCode | MyUserSummary->SystemDefaultLanguage_Code | string | |\r\n| systemDefaultLanguageDescription | MyUserSummary->SystemDefaultLanguage_Description | string | |\r\n| systemDefaultUpdateSaveAction | MyUserSummary->SystemDefaultUpdateSaveAction | string (Allowed values: [SaveAndClose, Save]) | enum |\r\n| systemTimeFormat | MyUserSummary->SystemTimeFormat | string (Allowed values: [Clock24h, Clock12h]) | enum |\r\n| timeFormat | MyUserSummary->TimeFormat | string (Allowed values: [Clock24h, Clock12h]) | enum |\r\n| workPerformedEditableBaseStatus | MyUserSummary->WorkPerformedEditableBaseStatus | string (Allowed values: [Approved, ApprovedAndCompleted]) | enum |\r\n", "operationId": "GetMyUserSummary", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains My Identity", "schema": { "$ref": "#/definitions/GetMyUserSummaryResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "My Identity" ], "summary": "Set my user settings.", "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| dateFormat | MyUserSummary->DateFormat | string (Allowed values: [YYYYMMDD, YYYYDDMM, DDMMYYYY, MMDDYYYY]) | enum |\r\n| dateSeparator | MyUserSummary->DateSeparator | string (Allowed values: [Slash, Dot]) | enum |\r\n| timeFormat | MyUserSummary->TimeFormat | string (Allowed values: [Clock24h, Clock12h]) | enum |\r\n| defaultLanguageId | MyUserSummary->DefaultLanguage_Id | integer | int64 |\r\n| defaultCreateSaveAction | MyUserSummary->DefaultCreateSaveAction | string (Allowed values: [SaveAndClose, SaveAndNew, SaveAndUpdate]) | enum |\r\n| defaultUpdateSaveAction | MyUserSummary->DefaultUpdateSaveAction | string (Allowed values: [SaveAndClose, Save]) | enum |\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\r\n", "operationId": "UpdateMyUserSummary", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateMyUserSummaryResourceActionRequest" } }, { "$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/IDENTITY/BackgroundTasks/{id}/Errors": { "get": { "tags": [ "My Identity" ], "summary": "Get a collection of my Background Task Error resources for the Background Task.", "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 | BackgroundTaskError->Id | integer | int64 |\r\n| code | BackgroundTaskError->Code | string | |\r\n| completedOn | BackgroundTaskError->CompletedOn | string | date-time |\r\n| objectType | BackgroundTaskError->ObjectType | string (Allowed values: [Alarm, NewAlarm, AlarmExpression, AlarmExpressionTask, AlarmAttribute, AlarmDocument, AlarmType, MonitoringPoint, MonitoringPointBoundEvaluationLog, MonitoringPointParameter, MonitoringPointReading, MonitoringPointTrigger, MonitoringPointTriggerExpression, MonitoringPointTriggerExpressionAlarmType, MonitoringPointTriggerExpressionParameter, MonitoringPointTriggerExpressionEvaluation, MonitoringPointTriggerExpressionEvaluationLog, MonitoringPointType, MonitoringPointTypeParameter, MonitoringPointAttribute, MonitoringPointDocument, AuxiliaryAssetTask, AuxiliaryAssetTaskResource, AuxiliaryAssetTaskSpare, AuxiliaryAssetTaskSubTask, RegularAssetComponent, RegularAssetComponentAttribute, RegularAssetComponentDocument, RegularAssetComponentRuleEvaluationFailure, AssetComponent, AssetWarranty, PlaceholderAssetComponent, PlaceholderAssetComponentOptionValue, PlaceholderAssetComponentCondition, PlaceholderAssetMeter, PlaceholderAssetComponentRuleEvaluationFailure, RegularAssetCondition, RegularAssetActiveCondition, AssetFmeca, RegularAssetOptionValue, Asset, RegularAssetAttribute, RegularAssetDocument, RegularAssetFileAttachment, PlaceholderAsset, PlaceholderAssetAttribute, PlaceholderAssetDocument, PlaceholderAssetFileAttachment, PlaceholderAssetRuleEvaluationFailure, PlaceholderAssetResponsibility, PlaceholderAssetCondition, PlaceholderAssetActiveCondition, AssetTask, SetAssetTaskSpareWarehouseEntity, RegularAssetTask, RegularAssetTaskRuleEvaluationFailure, RegularAssetTaskAttribute, RegularAssetTaskAuxiliaryTask, RegularAssetTaskFollowUpTask, RegularAssetTaskFollowUpTaskExpression, RegularAssetTaskSuppressedTask, RegularAssetTaskResource, RegularAssetTaskResourceRuleEvaluationFailure, RegularAssetTaskSpare, RegularAssetTaskSpareRuleEvaluationFailure, RegularAssetTaskSubTask, RegularAssetTaskFileAttachment, AuxiliaryAssetTypeTask, AuxiliaryAssetTypeTaskResource, AuxiliaryAssetTypeTaskSpare, AuxiliaryAssetTypeTaskSubTask, RegularAssetTypeComponent, RegularAssetTypeComponentAttribute, RegularAssetTypeComponentDocument, AssetTypeComponent, PlaceholderAssetTypeComponent, PlaceholderAssetTypeComponentCondition, PlaceholderAssetTypeComponentAttribute, PlaceholderAssetTypeComponentDocument, PlaceholderAssetTypeComponentRuleLink, RegularAssetTypeComponentRuleLink, PlaceholderAssetComponentAttribute, PlaceholderAssetComponentDocument, PlaceholderAssetComponentActiveCondition, AssetTypeFmeca, AssetTypeFunction, AssetFunction, AssetFmecaTask, AssetTypeFmecaTask, AssetTypeFolder, RegularAssetTypeOption, AssetType, PlaceholderAssetType, PlaceholderAssetTypeSpare, PlaceholderAssetTypeAttribute, PlaceholderAssetTypeDocument, PlaceholderAssetTypeResponsibility, PlaceholderAssetTypeRuleLink, RegularAssetTypeTask, RegularAssetTypeTaskAttribute, RegularAssetTypeTaskAuxiliaryTask, RegularAssetTypeTaskCondition, RegularAssetTypeTaskDocument, RegularAssetTypeTaskFollowUpTask, RegularAssetTypeTaskFollowUpTaskExpression, AssetTypeTask, AssetTypeTaskResource, AssetTaskResource, AssetTaskSpare, AssetTypeTaskSpare, RegularAssetTypeTaskResource, RegularAssetTypeTaskRuleLink, RegularAssetTypeTaskSpare, RegularAssetTypeTaskSubTask, RegularAssetTypeTaskSuppressedTask, Condition, ConditionType, Event, FailureCause, FailureCauseType, FailureMechanism, FailureMechanismType, FailureMode, FailureModeType, InPlaceAssetMeter, InPlaceAssetAttribute, InPlaceAssetFileAttachment, InPlaceAssetRuleEvaluationFailure, InPlaceAssetResponsibility, InPlaceAssetSpare, InPlaceAssetType, InPlaceAssetTypeResponsibility, InPlaceAssetTypeRuleLink, InPlaceAssetTypeSpare, InPlaceAsset, Option, OptionCategory, RegularAsset, RegularAssetTaskDocument, RegularAssetMeter, RegularAssetResponsibility, RegularAssetMonitoringPointTrigger, RegularAssetSpare, RegularAssetTaskCondition, RegularAssetType, RegularAssetTypeAttribute, RegularAssetTypeDocument, RegularAssetTypeCondition, PlaceholderAssetTypeCondition, RegularAssetTypeRule, RegularAssetTypeResponsibility, RegularAssetTypeMonitoringPointTrigger, RegularAssetTypeSpare, RepairType, Rule, RuleCategory, RuleOption, StandardTask, StandardTaskSpare, StandardTaskSubTask, StandardTaskResource, StandardTaskAttribute, StandardTaskDocument, TaskImportance, TaskInterval, TaskIntervalType, TaskRollUpPoint, TypeOfWork, RegularAssetTypeTaskSpareRuleLink, InPlaceAssetTypeAttribute, RegularAssetTypeTaskResourceRuleLink, PlaceholderAssetSpare, RegularAssetMonitoringPointTriggerParameter, AssetSpare, AssetTypeSpare, AssetMeter, AssetConsumption, RegularAssetConsumption, PlaceholderAssetConsumption, InPlaceAssetConsumption, WarrantyType, RegularAssetTypeFileAttachment, Meter, MeterAttribute, MeterDocument, MeterReading, PredictedMeterReading, TimeLossCategory, TimeLossReason, TimeLossType, Consumable, AcquisitionStatus, AcquisitionType, DocumentFolder, DocumentRecord, DocumentRecordAttribute, FileAttachment, FileAttachmentCategory, FileAttachmentContentHistory, DocumentRecordFileHistory, Costing, CostingBudget, CostCentre, CostCentreAttribute, CostCentreDocument, CostCentreType, CostElement, CostElementAttribute, CostElementDocument, Currency, BudgetTemplate, BudgetTemplateParameter, FinancialYear, FinancialYearPeriod, GeneralLedger, GeneralLedgerAttribute, GeneralLedgerDocument, CurrencyRate, Budget, BudgetParameter, AddressType, Approval, Attribute, AttributeAllowedValue, Calendar, CalendarDay, CalendarException, CalendarDayHour, Classification, ClassificationAllowedValue, EmailType, Language, OperationalRole, OperationalRoleTemplate, OperationalRoleResource, PhoneNumberType, UserOperationalRole, UserOperationalRoleTemplate, UserOperationalRoleResource, TermsAndCondition, TermsAndConditionVersion, TermsAndConditionOperationalRole, UserTermsAndConditionVersion, Location, LocationAttribute, LocationDocument, LocalisationSet, LocalisationKey, LocalisationTranslation, Phrase, PhraseTranslation, PreconfiguredReason, Site, SiteAttribute, SiteDocument, SiteType, Supplier, SupplierFileAttachment, SupplierAttribute, SupplierDocument, SupplierContactAddress, SupplierContactEmail, SupplierContactPhoneNumber, SupplierResource, SupplierTaxRate, UnitOfMeasurement, SiteResource, SiteContactAddress, SiteContactEmail, SiteContactPhoneNumber, ChangeDataTrigger, ChangeDataTriggerOccurrenceLog, ChangeDataTriggerCriteria, NotificationTemplate, ChangeDataTriggerCriteriaParameter, ChangeDataTriggerNotificationEvent, NotificationTemplateParameter, ChangeDataTriggerNotificationEventAttachment, ChangeDataTriggerNotificationEventAttachmentParameter, RequestType, Category, Commodity, MaterialMaster, MaterialMasterAttribute, MaterialMasterDocument, MaterialMasterBin, MaterialMasterSupplier, MaterialMasterLinkWarehouse, StockItem, StockItemFileAttachment, StockItemAttribute, StockItemDocument, StockItemBin, StockItemSupplier, WarehouseAttribute, Warehouse, WarehouseDocument, Requisition, RequisitionFileAttachment, RequisitionStatus, RequisitionStatusChange, RequisitionStatusAttribute, RequisitionStatusDocument, RequisitionStatusChangeHistory, RequisitionItemTransaction, ApprovalRole, RequisitionAttribute, RequisitionDocument, RequisitionTransaction, RequisitionItem, RequisitionItemFileAttachment, UserSiteApprovalRole, ApprovalWorkflow, ApprovalWorkflowExpression, ApprovalWorkflowExpressionApprovalRole, Competency, Resource, ResourceAttribute, ResourceAddress, ResourceClassification, ResourceCompetency, ResourceDocument, ResourceEmail, ResourcePhoneNumber, ResourceTrade, ResourceTradeCompetency, ResourceTradeFinancialRate, Section, SectionAttribute, SectionDocument, SectionTrade, TradeAttribute, TradeDocument, Trade, TradeCompetency, TradeFinancialRate, ResourceContext, ResourceFileAttachment, AssetImportance, RiskConsequence, RiskConsequenceCategory, RiskModel, RiskModelConsequenceCategory, RiskModelImportance, RiskModelProbability, RiskProbability, WorkOrderImportance, WorkOrderStatus, WorkOrderStatusAttribute, WorkOrderStatusDocument, WorkOrderStatusAllowedChange, WorkOrder, WorkOrderStatusChangeHistory, WorkOrderStatusChange, WorkOrderMerge, WorkOrderSplit, WorkOrderMeter, WorkOrderAttribute, WorkOrderDocument, WorkOrderFileAttachment, WorkOrderTaskFileAttachment, WorkOrderTaskWarranty, WorkOrderTaskSpareFileAttachment, WorkOrderTask, WorkOrderTaskDocument, WorkOrderTaskAdHocCost, WorkOrderMonitoringPoint, WorkOrderTaskMonitoringPoint, WorkOrderTaskSpare, WorkOrderTaskSubTask, WorkOrderTaskResource, WorkOrderTaskResourceUsage, DueTask, DueTaskSuppressor, ProposedWorkOrderBatch, ProposedWorkOrder, ProposedWorkOrderTask, ProposedWorkOrderMeter, WorkOrderMovement, WorkOrderTaskMovement, WorkOrderTaskResourceMovement, WorkOrderTaskSpareMovement, WorkOrderTaskSubTaskMovement, WorkOrderCompleteAllTasksLog, WorkRequest, WorkRequestAttribute, WorkRequestDocument, WorkRequestStatus, WorkRequestStatusChange, WorkRequestStatusChangeHistory, WorkRequestFileAttachment, WorkOrderDowntimeLoss, WorkOrderProgressEvent, WorkOrderProgressEventAllowedChange, WorkOrderProgressLog, WorkOrderWarranty, ServiceLevelAgreementClassification, ServiceLevelAgreement, ServiceLevelAgreementMeasure, WorkOrderServiceLevelAgreement, WorkOrderServiceLevelAgreementMeasure, ServiceLevelAgreementMeasureTrigger, ServiceLevelAgreementMeasureFieldAssignment, PermissionTree, User, UserAttribute, UserDocument, UserAuthentication, SecurityRole, SecurityRolePermission, UserSecurityRole, UserCustomPermission, UserOption, BackgroundTask, BackgroundTaskStep, ScheduledBackgroundTask, ScheduledJob, UserDefinedField, UserDefinedFieldPredefinedValue, SystemOption, SystemOptionPageLimit, SystemOptionWorkOrderStatus, SystemOptionDefaultStandardTask, SystemOptionWorkOrderStatusTypeOfWork, SystemOptionReferenceDataViewPermission, SystemOptionFileAttachmentCategory, SystemOptionFileAttachmentFileType, RecordChange, RecordChangeValue, RecordChangeUser, RecordChangeProperty, NotificationEventOutbox, NotificationEventAttachmentOutbox, NotificationOutbox, NotificationOutboxLog, ChangeDataTriggerCriteriaEvaluation, SystemOptionReportServerEntity, SystemOptionReportServerEntityDefaultReport, TemplateMigrationLog, TemplateMigrationLogIntent, ResourceActionMigrationLog, ImportSchema, ImportFile, UserDefinedQuery, ResourceActionCustomisation, TemplateCustomisation, TemplateResource, ClusterSettings, ClusterIdentityProviderSettings, MessageBrokerHost, MessageBrokerTopic, MessageBrokerTopicConsumer, TenantSettings, TenantChangeDataSubscriptionSettings, TenantIdentityProviderSettings, TenantJobSettings, TenantFileContentStoreLocationSettings, TenantFileContentStoreFileTypeGroupSettings, TenantFileContentStoreFileTypeSettings, ClusterFeatureToggle, TenantFeatureToggle, TenantHealthCheck, TenantMachineHealthCheck, ClusterHealthCheck, ClusterMachineHealthCheck, ClusterCapacitySlot, TenantChangeLogCleanupExpressionSettings, ClusterJobSettings, Ignore]) | enum |\r\n| message | BackgroundTaskError->Message | string | memo |\r\n| type | BackgroundTaskError->Type | string | |\r\n| objectId | BackgroundTaskError->ObjectId | integer | int64 |\r\n| sequenceNumber | BackgroundTaskError->SequenceNumber | integer | int32 |\r\n| severity | BackgroundTaskError->Severity | string | |\r\n| startedOn | BackgroundTaskError->StartedOn | string | date-time |\r\n| createdByUserId | BackgroundTaskError->CreatedByUserId | integer | int64 |\r\n", "operationId": "GetMyBackgroundTaskErrorList", "produces": [ "application/vnd.onkey.entitycollection+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Background Task Id", "format": "int64", "x-nullable": false } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains My Identity collection", "schema": { "$ref": "#/definitions/GetMyBackgroundTaskErrorListResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/IDENTITY/Approvals/Requisitions": { "get": { "tags": [ "My Identity" ], "summary": "Get a collection of my My Identity 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 | Requisition->Id | integer | int64 |\r\n| version | Requisition->Version | integer | int32 |\r\n| code | Requisition->Code | string | |\r\n| workOrderCode | Requisition->WorkOrder_Code | string | |\r\n| workOrderDescription | Requisition->WorkOrder_Description | string | |\r\n| totalItemCost | Requisition->TotalItemCost | number | decimal |\r\n| idApprovalEntityIdEntityId | Requisition->*Id.Approval.EntityId_EntityId | integer | int64 |\r\n| idApprovalEntityIdSequenceNumber | Requisition->*Id.Approval.EntityId_SequenceNumber | integer | int32 |\r\n| idApprovalEntityIdExpressionId | Requisition->*Id.Approval.EntityId_Expression_Id | integer | int64 |\r\n| idApprovalEntityIdExpressionApprovalWorkflowId | Requisition->*Id.Approval.EntityId_Expression_ApprovalWorkflow_Id | integer | int64 |\r\n| idApprovalEntityIdExpressionApprovalWorkflowCode | Requisition->*Id.Approval.EntityId_Expression_ApprovalWorkflow_Code | string | |\r\n| idApprovalEntityIdExpressionDescription | Requisition->*Id.Approval.EntityId_Expression_Description | string | |\r\n| idApprovalEntityIdId | Requisition->*Id.Approval.EntityId_Id | integer | int64 |\r\n| idApprovalEntityIdIsLocked | Requisition->*Id.Approval.EntityId_IsLocked | boolean | |\r\n| idApprovalEntityIdEntityType | Requisition->*Id.Approval.EntityId_EntityType | string (Allowed values: [Alarm, NewAlarm, AlarmExpression, AlarmExpressionTask, AlarmAttribute, AlarmDocument, AlarmType, MonitoringPoint, MonitoringPointBoundEvaluationLog, MonitoringPointParameter, MonitoringPointReading, MonitoringPointTrigger, MonitoringPointTriggerExpression, MonitoringPointTriggerExpressionAlarmType, MonitoringPointTriggerExpressionParameter, MonitoringPointTriggerExpressionEvaluation, MonitoringPointTriggerExpressionEvaluationLog, MonitoringPointType, MonitoringPointTypeParameter, MonitoringPointAttribute, MonitoringPointDocument, AuxiliaryAssetTask, AuxiliaryAssetTaskResource, AuxiliaryAssetTaskSpare, AuxiliaryAssetTaskSubTask, RegularAssetComponent, RegularAssetComponentAttribute, RegularAssetComponentDocument, RegularAssetComponentRuleEvaluationFailure, AssetComponent, AssetWarranty, PlaceholderAssetComponent, PlaceholderAssetComponentOptionValue, PlaceholderAssetComponentCondition, PlaceholderAssetMeter, PlaceholderAssetComponentRuleEvaluationFailure, RegularAssetCondition, RegularAssetActiveCondition, AssetFmeca, RegularAssetOptionValue, Asset, RegularAssetAttribute, RegularAssetDocument, RegularAssetFileAttachment, PlaceholderAsset, PlaceholderAssetAttribute, PlaceholderAssetDocument, PlaceholderAssetFileAttachment, PlaceholderAssetRuleEvaluationFailure, PlaceholderAssetResponsibility, PlaceholderAssetCondition, PlaceholderAssetActiveCondition, AssetTask, SetAssetTaskSpareWarehouseEntity, RegularAssetTask, RegularAssetTaskRuleEvaluationFailure, RegularAssetTaskAttribute, RegularAssetTaskAuxiliaryTask, RegularAssetTaskFollowUpTask, RegularAssetTaskFollowUpTaskExpression, RegularAssetTaskSuppressedTask, RegularAssetTaskResource, RegularAssetTaskResourceRuleEvaluationFailure, RegularAssetTaskSpare, RegularAssetTaskSpareRuleEvaluationFailure, RegularAssetTaskSubTask, RegularAssetTaskFileAttachment, AuxiliaryAssetTypeTask, AuxiliaryAssetTypeTaskResource, AuxiliaryAssetTypeTaskSpare, AuxiliaryAssetTypeTaskSubTask, RegularAssetTypeComponent, RegularAssetTypeComponentAttribute, RegularAssetTypeComponentDocument, AssetTypeComponent, PlaceholderAssetTypeComponent, PlaceholderAssetTypeComponentCondition, PlaceholderAssetTypeComponentAttribute, PlaceholderAssetTypeComponentDocument, PlaceholderAssetTypeComponentRuleLink, RegularAssetTypeComponentRuleLink, PlaceholderAssetComponentAttribute, PlaceholderAssetComponentDocument, PlaceholderAssetComponentActiveCondition, AssetTypeFmeca, AssetTypeFunction, AssetFunction, AssetFmecaTask, AssetTypeFmecaTask, AssetTypeFolder, RegularAssetTypeOption, AssetType, PlaceholderAssetType, PlaceholderAssetTypeSpare, PlaceholderAssetTypeAttribute, PlaceholderAssetTypeDocument, PlaceholderAssetTypeResponsibility, PlaceholderAssetTypeRuleLink, RegularAssetTypeTask, RegularAssetTypeTaskAttribute, RegularAssetTypeTaskAuxiliaryTask, RegularAssetTypeTaskCondition, RegularAssetTypeTaskDocument, RegularAssetTypeTaskFollowUpTask, RegularAssetTypeTaskFollowUpTaskExpression, AssetTypeTask, AssetTypeTaskResource, AssetTaskResource, AssetTaskSpare, AssetTypeTaskSpare, RegularAssetTypeTaskResource, RegularAssetTypeTaskRuleLink, RegularAssetTypeTaskSpare, RegularAssetTypeTaskSubTask, RegularAssetTypeTaskSuppressedTask, Condition, ConditionType, Event, FailureCause, FailureCauseType, FailureMechanism, FailureMechanismType, FailureMode, FailureModeType, InPlaceAssetMeter, InPlaceAssetAttribute, InPlaceAssetFileAttachment, InPlaceAssetRuleEvaluationFailure, InPlaceAssetResponsibility, InPlaceAssetSpare, InPlaceAssetType, InPlaceAssetTypeResponsibility, InPlaceAssetTypeRuleLink, InPlaceAssetTypeSpare, InPlaceAsset, Option, OptionCategory, RegularAsset, RegularAssetTaskDocument, RegularAssetMeter, RegularAssetResponsibility, RegularAssetMonitoringPointTrigger, RegularAssetSpare, RegularAssetTaskCondition, RegularAssetType, RegularAssetTypeAttribute, RegularAssetTypeDocument, RegularAssetTypeCondition, PlaceholderAssetTypeCondition, RegularAssetTypeRule, RegularAssetTypeResponsibility, RegularAssetTypeMonitoringPointTrigger, RegularAssetTypeSpare, RepairType, Rule, RuleCategory, RuleOption, StandardTask, StandardTaskSpare, StandardTaskSubTask, StandardTaskResource, StandardTaskAttribute, StandardTaskDocument, TaskImportance, TaskInterval, TaskIntervalType, TaskRollUpPoint, TypeOfWork, RegularAssetTypeTaskSpareRuleLink, InPlaceAssetTypeAttribute, RegularAssetTypeTaskResourceRuleLink, PlaceholderAssetSpare, RegularAssetMonitoringPointTriggerParameter, AssetSpare, AssetTypeSpare, AssetMeter, AssetConsumption, RegularAssetConsumption, PlaceholderAssetConsumption, InPlaceAssetConsumption, WarrantyType, RegularAssetTypeFileAttachment, Meter, MeterAttribute, MeterDocument, MeterReading, PredictedMeterReading, TimeLossCategory, TimeLossReason, TimeLossType, Consumable, AcquisitionStatus, AcquisitionType, DocumentFolder, DocumentRecord, DocumentRecordAttribute, FileAttachment, FileAttachmentCategory, FileAttachmentContentHistory, DocumentRecordFileHistory, Costing, CostingBudget, CostCentre, CostCentreAttribute, CostCentreDocument, CostCentreType, CostElement, CostElementAttribute, CostElementDocument, Currency, BudgetTemplate, BudgetTemplateParameter, FinancialYear, FinancialYearPeriod, GeneralLedger, GeneralLedgerAttribute, GeneralLedgerDocument, CurrencyRate, Budget, BudgetParameter, AddressType, Approval, Attribute, AttributeAllowedValue, Calendar, CalendarDay, CalendarException, CalendarDayHour, Classification, ClassificationAllowedValue, EmailType, Language, OperationalRole, OperationalRoleTemplate, OperationalRoleResource, PhoneNumberType, UserOperationalRole, UserOperationalRoleTemplate, UserOperationalRoleResource, TermsAndCondition, TermsAndConditionVersion, TermsAndConditionOperationalRole, UserTermsAndConditionVersion, Location, LocationAttribute, LocationDocument, LocalisationSet, LocalisationKey, LocalisationTranslation, Phrase, PhraseTranslation, PreconfiguredReason, Site, SiteAttribute, SiteDocument, SiteType, Supplier, SupplierFileAttachment, SupplierAttribute, SupplierDocument, SupplierContactAddress, SupplierContactEmail, SupplierContactPhoneNumber, SupplierResource, SupplierTaxRate, UnitOfMeasurement, SiteResource, SiteContactAddress, SiteContactEmail, SiteContactPhoneNumber, ChangeDataTrigger, ChangeDataTriggerOccurrenceLog, ChangeDataTriggerCriteria, NotificationTemplate, ChangeDataTriggerCriteriaParameter, ChangeDataTriggerNotificationEvent, NotificationTemplateParameter, ChangeDataTriggerNotificationEventAttachment, ChangeDataTriggerNotificationEventAttachmentParameter, RequestType, Category, Commodity, MaterialMaster, MaterialMasterAttribute, MaterialMasterDocument, MaterialMasterBin, MaterialMasterSupplier, MaterialMasterLinkWarehouse, StockItem, StockItemFileAttachment, StockItemAttribute, StockItemDocument, StockItemBin, StockItemSupplier, WarehouseAttribute, Warehouse, WarehouseDocument, Requisition, RequisitionFileAttachment, RequisitionStatus, RequisitionStatusChange, RequisitionStatusAttribute, RequisitionStatusDocument, RequisitionStatusChangeHistory, RequisitionItemTransaction, ApprovalRole, RequisitionAttribute, RequisitionDocument, RequisitionTransaction, RequisitionItem, RequisitionItemFileAttachment, UserSiteApprovalRole, ApprovalWorkflow, ApprovalWorkflowExpression, ApprovalWorkflowExpressionApprovalRole, Competency, Resource, ResourceAttribute, ResourceAddress, ResourceClassification, ResourceCompetency, ResourceDocument, ResourceEmail, ResourcePhoneNumber, ResourceTrade, ResourceTradeCompetency, ResourceTradeFinancialRate, Section, SectionAttribute, SectionDocument, SectionTrade, TradeAttribute, TradeDocument, Trade, TradeCompetency, TradeFinancialRate, ResourceContext, ResourceFileAttachment, AssetImportance, RiskConsequence, RiskConsequenceCategory, RiskModel, RiskModelConsequenceCategory, RiskModelImportance, RiskModelProbability, RiskProbability, WorkOrderImportance, WorkOrderStatus, WorkOrderStatusAttribute, WorkOrderStatusDocument, WorkOrderStatusAllowedChange, WorkOrder, WorkOrderStatusChangeHistory, WorkOrderStatusChange, WorkOrderMerge, WorkOrderSplit, WorkOrderMeter, WorkOrderAttribute, WorkOrderDocument, WorkOrderFileAttachment, WorkOrderTaskFileAttachment, WorkOrderTaskWarranty, WorkOrderTaskSpareFileAttachment, WorkOrderTask, WorkOrderTaskDocument, WorkOrderTaskAdHocCost, WorkOrderMonitoringPoint, WorkOrderTaskMonitoringPoint, WorkOrderTaskSpare, WorkOrderTaskSubTask, WorkOrderTaskResource, WorkOrderTaskResourceUsage, DueTask, DueTaskSuppressor, ProposedWorkOrderBatch, ProposedWorkOrder, ProposedWorkOrderTask, ProposedWorkOrderMeter, WorkOrderMovement, WorkOrderTaskMovement, WorkOrderTaskResourceMovement, WorkOrderTaskSpareMovement, WorkOrderTaskSubTaskMovement, WorkOrderCompleteAllTasksLog, WorkRequest, WorkRequestAttribute, WorkRequestDocument, WorkRequestStatus, WorkRequestStatusChange, WorkRequestStatusChangeHistory, WorkRequestFileAttachment, WorkOrderDowntimeLoss, WorkOrderProgressEvent, WorkOrderProgressEventAllowedChange, WorkOrderProgressLog, WorkOrderWarranty, ServiceLevelAgreementClassification, ServiceLevelAgreement, ServiceLevelAgreementMeasure, WorkOrderServiceLevelAgreement, WorkOrderServiceLevelAgreementMeasure, ServiceLevelAgreementMeasureTrigger, ServiceLevelAgreementMeasureFieldAssignment, PermissionTree, User, UserAttribute, UserDocument, UserAuthentication, SecurityRole, SecurityRolePermission, UserSecurityRole, UserCustomPermission, UserOption, BackgroundTask, BackgroundTaskStep, ScheduledBackgroundTask, ScheduledJob, UserDefinedField, UserDefinedFieldPredefinedValue, SystemOption, SystemOptionPageLimit, SystemOptionWorkOrderStatus, SystemOptionDefaultStandardTask, SystemOptionWorkOrderStatusTypeOfWork, SystemOptionReferenceDataViewPermission, SystemOptionFileAttachmentCategory, SystemOptionFileAttachmentFileType, RecordChange, RecordChangeValue, RecordChangeUser, RecordChangeProperty, NotificationEventOutbox, NotificationEventAttachmentOutbox, NotificationOutbox, NotificationOutboxLog, ChangeDataTriggerCriteriaEvaluation, SystemOptionReportServerEntity, SystemOptionReportServerEntityDefaultReport, TemplateMigrationLog, TemplateMigrationLogIntent, ResourceActionMigrationLog, ImportSchema, ImportFile, UserDefinedQuery, ResourceActionCustomisation, TemplateCustomisation, TemplateResource, ClusterSettings, ClusterIdentityProviderSettings, MessageBrokerHost, MessageBrokerTopic, MessageBrokerTopicConsumer, TenantSettings, TenantChangeDataSubscriptionSettings, TenantIdentityProviderSettings, TenantJobSettings, TenantFileContentStoreLocationSettings, TenantFileContentStoreFileTypeGroupSettings, TenantFileContentStoreFileTypeSettings, ClusterFeatureToggle, TenantFeatureToggle, TenantHealthCheck, TenantMachineHealthCheck, ClusterHealthCheck, ClusterMachineHealthCheck, ClusterCapacitySlot, TenantChangeLogCleanupExpressionSettings, ClusterJobSettings, Ignore]) | enum |\r\n| idApprovalEntityIdRemark | Requisition->*Id.Approval.EntityId_Remark | string | |\r\n| idApprovalEntityIdRoleId | Requisition->*Id.Approval.EntityId_Role_Id | integer | int64 |\r\n| idApprovalEntityIdRoleCode | Requisition->*Id.Approval.EntityId_Role_Code | string | |\r\n| idApprovalEntityIdRoleDescription | Requisition->*Id.Approval.EntityId_Role_Description | string | |\r\n| idApprovalEntityIdStatus | Requisition->*Id.Approval.EntityId_Status | string (Allowed values: [AwaitingApproval, Approved, Rejected, RoleCountReached]) | enum |\r\n", "operationId": "GetMyApprovalForRequisitionCollection", "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 My Identity collection", "schema": { "$ref": "#/definitions/GetMyApprovalForRequisitionCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/IDENTITY/Approvals/Requisitions/Items": { "get": { "tags": [ "My Identity" ], "summary": "Get a collection of my My Identity 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 | RequisitionItem->Id | integer | int64 |\r\n| code | RequisitionItem->Code | string | |\r\n| description | RequisitionItem->Description | string | |\r\n| version | RequisitionItem->Version | integer | int32 |\r\n| requisitionId | RequisitionItem->Requisition_Id | integer | int64 |\r\n| requisitionCode | RequisitionItem->Requisition_Code | string | |\r\n| requisitionWorkOrderCode | RequisitionItem->Requisition_WorkOrder_Code | string | |\r\n| requisitionWorkOrderDescription | RequisitionItem->Requisition_WorkOrder_Description | string | |\r\n| totalCostInSiteCurrency | RequisitionItem->TotalCostInSiteCurrency | number | decimal |\r\n| workOrderTaskSpareSpareType | RequisitionItem->WorkOrderTaskSpare_SpareType | string (Allowed values: [StockItem, CodedNonStockItem, DirectPurchase, Contractor]) | enum |\r\n| idApprovalEntityIdEntityId | RequisitionItem->*Id.Approval.EntityId_EntityId | integer | int64 |\r\n| idApprovalEntityIdSequenceNumber | RequisitionItem->*Id.Approval.EntityId_SequenceNumber | integer | int32 |\r\n| idApprovalEntityIdExpressionId | RequisitionItem->*Id.Approval.EntityId_Expression_Id | integer | int64 |\r\n| idApprovalEntityIdExpressionApprovalWorkflowId | RequisitionItem->*Id.Approval.EntityId_Expression_ApprovalWorkflow_Id | integer | int64 |\r\n| idApprovalEntityIdExpressionApprovalWorkflowCode | RequisitionItem->*Id.Approval.EntityId_Expression_ApprovalWorkflow_Code | string | |\r\n| idApprovalEntityIdExpressionDescription | RequisitionItem->*Id.Approval.EntityId_Expression_Description | string | |\r\n| idApprovalEntityIdId | RequisitionItem->*Id.Approval.EntityId_Id | integer | int64 |\r\n| idApprovalEntityIdIsLocked | RequisitionItem->*Id.Approval.EntityId_IsLocked | boolean | |\r\n| idApprovalEntityIdEntityType | RequisitionItem->*Id.Approval.EntityId_EntityType | string (Allowed values: [Alarm, NewAlarm, AlarmExpression, AlarmExpressionTask, AlarmAttribute, AlarmDocument, AlarmType, MonitoringPoint, MonitoringPointBoundEvaluationLog, MonitoringPointParameter, MonitoringPointReading, MonitoringPointTrigger, MonitoringPointTriggerExpression, MonitoringPointTriggerExpressionAlarmType, MonitoringPointTriggerExpressionParameter, MonitoringPointTriggerExpressionEvaluation, MonitoringPointTriggerExpressionEvaluationLog, MonitoringPointType, MonitoringPointTypeParameter, MonitoringPointAttribute, MonitoringPointDocument, AuxiliaryAssetTask, AuxiliaryAssetTaskResource, AuxiliaryAssetTaskSpare, AuxiliaryAssetTaskSubTask, RegularAssetComponent, RegularAssetComponentAttribute, RegularAssetComponentDocument, RegularAssetComponentRuleEvaluationFailure, AssetComponent, AssetWarranty, PlaceholderAssetComponent, PlaceholderAssetComponentOptionValue, PlaceholderAssetComponentCondition, PlaceholderAssetMeter, PlaceholderAssetComponentRuleEvaluationFailure, RegularAssetCondition, RegularAssetActiveCondition, AssetFmeca, RegularAssetOptionValue, Asset, RegularAssetAttribute, RegularAssetDocument, RegularAssetFileAttachment, PlaceholderAsset, PlaceholderAssetAttribute, PlaceholderAssetDocument, PlaceholderAssetFileAttachment, PlaceholderAssetRuleEvaluationFailure, PlaceholderAssetResponsibility, PlaceholderAssetCondition, PlaceholderAssetActiveCondition, AssetTask, SetAssetTaskSpareWarehouseEntity, RegularAssetTask, RegularAssetTaskRuleEvaluationFailure, RegularAssetTaskAttribute, RegularAssetTaskAuxiliaryTask, RegularAssetTaskFollowUpTask, RegularAssetTaskFollowUpTaskExpression, RegularAssetTaskSuppressedTask, RegularAssetTaskResource, RegularAssetTaskResourceRuleEvaluationFailure, RegularAssetTaskSpare, RegularAssetTaskSpareRuleEvaluationFailure, RegularAssetTaskSubTask, RegularAssetTaskFileAttachment, AuxiliaryAssetTypeTask, AuxiliaryAssetTypeTaskResource, AuxiliaryAssetTypeTaskSpare, AuxiliaryAssetTypeTaskSubTask, RegularAssetTypeComponent, RegularAssetTypeComponentAttribute, RegularAssetTypeComponentDocument, AssetTypeComponent, PlaceholderAssetTypeComponent, PlaceholderAssetTypeComponentCondition, PlaceholderAssetTypeComponentAttribute, PlaceholderAssetTypeComponentDocument, PlaceholderAssetTypeComponentRuleLink, RegularAssetTypeComponentRuleLink, PlaceholderAssetComponentAttribute, PlaceholderAssetComponentDocument, PlaceholderAssetComponentActiveCondition, AssetTypeFmeca, AssetTypeFunction, AssetFunction, AssetFmecaTask, AssetTypeFmecaTask, AssetTypeFolder, RegularAssetTypeOption, AssetType, PlaceholderAssetType, PlaceholderAssetTypeSpare, PlaceholderAssetTypeAttribute, PlaceholderAssetTypeDocument, PlaceholderAssetTypeResponsibility, PlaceholderAssetTypeRuleLink, RegularAssetTypeTask, RegularAssetTypeTaskAttribute, RegularAssetTypeTaskAuxiliaryTask, RegularAssetTypeTaskCondition, RegularAssetTypeTaskDocument, RegularAssetTypeTaskFollowUpTask, RegularAssetTypeTaskFollowUpTaskExpression, AssetTypeTask, AssetTypeTaskResource, AssetTaskResource, AssetTaskSpare, AssetTypeTaskSpare, RegularAssetTypeTaskResource, RegularAssetTypeTaskRuleLink, RegularAssetTypeTaskSpare, RegularAssetTypeTaskSubTask, RegularAssetTypeTaskSuppressedTask, Condition, ConditionType, Event, FailureCause, FailureCauseType, FailureMechanism, FailureMechanismType, FailureMode, FailureModeType, InPlaceAssetMeter, InPlaceAssetAttribute, InPlaceAssetFileAttachment, InPlaceAssetRuleEvaluationFailure, InPlaceAssetResponsibility, InPlaceAssetSpare, InPlaceAssetType, InPlaceAssetTypeResponsibility, InPlaceAssetTypeRuleLink, InPlaceAssetTypeSpare, InPlaceAsset, Option, OptionCategory, RegularAsset, RegularAssetTaskDocument, RegularAssetMeter, RegularAssetResponsibility, RegularAssetMonitoringPointTrigger, RegularAssetSpare, RegularAssetTaskCondition, RegularAssetType, RegularAssetTypeAttribute, RegularAssetTypeDocument, RegularAssetTypeCondition, PlaceholderAssetTypeCondition, RegularAssetTypeRule, RegularAssetTypeResponsibility, RegularAssetTypeMonitoringPointTrigger, RegularAssetTypeSpare, RepairType, Rule, RuleCategory, RuleOption, StandardTask, StandardTaskSpare, StandardTaskSubTask, StandardTaskResource, StandardTaskAttribute, StandardTaskDocument, TaskImportance, TaskInterval, TaskIntervalType, TaskRollUpPoint, TypeOfWork, RegularAssetTypeTaskSpareRuleLink, InPlaceAssetTypeAttribute, RegularAssetTypeTaskResourceRuleLink, PlaceholderAssetSpare, RegularAssetMonitoringPointTriggerParameter, AssetSpare, AssetTypeSpare, AssetMeter, AssetConsumption, RegularAssetConsumption, PlaceholderAssetConsumption, InPlaceAssetConsumption, WarrantyType, RegularAssetTypeFileAttachment, Meter, MeterAttribute, MeterDocument, MeterReading, PredictedMeterReading, TimeLossCategory, TimeLossReason, TimeLossType, Consumable, AcquisitionStatus, AcquisitionType, DocumentFolder, DocumentRecord, DocumentRecordAttribute, FileAttachment, FileAttachmentCategory, FileAttachmentContentHistory, DocumentRecordFileHistory, Costing, CostingBudget, CostCentre, CostCentreAttribute, CostCentreDocument, CostCentreType, CostElement, CostElementAttribute, CostElementDocument, Currency, BudgetTemplate, BudgetTemplateParameter, FinancialYear, FinancialYearPeriod, GeneralLedger, GeneralLedgerAttribute, GeneralLedgerDocument, CurrencyRate, Budget, BudgetParameter, AddressType, Approval, Attribute, AttributeAllowedValue, Calendar, CalendarDay, CalendarException, CalendarDayHour, Classification, ClassificationAllowedValue, EmailType, Language, OperationalRole, OperationalRoleTemplate, OperationalRoleResource, PhoneNumberType, UserOperationalRole, UserOperationalRoleTemplate, UserOperationalRoleResource, TermsAndCondition, TermsAndConditionVersion, TermsAndConditionOperationalRole, UserTermsAndConditionVersion, Location, LocationAttribute, LocationDocument, LocalisationSet, LocalisationKey, LocalisationTranslation, Phrase, PhraseTranslation, PreconfiguredReason, Site, SiteAttribute, SiteDocument, SiteType, Supplier, SupplierFileAttachment, SupplierAttribute, SupplierDocument, SupplierContactAddress, SupplierContactEmail, SupplierContactPhoneNumber, SupplierResource, SupplierTaxRate, UnitOfMeasurement, SiteResource, SiteContactAddress, SiteContactEmail, SiteContactPhoneNumber, ChangeDataTrigger, ChangeDataTriggerOccurrenceLog, ChangeDataTriggerCriteria, NotificationTemplate, ChangeDataTriggerCriteriaParameter, ChangeDataTriggerNotificationEvent, NotificationTemplateParameter, ChangeDataTriggerNotificationEventAttachment, ChangeDataTriggerNotificationEventAttachmentParameter, RequestType, Category, Commodity, MaterialMaster, MaterialMasterAttribute, MaterialMasterDocument, MaterialMasterBin, MaterialMasterSupplier, MaterialMasterLinkWarehouse, StockItem, StockItemFileAttachment, StockItemAttribute, StockItemDocument, StockItemBin, StockItemSupplier, WarehouseAttribute, Warehouse, WarehouseDocument, Requisition, RequisitionFileAttachment, RequisitionStatus, RequisitionStatusChange, RequisitionStatusAttribute, RequisitionStatusDocument, RequisitionStatusChangeHistory, RequisitionItemTransaction, ApprovalRole, RequisitionAttribute, RequisitionDocument, RequisitionTransaction, RequisitionItem, RequisitionItemFileAttachment, UserSiteApprovalRole, ApprovalWorkflow, ApprovalWorkflowExpression, ApprovalWorkflowExpressionApprovalRole, Competency, Resource, ResourceAttribute, ResourceAddress, ResourceClassification, ResourceCompetency, ResourceDocument, ResourceEmail, ResourcePhoneNumber, ResourceTrade, ResourceTradeCompetency, ResourceTradeFinancialRate, Section, SectionAttribute, SectionDocument, SectionTrade, TradeAttribute, TradeDocument, Trade, TradeCompetency, TradeFinancialRate, ResourceContext, ResourceFileAttachment, AssetImportance, RiskConsequence, RiskConsequenceCategory, RiskModel, RiskModelConsequenceCategory, RiskModelImportance, RiskModelProbability, RiskProbability, WorkOrderImportance, WorkOrderStatus, WorkOrderStatusAttribute, WorkOrderStatusDocument, WorkOrderStatusAllowedChange, WorkOrder, WorkOrderStatusChangeHistory, WorkOrderStatusChange, WorkOrderMerge, WorkOrderSplit, WorkOrderMeter, WorkOrderAttribute, WorkOrderDocument, WorkOrderFileAttachment, WorkOrderTaskFileAttachment, WorkOrderTaskWarranty, WorkOrderTaskSpareFileAttachment, WorkOrderTask, WorkOrderTaskDocument, WorkOrderTaskAdHocCost, WorkOrderMonitoringPoint, WorkOrderTaskMonitoringPoint, WorkOrderTaskSpare, WorkOrderTaskSubTask, WorkOrderTaskResource, WorkOrderTaskResourceUsage, DueTask, DueTaskSuppressor, ProposedWorkOrderBatch, ProposedWorkOrder, ProposedWorkOrderTask, ProposedWorkOrderMeter, WorkOrderMovement, WorkOrderTaskMovement, WorkOrderTaskResourceMovement, WorkOrderTaskSpareMovement, WorkOrderTaskSubTaskMovement, WorkOrderCompleteAllTasksLog, WorkRequest, WorkRequestAttribute, WorkRequestDocument, WorkRequestStatus, WorkRequestStatusChange, WorkRequestStatusChangeHistory, WorkRequestFileAttachment, WorkOrderDowntimeLoss, WorkOrderProgressEvent, WorkOrderProgressEventAllowedChange, WorkOrderProgressLog, WorkOrderWarranty, ServiceLevelAgreementClassification, ServiceLevelAgreement, ServiceLevelAgreementMeasure, WorkOrderServiceLevelAgreement, WorkOrderServiceLevelAgreementMeasure, ServiceLevelAgreementMeasureTrigger, ServiceLevelAgreementMeasureFieldAssignment, PermissionTree, User, UserAttribute, UserDocument, UserAuthentication, SecurityRole, SecurityRolePermission, UserSecurityRole, UserCustomPermission, UserOption, BackgroundTask, BackgroundTaskStep, ScheduledBackgroundTask, ScheduledJob, UserDefinedField, UserDefinedFieldPredefinedValue, SystemOption, SystemOptionPageLimit, SystemOptionWorkOrderStatus, SystemOptionDefaultStandardTask, SystemOptionWorkOrderStatusTypeOfWork, SystemOptionReferenceDataViewPermission, SystemOptionFileAttachmentCategory, SystemOptionFileAttachmentFileType, RecordChange, RecordChangeValue, RecordChangeUser, RecordChangeProperty, NotificationEventOutbox, NotificationEventAttachmentOutbox, NotificationOutbox, NotificationOutboxLog, ChangeDataTriggerCriteriaEvaluation, SystemOptionReportServerEntity, SystemOptionReportServerEntityDefaultReport, TemplateMigrationLog, TemplateMigrationLogIntent, ResourceActionMigrationLog, ImportSchema, ImportFile, UserDefinedQuery, ResourceActionCustomisation, TemplateCustomisation, TemplateResource, ClusterSettings, ClusterIdentityProviderSettings, MessageBrokerHost, MessageBrokerTopic, MessageBrokerTopicConsumer, TenantSettings, TenantChangeDataSubscriptionSettings, TenantIdentityProviderSettings, TenantJobSettings, TenantFileContentStoreLocationSettings, TenantFileContentStoreFileTypeGroupSettings, TenantFileContentStoreFileTypeSettings, ClusterFeatureToggle, TenantFeatureToggle, TenantHealthCheck, TenantMachineHealthCheck, ClusterHealthCheck, ClusterMachineHealthCheck, ClusterCapacitySlot, TenantChangeLogCleanupExpressionSettings, ClusterJobSettings, Ignore]) | enum |\r\n| idApprovalEntityIdRemark | RequisitionItem->*Id.Approval.EntityId_Remark | string | |\r\n| idApprovalEntityIdRoleCode | RequisitionItem->*Id.Approval.EntityId_Role_Code | string | |\r\n| idApprovalEntityIdRoleDescription | RequisitionItem->*Id.Approval.EntityId_Role_Description | string | |\r\n| idApprovalEntityIdStatus | RequisitionItem->*Id.Approval.EntityId_Status | string (Allowed values: [AwaitingApproval, Approved, Rejected, RoleCountReached]) | enum |\r\n", "operationId": "GetMyApprovalForRequisitionItemCollection", "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 My Identity collection", "schema": { "$ref": "#/definitions/GetMyApprovalForRequisitionItemCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/IDENTITY/BackgroundTasks": { "get": { "tags": [ "My Identity" ], "summary": "Get a collection of my Background Task 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 | BackgroundTask->Id | integer | int64 |\r\n| name | BackgroundTask->Name | string | |\r\n| type | BackgroundTask->Type | string | |\r\n| origin | BackgroundTask->Origin | string (Allowed values: [User, Job]) | enum |\r\n| priority | BackgroundTask->Priority | integer | int32 |\r\n| status | BackgroundTask->Status | string (Allowed values: [NotStarted, Running, Completed, Cancelling, Cancelled, Aborting, Aborted]) | enum |\r\n| createdOn | BackgroundTask->CreatedOn | string | date-time |\r\n| modifiedOn | BackgroundTask->ModifiedOn | string | date-time |\r\n| startedOn | BackgroundTask->StartedOn | string | date-time |\r\n| completedOn | BackgroundTask->CompletedOn | string | date-time |\r\n| totalSteps | BackgroundTask->TotalSteps | integer | int32 |\r\n| failedSteps | BackgroundTask->FailedSteps | integer | int32 |\r\n| completedSteps | BackgroundTask->CompletedSteps | integer | int32 |\r\n| remainingSteps | BackgroundTask->RemainingSteps | integer | int32 |\r\n| skippedSteps | BackgroundTask->SkippedSteps | integer | int32 |\r\n| elapsedTime | BackgroundTask->ElapsedTime | string | duration |\r\n| averageTimePerStep | BackgroundTask->AverageTimePerStep | string | duration |\r\n| estimatedTimeRemaining | BackgroundTask->EstimatedTimeRemaining | string | duration |\r\n| estimatedCompletion | BackgroundTask->EstimatedCompletion | string | date-time |\r\n| version | BackgroundTask->Version | integer | int32 |\r\n", "operationId": "GetMyBackgroundTaskCollection", "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 My Identity collection", "schema": { "$ref": "#/definitions/GetMyBackgroundTaskCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/IDENTITY/BackgroundTasks/{id}/Steps": { "get": { "tags": [ "My Identity" ], "summary": "Get a collection of Background Task Step resources for my Background Task 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| id | BackgroundTaskStep->Id | integer | int64 |\r\n| name | BackgroundTaskStep->Name | string | |\r\n| backgroundTaskId | BackgroundTaskStep->BackgroundTask_Id | integer | int64 |\r\n| backgroundTaskName | BackgroundTaskStep->BackgroundTask_Name | string | |\r\n| backgroundTaskType | BackgroundTaskStep->BackgroundTask_Type | string | |\r\n| backgroundTaskStatus | BackgroundTaskStep->BackgroundTask_Status | string (Allowed values: [NotStarted, Running, Completed, Cancelling, Cancelled, Aborting, Aborted]) | enum |\r\n| backgroundTaskOrigin | BackgroundTaskStep->BackgroundTask_Origin | string (Allowed values: [User, Job]) | enum |\r\n| createdOn | BackgroundTaskStep->CreatedOn | string | date-time |\r\n| modifiedOn | BackgroundTaskStep->ModifiedOn | string | date-time |\r\n| startedOn | BackgroundTaskStep->StartedOn | string | date-time |\r\n| completedOn | BackgroundTaskStep->CompletedOn | string | date-time |\r\n| sequenceNumber | BackgroundTaskStep->SequenceNumber | integer | int32 |\r\n| response | BackgroundTaskStep->Response | object | |\r\n| isValid | BackgroundTaskStep->IsValid | boolean | |\r\n", "operationId": "GetMyBackgroundTaskStepForBackgroundTaskCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Background Task 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 My Identity collection", "schema": { "$ref": "#/definitions/GetMyBackgroundTaskStepForBackgroundTaskCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/IDENTITY/Languages": { "get": { "tags": [ "My Identity" ], "summary": "Get a collection of my Languages.", "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 | Language->Version | integer | int32 |\r\n| id | Language->Id | integer | int64 |\r\n| code | Language->Code | string | |\r\n| description | Language->Description | string | |\r\n| languageCode | Language->LanguageCode | string | |\r\n| sequenceNumber | Language->SequenceNumber | integer | int32 |\r\n| isActive | Language->IsActive | boolean | |\r\n", "operationId": "GetMyLanguageCollection", "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 My Identity collection", "schema": { "$ref": "#/definitions/GetMyLanguageCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/IDENTITY/OperationalRoles": { "get": { "tags": [ "My Identity" ], "summary": "Get a collection of my User Operational Role 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 | UserOperationalRole->Id | integer | int64 |\r\n| version | UserOperationalRole->Version | integer | int32 |\r\n| operationalRoleId | UserOperationalRole->OperationalRole_Id | integer | int64 |\r\n| operationalRoleCode | UserOperationalRole->OperationalRole_Code | string | |\r\n| operationalRoleDescription | UserOperationalRole->OperationalRole_Description | string | |\r\n| isDefault | UserOperationalRole->IsDefault | boolean | |\r\n| sequenceNumber | UserOperationalRole->SequenceNumber | integer | int32 |\r\n", "operationId": "GetMyOperationalRoleCollection", "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 My Identity collection", "schema": { "$ref": "#/definitions/GetMyOperationalRoleCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/IDENTITY/OperationalRoles/Resources": { "get": { "tags": [ "My Identity" ], "summary": "Get a collection of my User Operational Role Resource 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 | UserOperationalRoleResource->Version | integer | int32 |\r\n| id | UserOperationalRoleResource->Id | integer | int64 |\r\n| userOperationalRoleId | UserOperationalRoleResource->UserOperationalRole_Id | integer | int64 |\r\n| userOperationalRoleOperationalRoleId | UserOperationalRoleResource->UserOperationalRole_OperationalRole_Id | integer | int64 |\r\n| userOperationalRoleOperationalRoleCode | UserOperationalRoleResource->UserOperationalRole_OperationalRole_Code | string | |\r\n| userOperationalRoleOperationalRoleDescription | UserOperationalRoleResource->UserOperationalRole_OperationalRole_Description | string | |\r\n| userOperationalRoleUserId | UserOperationalRoleResource->UserOperationalRole_User_Id | integer | int64 |\r\n| userOperationalRoleUserFullName | UserOperationalRoleResource->UserOperationalRole_User_FullName | string | |\r\n| resourceActionCustomisationId | UserOperationalRoleResource->ResourceActionCustomisation_Id | integer | int64 |\r\n| resourceActionCustomisationName | UserOperationalRoleResource->ResourceActionCustomisation_Name | string | |\r\n| module | UserOperationalRoleResource->Module | string | |\r\n| resource | UserOperationalRoleResource->Resource | string | |\r\n| resourceAction | UserOperationalRoleResource->ResourceAction | string | |\r\n| sequenceNumber | UserOperationalRoleResource->SequenceNumber | integer | int32 |\r\n| isDefault | UserOperationalRoleResource->IsDefault | boolean | |\r\n| isUserDefault | UserOperationalRoleResource->IsUserDefault | boolean | |\r\n| isInherited | UserOperationalRoleResource->IsInherited | boolean | |\r\n", "operationId": "GetMyOperationalRoleResourceCollection", "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 My Identity collection", "schema": { "$ref": "#/definitions/GetMyOperationalRoleResourceCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/IDENTITY/OperationalRoles/Templates": { "get": { "tags": [ "My Identity" ], "summary": "Get a collection of my User Operational Role Template 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 | UserOperationalRoleTemplate->Version | integer | int32 |\r\n| id | UserOperationalRoleTemplate->Id | integer | int64 |\r\n| userOperationalRoleId | UserOperationalRoleTemplate->UserOperationalRole_Id | integer | int64 |\r\n| userOperationalRoleOperationalRoleId | UserOperationalRoleTemplate->UserOperationalRole_OperationalRole_Id | integer | int64 |\r\n| userOperationalRoleOperationalRoleCode | UserOperationalRoleTemplate->UserOperationalRole_OperationalRole_Code | string | |\r\n| userOperationalRoleOperationalRoleDescription | UserOperationalRoleTemplate->UserOperationalRole_OperationalRole_Description | string | |\r\n| templateCustomisationId | UserOperationalRoleTemplate->TemplateCustomisation_Id | integer | int64 |\r\n| templateCustomisationName | UserOperationalRoleTemplate->TemplateCustomisation_Name | string | |\r\n| templateCustomisationDescription | UserOperationalRoleTemplate->TemplateCustomisation_Description | string | |\r\n| templateCustomisationRestrictionLevel | UserOperationalRoleTemplate->TemplateCustomisation_RestrictionLevel | string (Allowed values: [Public, PublicReadOnly, Private]) | enum |\r\n| module | UserOperationalRoleTemplate->Module | string | |\r\n| template | UserOperationalRoleTemplate->Template | string | |\r\n| type | UserOperationalRoleTemplate->Type | string | |\r\n| sequenceNumber | UserOperationalRoleTemplate->SequenceNumber | integer | int32 |\r\n| isDefault | UserOperationalRoleTemplate->IsDefault | boolean | |\r\n| isUserDefault | UserOperationalRoleTemplate->IsUserDefault | boolean | |\r\n| isInherited | UserOperationalRoleTemplate->IsInherited | boolean | |\r\n", "operationId": "GetMyOperationalRoleTemplateCollection", "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 My Identity collection", "schema": { "$ref": "#/definitions/GetMyOperationalRoleTemplateCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/IDENTITY/ScheduledBackgroundTasks": { "get": { "tags": [ "My Identity" ], "summary": "Get a collection of my Scheduled Background Task 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 | ScheduledBackgroundTask->Id | integer | int64 |\r\n| name | ScheduledBackgroundTask->Name | string | |\r\n| type | ScheduledBackgroundTask->Type | string | |\r\n| jobId | ScheduledBackgroundTask->JobId | string | uuid |\r\n| schedule | ScheduledBackgroundTask->Schedule | string | |\r\n| executionMode | ScheduledBackgroundTask->ExecutionMode | string (Allowed values: [AllOrNone, PerRecord]) | enum |\r\n| startFrom | ScheduledBackgroundTask->StartFrom | string | date-time |\r\n| requestType | ScheduledBackgroundTask->RequestType | string | |\r\n| notes | ScheduledBackgroundTask->Notes | string | |\r\n| createdOn | ScheduledBackgroundTask->CreatedOn | string | date-time |\r\n| modifiedOn | ScheduledBackgroundTask->ModifiedOn | string | date-time |\r\n| version | ScheduledBackgroundTask->Version | integer | int32 |\r\n", "operationId": "GetMyScheduledBackgroundTaskCollection", "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 My Identity collection", "schema": { "$ref": "#/definitions/GetMyScheduledBackgroundTaskCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/IDENTITY/TermsAndConditions": { "get": { "tags": [ "My Identity" ], "summary": "Get a collection of my User Terms And Conditions Version 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 | UserTermsAndConditionVersion->Id | integer | int64 |\r\n| version | UserTermsAndConditionVersion->Version | integer | int32 |\r\n| userCode | UserTermsAndConditionVersion->User_Code | string | |\r\n| termsAndConditionVersionTermsAndConditionCode | UserTermsAndConditionVersion->TermsAndConditionVersion_TermsAndCondition_Code | string | |\r\n| termsAndConditionVersionTermsAndConditionName | UserTermsAndConditionVersion->TermsAndConditionVersion_TermsAndCondition_Name | string | |\r\n| termsAndConditionVersionLanguageCode | UserTermsAndConditionVersion->TermsAndConditionVersion_Language_Code | string | |\r\n| termsAndConditionVersionPublished | UserTermsAndConditionVersion->TermsAndConditionVersion_Published | boolean | |\r\n| termsAndConditionVersionContentVersion | UserTermsAndConditionVersion->TermsAndConditionVersion_ContentVersion | integer | int32 |\r\n| deprecated | UserTermsAndConditionVersion->Deprecated | boolean | |\r\n| accepted | UserTermsAndConditionVersion->Accepted | boolean | |\r\n| acceptedDate | UserTermsAndConditionVersion->AcceptedDate | string | date |\r\n", "operationId": "GetMyTermsAndConditionCollection", "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 My Identity collection", "schema": { "$ref": "#/definitions/GetMyTermsAndConditionCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/IDENTITY/TermsAndConditions/Pending": { "get": { "tags": [ "My Identity" ], "summary": "Get a collection of my User Terms And Conditions Version 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 | UserTermsAndConditionVersion->Id | integer | int64 |\r\n| version | UserTermsAndConditionVersion->Version | integer | int32 |\r\n| userCode | UserTermsAndConditionVersion->User_Code | string | |\r\n| termsAndConditionVersionTermsAndConditionCode | UserTermsAndConditionVersion->TermsAndConditionVersion_TermsAndCondition_Code | string | |\r\n| termsAndConditionVersionTermsAndConditionName | UserTermsAndConditionVersion->TermsAndConditionVersion_TermsAndCondition_Name | string | |\r\n| termsAndConditionVersionTermsAndConditionCompulsory | UserTermsAndConditionVersion->TermsAndConditionVersion_TermsAndCondition_Compulsory | boolean | |\r\n| termsAndConditionVersionLanguageCode | UserTermsAndConditionVersion->TermsAndConditionVersion_Language_Code | string | |\r\n| termsAndConditionVersionPublished | UserTermsAndConditionVersion->TermsAndConditionVersion_Published | boolean | |\r\n| termsAndConditionVersionContentVersion | UserTermsAndConditionVersion->TermsAndConditionVersion_ContentVersion | integer | int32 |\r\n| deprecated | UserTermsAndConditionVersion->Deprecated | boolean | |\r\n| accepted | UserTermsAndConditionVersion->Accepted | boolean | |\r\n| acceptedDate | UserTermsAndConditionVersion->AcceptedDate | string | date |\r\n", "operationId": "GetMyTermsAndConditionPendingCollection", "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 My Identity collection", "schema": { "$ref": "#/definitions/GetMyTermsAndConditionPendingCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/IDENTITY/BackgroundTasks/{id}": { "delete": { "tags": [ "My Identity" ], "summary": "Delete the work registered for my Background Task 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 | BackgroundTask->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": "DeleteMyBackgroundTask", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Background Task Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteMyBackgroundTaskResourceActionRequest" } } ], "responses": { "204": { "x-nullable": true, "description": "Success response - My Identity was successfully deleted" }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/IDENTITY/ScheduledBackgroundTasks/{id}": { "delete": { "tags": [ "My Identity" ], "summary": "Delete the work registered for my Scheduled Background Task 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 | ScheduledBackgroundTask->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": "DeleteMyScheduledBackgroundTask", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Scheduled Background Task Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteMyScheduledBackgroundTaskResourceActionRequest" } } ], "responses": { "204": { "x-nullable": true, "description": "Success response - My Identity was successfully deleted" }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/IDENTITY/BackgroundTasks/Batch": { "delete": { "tags": [ "My Identity" ], "summary": "Delete the work registered for the collection of my Background Task 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 | BackgroundTask->Id | integer | int64 |\r\n| version | BackgroundTask->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": "BatchDeleteMyBackgroundTask", "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/BatchDeleteMyBackgroundTaskResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - My Identity 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/IDENTITY/ScheduledBackgroundTasks/Batch": { "delete": { "tags": [ "My Identity" ], "summary": "Delete the work registered for the collection of my Scheduled Background Task 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 | ScheduledBackgroundTask->Id | integer | int64 |\r\n| version | ScheduledBackgroundTask->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": "BatchDeleteMyScheduledBackgroundTask", "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/BatchDeleteMyScheduledBackgroundTaskResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - My Identity 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/IDENTITY/TermsAndConditions/{id}/Accept": { "post": { "tags": [ "My Identity" ], "summary": "Accept my User Terms And Conditions Version.", "description": "", "operationId": "AcceptMyTermsAndCondition", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "User Terms And Conditions Version Id", "format": "int64", "x-nullable": false } ], "responses": { "204": { "x-nullable": true, "description": "Success response - body contains My Identity", "schema": { "$ref": "#/definitions/AcceptMyTermsAndConditionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/IDENTITY/OperationalRoles/{roleId}/Resources/{resourceId}": { "post": { "tags": [ "My Identity" ], "summary": "Add resource action to my User Operational Role.", "description": "", "operationId": "AddResourceActionToUserOperationalRole", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "roleId", "in": "path", "required": true, "description": "User Operational Role Id", "format": "int64", "x-nullable": false }, { "type": "integer", "name": "resourceId", "in": "path", "required": true, "description": "API Resource Action Customisation Id", "format": "int64", "x-nullable": false } ], "responses": { "204": { "x-nullable": true, "description": "Success response - body contains My Identity", "schema": { "$ref": "#/definitions/AddResourceActionToUserOperationalRoleResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/IDENTITY/OperationalRoles/{roleId}/Templates/{templateId}": { "post": { "tags": [ "My Identity" ], "summary": "Add template to my User Operational Role.", "description": "", "operationId": "AddTemplateToUserOperationalRole", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "roleId", "in": "path", "required": true, "description": "User Operational Role Id", "format": "int64", "x-nullable": false }, { "type": "integer", "name": "templateId", "in": "path", "required": true, "description": "Template Customisation Id", "format": "int64", "x-nullable": false } ], "responses": { "204": { "x-nullable": true, "description": "Success response - body contains My Identity", "schema": { "$ref": "#/definitions/AddTemplateToUserOperationalRoleResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/IDENTITY/Approvals/Approve/{id}": { "patch": { "tags": [ "My Identity" ], "summary": "Approve My Approval.", "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| comment | MyApproval->Comment | 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\r\n", "operationId": "ApproveMyApproval", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Approval Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ApproveApprovalResourceActionRequest" } }, { "$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/IDENTITY/Approvals/Reject/Batch": { "patch": { "tags": [ "My Identity" ], "summary": "Batch Reject My Approval.", "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 | MyApproval->Id | integer | int64 |\r\n| version | MyApproval->Version | integer | int32 |\r\n| entityType | MyApproval->EntityType | string (Allowed values: [Alarm, NewAlarm, AlarmExpression, AlarmExpressionTask, AlarmAttribute, AlarmDocument, AlarmType, MonitoringPoint, MonitoringPointBoundEvaluationLog, MonitoringPointParameter, MonitoringPointReading, MonitoringPointTrigger, MonitoringPointTriggerExpression, MonitoringPointTriggerExpressionAlarmType, MonitoringPointTriggerExpressionParameter, MonitoringPointTriggerExpressionEvaluation, MonitoringPointTriggerExpressionEvaluationLog, MonitoringPointType, MonitoringPointTypeParameter, MonitoringPointAttribute, MonitoringPointDocument, AuxiliaryAssetTask, AuxiliaryAssetTaskResource, AuxiliaryAssetTaskSpare, AuxiliaryAssetTaskSubTask, RegularAssetComponent, RegularAssetComponentAttribute, RegularAssetComponentDocument, RegularAssetComponentRuleEvaluationFailure, AssetComponent, AssetWarranty, PlaceholderAssetComponent, PlaceholderAssetComponentOptionValue, PlaceholderAssetComponentCondition, PlaceholderAssetMeter, PlaceholderAssetComponentRuleEvaluationFailure, RegularAssetCondition, RegularAssetActiveCondition, AssetFmeca, RegularAssetOptionValue, Asset, RegularAssetAttribute, RegularAssetDocument, RegularAssetFileAttachment, PlaceholderAsset, PlaceholderAssetAttribute, PlaceholderAssetDocument, PlaceholderAssetFileAttachment, PlaceholderAssetRuleEvaluationFailure, PlaceholderAssetResponsibility, PlaceholderAssetCondition, PlaceholderAssetActiveCondition, AssetTask, SetAssetTaskSpareWarehouseEntity, RegularAssetTask, RegularAssetTaskRuleEvaluationFailure, RegularAssetTaskAttribute, RegularAssetTaskAuxiliaryTask, RegularAssetTaskFollowUpTask, RegularAssetTaskFollowUpTaskExpression, RegularAssetTaskSuppressedTask, RegularAssetTaskResource, RegularAssetTaskResourceRuleEvaluationFailure, RegularAssetTaskSpare, RegularAssetTaskSpareRuleEvaluationFailure, RegularAssetTaskSubTask, RegularAssetTaskFileAttachment, AuxiliaryAssetTypeTask, AuxiliaryAssetTypeTaskResource, AuxiliaryAssetTypeTaskSpare, AuxiliaryAssetTypeTaskSubTask, RegularAssetTypeComponent, RegularAssetTypeComponentAttribute, RegularAssetTypeComponentDocument, AssetTypeComponent, PlaceholderAssetTypeComponent, PlaceholderAssetTypeComponentCondition, PlaceholderAssetTypeComponentAttribute, PlaceholderAssetTypeComponentDocument, PlaceholderAssetTypeComponentRuleLink, RegularAssetTypeComponentRuleLink, PlaceholderAssetComponentAttribute, PlaceholderAssetComponentDocument, PlaceholderAssetComponentActiveCondition, AssetTypeFmeca, AssetTypeFunction, AssetFunction, AssetFmecaTask, AssetTypeFmecaTask, AssetTypeFolder, RegularAssetTypeOption, AssetType, PlaceholderAssetType, PlaceholderAssetTypeSpare, PlaceholderAssetTypeAttribute, PlaceholderAssetTypeDocument, PlaceholderAssetTypeResponsibility, PlaceholderAssetTypeRuleLink, RegularAssetTypeTask, RegularAssetTypeTaskAttribute, RegularAssetTypeTaskAuxiliaryTask, RegularAssetTypeTaskCondition, RegularAssetTypeTaskDocument, RegularAssetTypeTaskFollowUpTask, RegularAssetTypeTaskFollowUpTaskExpression, AssetTypeTask, AssetTypeTaskResource, AssetTaskResource, AssetTaskSpare, AssetTypeTaskSpare, RegularAssetTypeTaskResource, RegularAssetTypeTaskRuleLink, RegularAssetTypeTaskSpare, RegularAssetTypeTaskSubTask, RegularAssetTypeTaskSuppressedTask, Condition, ConditionType, Event, FailureCause, FailureCauseType, FailureMechanism, FailureMechanismType, FailureMode, FailureModeType, InPlaceAssetMeter, InPlaceAssetAttribute, InPlaceAssetFileAttachment, InPlaceAssetRuleEvaluationFailure, InPlaceAssetResponsibility, InPlaceAssetSpare, InPlaceAssetType, InPlaceAssetTypeResponsibility, InPlaceAssetTypeRuleLink, InPlaceAssetTypeSpare, InPlaceAsset, Option, OptionCategory, RegularAsset, RegularAssetTaskDocument, RegularAssetMeter, RegularAssetResponsibility, RegularAssetMonitoringPointTrigger, RegularAssetSpare, RegularAssetTaskCondition, RegularAssetType, RegularAssetTypeAttribute, RegularAssetTypeDocument, RegularAssetTypeCondition, PlaceholderAssetTypeCondition, RegularAssetTypeRule, RegularAssetTypeResponsibility, RegularAssetTypeMonitoringPointTrigger, RegularAssetTypeSpare, RepairType, Rule, RuleCategory, RuleOption, StandardTask, StandardTaskSpare, StandardTaskSubTask, StandardTaskResource, StandardTaskAttribute, StandardTaskDocument, TaskImportance, TaskInterval, TaskIntervalType, TaskRollUpPoint, TypeOfWork, RegularAssetTypeTaskSpareRuleLink, InPlaceAssetTypeAttribute, RegularAssetTypeTaskResourceRuleLink, PlaceholderAssetSpare, RegularAssetMonitoringPointTriggerParameter, AssetSpare, AssetTypeSpare, AssetMeter, AssetConsumption, RegularAssetConsumption, PlaceholderAssetConsumption, InPlaceAssetConsumption, WarrantyType, RegularAssetTypeFileAttachment, Meter, MeterAttribute, MeterDocument, MeterReading, PredictedMeterReading, TimeLossCategory, TimeLossReason, TimeLossType, Consumable, AcquisitionStatus, AcquisitionType, DocumentFolder, DocumentRecord, DocumentRecordAttribute, FileAttachment, FileAttachmentCategory, FileAttachmentContentHistory, DocumentRecordFileHistory, Costing, CostingBudget, CostCentre, CostCentreAttribute, CostCentreDocument, CostCentreType, CostElement, CostElementAttribute, CostElementDocument, Currency, BudgetTemplate, BudgetTemplateParameter, FinancialYear, FinancialYearPeriod, GeneralLedger, GeneralLedgerAttribute, GeneralLedgerDocument, CurrencyRate, Budget, BudgetParameter, AddressType, Approval, Attribute, AttributeAllowedValue, Calendar, CalendarDay, CalendarException, CalendarDayHour, Classification, ClassificationAllowedValue, EmailType, Language, OperationalRole, OperationalRoleTemplate, OperationalRoleResource, PhoneNumberType, UserOperationalRole, UserOperationalRoleTemplate, UserOperationalRoleResource, TermsAndCondition, TermsAndConditionVersion, TermsAndConditionOperationalRole, UserTermsAndConditionVersion, Location, LocationAttribute, LocationDocument, LocalisationSet, LocalisationKey, LocalisationTranslation, Phrase, PhraseTranslation, PreconfiguredReason, Site, SiteAttribute, SiteDocument, SiteType, Supplier, SupplierFileAttachment, SupplierAttribute, SupplierDocument, SupplierContactAddress, SupplierContactEmail, SupplierContactPhoneNumber, SupplierResource, SupplierTaxRate, UnitOfMeasurement, SiteResource, SiteContactAddress, SiteContactEmail, SiteContactPhoneNumber, ChangeDataTrigger, ChangeDataTriggerOccurrenceLog, ChangeDataTriggerCriteria, NotificationTemplate, ChangeDataTriggerCriteriaParameter, ChangeDataTriggerNotificationEvent, NotificationTemplateParameter, ChangeDataTriggerNotificationEventAttachment, ChangeDataTriggerNotificationEventAttachmentParameter, RequestType, Category, Commodity, MaterialMaster, MaterialMasterAttribute, MaterialMasterDocument, MaterialMasterBin, MaterialMasterSupplier, MaterialMasterLinkWarehouse, StockItem, StockItemFileAttachment, StockItemAttribute, StockItemDocument, StockItemBin, StockItemSupplier, WarehouseAttribute, Warehouse, WarehouseDocument, Requisition, RequisitionFileAttachment, RequisitionStatus, RequisitionStatusChange, RequisitionStatusAttribute, RequisitionStatusDocument, RequisitionStatusChangeHistory, RequisitionItemTransaction, ApprovalRole, RequisitionAttribute, RequisitionDocument, RequisitionTransaction, RequisitionItem, RequisitionItemFileAttachment, UserSiteApprovalRole, ApprovalWorkflow, ApprovalWorkflowExpression, ApprovalWorkflowExpressionApprovalRole, Competency, Resource, ResourceAttribute, ResourceAddress, ResourceClassification, ResourceCompetency, ResourceDocument, ResourceEmail, ResourcePhoneNumber, ResourceTrade, ResourceTradeCompetency, ResourceTradeFinancialRate, Section, SectionAttribute, SectionDocument, SectionTrade, TradeAttribute, TradeDocument, Trade, TradeCompetency, TradeFinancialRate, ResourceContext, ResourceFileAttachment, AssetImportance, RiskConsequence, RiskConsequenceCategory, RiskModel, RiskModelConsequenceCategory, RiskModelImportance, RiskModelProbability, RiskProbability, WorkOrderImportance, WorkOrderStatus, WorkOrderStatusAttribute, WorkOrderStatusDocument, WorkOrderStatusAllowedChange, WorkOrder, WorkOrderStatusChangeHistory, WorkOrderStatusChange, WorkOrderMerge, WorkOrderSplit, WorkOrderMeter, WorkOrderAttribute, WorkOrderDocument, WorkOrderFileAttachment, WorkOrderTaskFileAttachment, WorkOrderTaskWarranty, WorkOrderTaskSpareFileAttachment, WorkOrderTask, WorkOrderTaskDocument, WorkOrderTaskAdHocCost, WorkOrderMonitoringPoint, WorkOrderTaskMonitoringPoint, WorkOrderTaskSpare, WorkOrderTaskSubTask, WorkOrderTaskResource, WorkOrderTaskResourceUsage, DueTask, DueTaskSuppressor, ProposedWorkOrderBatch, ProposedWorkOrder, ProposedWorkOrderTask, ProposedWorkOrderMeter, WorkOrderMovement, WorkOrderTaskMovement, WorkOrderTaskResourceMovement, WorkOrderTaskSpareMovement, WorkOrderTaskSubTaskMovement, WorkOrderCompleteAllTasksLog, WorkRequest, WorkRequestAttribute, WorkRequestDocument, WorkRequestStatus, WorkRequestStatusChange, WorkRequestStatusChangeHistory, WorkRequestFileAttachment, WorkOrderDowntimeLoss, WorkOrderProgressEvent, WorkOrderProgressEventAllowedChange, WorkOrderProgressLog, WorkOrderWarranty, ServiceLevelAgreementClassification, ServiceLevelAgreement, ServiceLevelAgreementMeasure, WorkOrderServiceLevelAgreement, WorkOrderServiceLevelAgreementMeasure, ServiceLevelAgreementMeasureTrigger, ServiceLevelAgreementMeasureFieldAssignment, PermissionTree, User, UserAttribute, UserDocument, UserAuthentication, SecurityRole, SecurityRolePermission, UserSecurityRole, UserCustomPermission, UserOption, BackgroundTask, BackgroundTaskStep, ScheduledBackgroundTask, ScheduledJob, UserDefinedField, UserDefinedFieldPredefinedValue, SystemOption, SystemOptionPageLimit, SystemOptionWorkOrderStatus, SystemOptionDefaultStandardTask, SystemOptionWorkOrderStatusTypeOfWork, SystemOptionReferenceDataViewPermission, SystemOptionFileAttachmentCategory, SystemOptionFileAttachmentFileType, RecordChange, RecordChangeValue, RecordChangeUser, RecordChangeProperty, NotificationEventOutbox, NotificationEventAttachmentOutbox, NotificationOutbox, NotificationOutboxLog, ChangeDataTriggerCriteriaEvaluation, SystemOptionReportServerEntity, SystemOptionReportServerEntityDefaultReport, TemplateMigrationLog, TemplateMigrationLogIntent, ResourceActionMigrationLog, ImportSchema, ImportFile, UserDefinedQuery, ResourceActionCustomisation, TemplateCustomisation, TemplateResource, ClusterSettings, ClusterIdentityProviderSettings, MessageBrokerHost, MessageBrokerTopic, MessageBrokerTopicConsumer, TenantSettings, TenantChangeDataSubscriptionSettings, TenantIdentityProviderSettings, TenantJobSettings, TenantFileContentStoreLocationSettings, TenantFileContentStoreFileTypeGroupSettings, TenantFileContentStoreFileTypeSettings, ClusterFeatureToggle, TenantFeatureToggle, TenantHealthCheck, TenantMachineHealthCheck, ClusterHealthCheck, ClusterMachineHealthCheck, ClusterCapacitySlot, TenantChangeLogCleanupExpressionSettings, ClusterJobSettings, Ignore]) | enum |\r\n| comment | MyApproval->Comment | 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\r\n", "operationId": "BatchRejectMyApproval", "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/BatchRejectApprovalResourceActionRequest" } }, { "$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/IDENTITY/BackgroundTasks/{id}/Cancel": { "post": { "tags": [ "My Identity" ], "summary": "Cancel the work registered for my Background Task resource.", "description": "", "operationId": "CancelMyBackgroundTask", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" } ], "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/IDENTITY/Approvals/Reject/{id}": { "patch": { "tags": [ "My Identity" ], "summary": "Reject My Approval.", "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| comment | MyApproval->Comment | 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\r\n", "operationId": "RejectMyApproval", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Approval Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/RejectApprovalResourceActionRequest" } }, { "$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/IDENTITY/OperationalRoles/{id}/Default": { "post": { "tags": [ "My Identity" ], "summary": "Set my default User Operational Role.", "description": "", "operationId": "SetMyDefaultOperationalRole", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "User Operational Role Id", "format": "int64", "x-nullable": false } ], "responses": { "204": { "x-nullable": true, "description": "Success response - body contains My Identity", "schema": { "$ref": "#/definitions/SetMyDefaultOperationalRoleResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/IDENTITY/OperationalRoles/Resources/{resourceName}/{resourceActionName}/{id}/Default": { "post": { "tags": [ "My Identity" ], "summary": "Set my default User Operational Role Resource.", "description": "", "operationId": "SetMyDefaultOperationalRoleResource", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "string", "name": "resourceName", "in": "path", "required": true, "description": "Name of Resource", "x-nullable": false }, { "type": "string", "name": "resourceActionName", "in": "path", "required": true, "description": "Name of Resource Action", "x-nullable": false }, { "type": "integer", "name": "id", "in": "path", "required": true, "description": "User Operational Role Resource Id", "format": "int64", "x-nullable": false } ], "responses": { "204": { "x-nullable": true, "description": "Success response - body contains My Identity", "schema": { "$ref": "#/definitions/SetMyDefaultOperationalRoleResourceResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/IDENTITY/OperationalRoles/Templates/{templateName}/{id}/Default": { "post": { "tags": [ "My Identity" ], "summary": "Set my default User Operational Role Template.", "description": "", "operationId": "SetMyDefaultOperationalRoleTemplate", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "string", "name": "templateName", "in": "path", "required": true, "description": "Name of Template", "x-nullable": false }, { "type": "integer", "name": "id", "in": "path", "required": true, "description": "User Operational Role Template Id", "format": "int64", "x-nullable": false } ], "responses": { "204": { "x-nullable": true, "description": "Success response - body contains My Identity", "schema": { "$ref": "#/definitions/SetMyDefaultOperationalRoleTemplateResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/IDENTITY/Approvals/Approve/Batch": { "patch": { "tags": [ "My Identity" ], "summary": "Batch Approve My Approvals.", "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 | MyApproval->Id | integer | int64 |\r\n| version | MyApproval->Version | integer | int32 |\r\n| entityType | MyApproval->EntityType | string (Allowed values: [Alarm, NewAlarm, AlarmExpression, AlarmExpressionTask, AlarmAttribute, AlarmDocument, AlarmType, MonitoringPoint, MonitoringPointBoundEvaluationLog, MonitoringPointParameter, MonitoringPointReading, MonitoringPointTrigger, MonitoringPointTriggerExpression, MonitoringPointTriggerExpressionAlarmType, MonitoringPointTriggerExpressionParameter, MonitoringPointTriggerExpressionEvaluation, MonitoringPointTriggerExpressionEvaluationLog, MonitoringPointType, MonitoringPointTypeParameter, MonitoringPointAttribute, MonitoringPointDocument, AuxiliaryAssetTask, AuxiliaryAssetTaskResource, AuxiliaryAssetTaskSpare, AuxiliaryAssetTaskSubTask, RegularAssetComponent, RegularAssetComponentAttribute, RegularAssetComponentDocument, RegularAssetComponentRuleEvaluationFailure, AssetComponent, AssetWarranty, PlaceholderAssetComponent, PlaceholderAssetComponentOptionValue, PlaceholderAssetComponentCondition, PlaceholderAssetMeter, PlaceholderAssetComponentRuleEvaluationFailure, RegularAssetCondition, RegularAssetActiveCondition, AssetFmeca, RegularAssetOptionValue, Asset, RegularAssetAttribute, RegularAssetDocument, RegularAssetFileAttachment, PlaceholderAsset, PlaceholderAssetAttribute, PlaceholderAssetDocument, PlaceholderAssetFileAttachment, PlaceholderAssetRuleEvaluationFailure, PlaceholderAssetResponsibility, PlaceholderAssetCondition, PlaceholderAssetActiveCondition, AssetTask, SetAssetTaskSpareWarehouseEntity, RegularAssetTask, RegularAssetTaskRuleEvaluationFailure, RegularAssetTaskAttribute, RegularAssetTaskAuxiliaryTask, RegularAssetTaskFollowUpTask, RegularAssetTaskFollowUpTaskExpression, RegularAssetTaskSuppressedTask, RegularAssetTaskResource, RegularAssetTaskResourceRuleEvaluationFailure, RegularAssetTaskSpare, RegularAssetTaskSpareRuleEvaluationFailure, RegularAssetTaskSubTask, RegularAssetTaskFileAttachment, AuxiliaryAssetTypeTask, AuxiliaryAssetTypeTaskResource, AuxiliaryAssetTypeTaskSpare, AuxiliaryAssetTypeTaskSubTask, RegularAssetTypeComponent, RegularAssetTypeComponentAttribute, RegularAssetTypeComponentDocument, AssetTypeComponent, PlaceholderAssetTypeComponent, PlaceholderAssetTypeComponentCondition, PlaceholderAssetTypeComponentAttribute, PlaceholderAssetTypeComponentDocument, PlaceholderAssetTypeComponentRuleLink, RegularAssetTypeComponentRuleLink, PlaceholderAssetComponentAttribute, PlaceholderAssetComponentDocument, PlaceholderAssetComponentActiveCondition, AssetTypeFmeca, AssetTypeFunction, AssetFunction, AssetFmecaTask, AssetTypeFmecaTask, AssetTypeFolder, RegularAssetTypeOption, AssetType, PlaceholderAssetType, PlaceholderAssetTypeSpare, PlaceholderAssetTypeAttribute, PlaceholderAssetTypeDocument, PlaceholderAssetTypeResponsibility, PlaceholderAssetTypeRuleLink, RegularAssetTypeTask, RegularAssetTypeTaskAttribute, RegularAssetTypeTaskAuxiliaryTask, RegularAssetTypeTaskCondition, RegularAssetTypeTaskDocument, RegularAssetTypeTaskFollowUpTask, RegularAssetTypeTaskFollowUpTaskExpression, AssetTypeTask, AssetTypeTaskResource, AssetTaskResource, AssetTaskSpare, AssetTypeTaskSpare, RegularAssetTypeTaskResource, RegularAssetTypeTaskRuleLink, RegularAssetTypeTaskSpare, RegularAssetTypeTaskSubTask, RegularAssetTypeTaskSuppressedTask, Condition, ConditionType, Event, FailureCause, FailureCauseType, FailureMechanism, FailureMechanismType, FailureMode, FailureModeType, InPlaceAssetMeter, InPlaceAssetAttribute, InPlaceAssetFileAttachment, InPlaceAssetRuleEvaluationFailure, InPlaceAssetResponsibility, InPlaceAssetSpare, InPlaceAssetType, InPlaceAssetTypeResponsibility, InPlaceAssetTypeRuleLink, InPlaceAssetTypeSpare, InPlaceAsset, Option, OptionCategory, RegularAsset, RegularAssetTaskDocument, RegularAssetMeter, RegularAssetResponsibility, RegularAssetMonitoringPointTrigger, RegularAssetSpare, RegularAssetTaskCondition, RegularAssetType, RegularAssetTypeAttribute, RegularAssetTypeDocument, RegularAssetTypeCondition, PlaceholderAssetTypeCondition, RegularAssetTypeRule, RegularAssetTypeResponsibility, RegularAssetTypeMonitoringPointTrigger, RegularAssetTypeSpare, RepairType, Rule, RuleCategory, RuleOption, StandardTask, StandardTaskSpare, StandardTaskSubTask, StandardTaskResource, StandardTaskAttribute, StandardTaskDocument, TaskImportance, TaskInterval, TaskIntervalType, TaskRollUpPoint, TypeOfWork, RegularAssetTypeTaskSpareRuleLink, InPlaceAssetTypeAttribute, RegularAssetTypeTaskResourceRuleLink, PlaceholderAssetSpare, RegularAssetMonitoringPointTriggerParameter, AssetSpare, AssetTypeSpare, AssetMeter, AssetConsumption, RegularAssetConsumption, PlaceholderAssetConsumption, InPlaceAssetConsumption, WarrantyType, RegularAssetTypeFileAttachment, Meter, MeterAttribute, MeterDocument, MeterReading, PredictedMeterReading, TimeLossCategory, TimeLossReason, TimeLossType, Consumable, AcquisitionStatus, AcquisitionType, DocumentFolder, DocumentRecord, DocumentRecordAttribute, FileAttachment, FileAttachmentCategory, FileAttachmentContentHistory, DocumentRecordFileHistory, Costing, CostingBudget, CostCentre, CostCentreAttribute, CostCentreDocument, CostCentreType, CostElement, CostElementAttribute, CostElementDocument, Currency, BudgetTemplate, BudgetTemplateParameter, FinancialYear, FinancialYearPeriod, GeneralLedger, GeneralLedgerAttribute, GeneralLedgerDocument, CurrencyRate, Budget, BudgetParameter, AddressType, Approval, Attribute, AttributeAllowedValue, Calendar, CalendarDay, CalendarException, CalendarDayHour, Classification, ClassificationAllowedValue, EmailType, Language, OperationalRole, OperationalRoleTemplate, OperationalRoleResource, PhoneNumberType, UserOperationalRole, UserOperationalRoleTemplate, UserOperationalRoleResource, TermsAndCondition, TermsAndConditionVersion, TermsAndConditionOperationalRole, UserTermsAndConditionVersion, Location, LocationAttribute, LocationDocument, LocalisationSet, LocalisationKey, LocalisationTranslation, Phrase, PhraseTranslation, PreconfiguredReason, Site, SiteAttribute, SiteDocument, SiteType, Supplier, SupplierFileAttachment, SupplierAttribute, SupplierDocument, SupplierContactAddress, SupplierContactEmail, SupplierContactPhoneNumber, SupplierResource, SupplierTaxRate, UnitOfMeasurement, SiteResource, SiteContactAddress, SiteContactEmail, SiteContactPhoneNumber, ChangeDataTrigger, ChangeDataTriggerOccurrenceLog, ChangeDataTriggerCriteria, NotificationTemplate, ChangeDataTriggerCriteriaParameter, ChangeDataTriggerNotificationEvent, NotificationTemplateParameter, ChangeDataTriggerNotificationEventAttachment, ChangeDataTriggerNotificationEventAttachmentParameter, RequestType, Category, Commodity, MaterialMaster, MaterialMasterAttribute, MaterialMasterDocument, MaterialMasterBin, MaterialMasterSupplier, MaterialMasterLinkWarehouse, StockItem, StockItemFileAttachment, StockItemAttribute, StockItemDocument, StockItemBin, StockItemSupplier, WarehouseAttribute, Warehouse, WarehouseDocument, Requisition, RequisitionFileAttachment, RequisitionStatus, RequisitionStatusChange, RequisitionStatusAttribute, RequisitionStatusDocument, RequisitionStatusChangeHistory, RequisitionItemTransaction, ApprovalRole, RequisitionAttribute, RequisitionDocument, RequisitionTransaction, RequisitionItem, RequisitionItemFileAttachment, UserSiteApprovalRole, ApprovalWorkflow, ApprovalWorkflowExpression, ApprovalWorkflowExpressionApprovalRole, Competency, Resource, ResourceAttribute, ResourceAddress, ResourceClassification, ResourceCompetency, ResourceDocument, ResourceEmail, ResourcePhoneNumber, ResourceTrade, ResourceTradeCompetency, ResourceTradeFinancialRate, Section, SectionAttribute, SectionDocument, SectionTrade, TradeAttribute, TradeDocument, Trade, TradeCompetency, TradeFinancialRate, ResourceContext, ResourceFileAttachment, AssetImportance, RiskConsequence, RiskConsequenceCategory, RiskModel, RiskModelConsequenceCategory, RiskModelImportance, RiskModelProbability, RiskProbability, WorkOrderImportance, WorkOrderStatus, WorkOrderStatusAttribute, WorkOrderStatusDocument, WorkOrderStatusAllowedChange, WorkOrder, WorkOrderStatusChangeHistory, WorkOrderStatusChange, WorkOrderMerge, WorkOrderSplit, WorkOrderMeter, WorkOrderAttribute, WorkOrderDocument, WorkOrderFileAttachment, WorkOrderTaskFileAttachment, WorkOrderTaskWarranty, WorkOrderTaskSpareFileAttachment, WorkOrderTask, WorkOrderTaskDocument, WorkOrderTaskAdHocCost, WorkOrderMonitoringPoint, WorkOrderTaskMonitoringPoint, WorkOrderTaskSpare, WorkOrderTaskSubTask, WorkOrderTaskResource, WorkOrderTaskResourceUsage, DueTask, DueTaskSuppressor, ProposedWorkOrderBatch, ProposedWorkOrder, ProposedWorkOrderTask, ProposedWorkOrderMeter, WorkOrderMovement, WorkOrderTaskMovement, WorkOrderTaskResourceMovement, WorkOrderTaskSpareMovement, WorkOrderTaskSubTaskMovement, WorkOrderCompleteAllTasksLog, WorkRequest, WorkRequestAttribute, WorkRequestDocument, WorkRequestStatus, WorkRequestStatusChange, WorkRequestStatusChangeHistory, WorkRequestFileAttachment, WorkOrderDowntimeLoss, WorkOrderProgressEvent, WorkOrderProgressEventAllowedChange, WorkOrderProgressLog, WorkOrderWarranty, ServiceLevelAgreementClassification, ServiceLevelAgreement, ServiceLevelAgreementMeasure, WorkOrderServiceLevelAgreement, WorkOrderServiceLevelAgreementMeasure, ServiceLevelAgreementMeasureTrigger, ServiceLevelAgreementMeasureFieldAssignment, PermissionTree, User, UserAttribute, UserDocument, UserAuthentication, SecurityRole, SecurityRolePermission, UserSecurityRole, UserCustomPermission, UserOption, BackgroundTask, BackgroundTaskStep, ScheduledBackgroundTask, ScheduledJob, UserDefinedField, UserDefinedFieldPredefinedValue, SystemOption, SystemOptionPageLimit, SystemOptionWorkOrderStatus, SystemOptionDefaultStandardTask, SystemOptionWorkOrderStatusTypeOfWork, SystemOptionReferenceDataViewPermission, SystemOptionFileAttachmentCategory, SystemOptionFileAttachmentFileType, RecordChange, RecordChangeValue, RecordChangeUser, RecordChangeProperty, NotificationEventOutbox, NotificationEventAttachmentOutbox, NotificationOutbox, NotificationOutboxLog, ChangeDataTriggerCriteriaEvaluation, SystemOptionReportServerEntity, SystemOptionReportServerEntityDefaultReport, TemplateMigrationLog, TemplateMigrationLogIntent, ResourceActionMigrationLog, ImportSchema, ImportFile, UserDefinedQuery, ResourceActionCustomisation, TemplateCustomisation, TemplateResource, ClusterSettings, ClusterIdentityProviderSettings, MessageBrokerHost, MessageBrokerTopic, MessageBrokerTopicConsumer, TenantSettings, TenantChangeDataSubscriptionSettings, TenantIdentityProviderSettings, TenantJobSettings, TenantFileContentStoreLocationSettings, TenantFileContentStoreFileTypeGroupSettings, TenantFileContentStoreFileTypeSettings, ClusterFeatureToggle, TenantFeatureToggle, TenantHealthCheck, TenantMachineHealthCheck, ClusterHealthCheck, ClusterMachineHealthCheck, ClusterCapacitySlot, TenantChangeLogCleanupExpressionSettings, ClusterJobSettings, Ignore]) | enum |\r\n| comment | MyApproval->Comment | 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\r\n", "operationId": "BatchApproveMyApproval", "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/BatchApproveMyApprovalResourceActionRequest" } }, { "$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/IDENTITY/BackgroundTasks/Batch/{ids}/Cancel": { "post": { "tags": [ "My Identity" ], "summary": "Cancel the work registered for the collection of my Background Task resources.", "description": "", "operationId": "BatchCancelMyBackgroundTask", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of My Identity id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$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" } } } }, "TranslationSetSchema": { "type": "object", "required": [ "id", "name", "items" ], "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "langId": { "type": "integer", "format": "int64" }, "lang": { "type": "string" }, "items": { "type": "array", "items": { "$ref": "#/definitions/TranslationSchema" } } } }, "TranslationSchema": { "type": "object", "required": [ "name", "value", "source" ], "properties": { "name": { "type": "string" }, "value": { "type": "string" }, "source": { "$ref": "#/definitions/TranslationSource" } } }, "TranslationSource": { "type": "string", "description": "", "x-enumNames": [ "System", "User" ], "enum": [ "System", "User" ] }, "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" ] }, "GetMyBackgroundTasksSummaryResourceActionResponse": { "title": "GetMyBackgroundTasksSummaryResourceActionResponse", "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": "GetMyBackgroundTasksSummaryResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "abortedCount": { "title": "abortedCount", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "BackgroundTasksSummary->AbortedCount" }, "cancelledCount": { "title": "cancelledCount", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "BackgroundTasksSummary->CancelledCount" }, "completedCount": { "title": "completedCount", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "BackgroundTasksSummary->CompletedCount" }, "notStartedCount": { "title": "notStartedCount", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "BackgroundTasksSummary->NotStartedCount" }, "runningCount": { "title": "runningCount", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "BackgroundTasksSummary->RunningCount" }, "totalCount": { "title": "totalCount", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "BackgroundTasksSummary->TotalCount" } } }, "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" } } }, "GetMyDefaultAMPCUserOptionsResourceActionResponse": { "title": "GetMyDefaultAMPCUserOptionsResourceActionResponse", "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": "GetMyDefaultAMPCUserOptionsResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "taskResponsibleSectionId": { "title": "taskResponsibleSectionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "GetMyDefaultAMPCUserOptionsValues->TaskResponsibleSectionId" }, "taskResponsibleStaffId": { "title": "taskResponsibleStaffId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "GetMyDefaultAMPCUserOptionsValues->TaskResponsibleStaffId" }, "taskResponsibleTradeId": { "title": "taskResponsibleTradeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "GetMyDefaultAMPCUserOptionsValues->TaskResponsibleTradeId" } } }, "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" } } }, "GetMyDefaultFINUserOptionsResourceActionResponse": { "title": "GetMyDefaultFINUserOptionsResourceActionResponse", "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": "GetMyDefaultFINUserOptionsResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "enableCosting": { "title": "enableCosting", "type": "boolean", "x-nullable": true, "x-propertyPath": "GetMyDefaultFINUserOptionsValues->EnableCosting" } } }, "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" } } }, "GetMyDefaultMMUserOptionsResourceActionResponse": { "title": "GetMyDefaultMMUserOptionsResourceActionResponse", "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": "GetMyDefaultMMUserOptionsResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "enableRequisitions": { "title": "enableRequisitions", "type": "boolean", "x-nullable": true, "x-propertyPath": "GetMyDefaultMMUserOptionsValues->EnableRequisitions" } } }, "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" } } }, "GetMyDefaultUserOptionsResourceActionResponse": { "title": "GetMyDefaultUserOptionsResourceActionResponse", "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": "GetMyDefaultUserOptionsResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "enableCosting": { "title": "enableCosting", "type": "boolean", "x-nullable": true, "x-propertyPath": "GetMyDefaultUserOptionsValues->EnableCosting" }, "enableRequisitions": { "title": "enableRequisitions", "type": "boolean", "x-nullable": true, "x-propertyPath": "GetMyDefaultUserOptionsValues->EnableRequisitions" }, "applyWorkOrderStatusRules": { "title": "applyWorkOrderStatusRules", "type": "boolean", "x-nullable": true, "x-propertyPath": "GetMyDefaultUserOptionsValues->ApplyWorkOrderStatusRules" }, "defaultWorkOrderTaskResourceCostElementId": { "title": "defaultWorkOrderTaskResourceCostElementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "GetMyDefaultUserOptionsValues->DefaultWorkOrderTaskResourceCostElementId" }, "taskResponsibleSectionId": { "title": "taskResponsibleSectionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "GetMyDefaultUserOptionsValues->TaskResponsibleSectionId" }, "taskResponsibleStaffId": { "title": "taskResponsibleStaffId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "GetMyDefaultUserOptionsValues->TaskResponsibleStaffId" }, "taskResponsibleTradeId": { "title": "taskResponsibleTradeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "GetMyDefaultUserOptionsValues->TaskResponsibleTradeId" }, "workClassification1Id": { "title": "workClassification1Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "GetMyDefaultUserOptionsValues->WorkClassification1Id" }, "workClassification2Id": { "title": "workClassification2Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "GetMyDefaultUserOptionsValues->WorkClassification2Id" }, "workClassification3Id": { "title": "workClassification3Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "GetMyDefaultUserOptionsValues->WorkClassification3Id" }, "workClassification4Id": { "title": "workClassification4Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "GetMyDefaultUserOptionsValues->WorkClassification4Id" }, "workClassification5Id": { "title": "workClassification5Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "GetMyDefaultUserOptionsValues->WorkClassification5Id" }, "workOrderCanBeQueued": { "title": "workOrderCanBeQueued", "type": "boolean", "x-nullable": true, "x-propertyPath": "GetMyDefaultUserOptionsValues->WorkOrderCanBeQueued" }, "workOrderImportanceId": { "title": "workOrderImportanceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "GetMyDefaultUserOptionsValues->WorkOrderImportanceId" }, "workOrderLimit": { "title": "workOrderLimit", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "GetMyDefaultUserOptionsValues->WorkOrderLimit" }, "workOrderResponsibleSectionId": { "title": "workOrderResponsibleSectionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "GetMyDefaultUserOptionsValues->WorkOrderResponsibleSectionId" }, "workOrderResponsibleStaffId": { "title": "workOrderResponsibleStaffId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "GetMyDefaultUserOptionsValues->WorkOrderResponsibleStaffId" }, "workOrderResponsibleTradeId": { "title": "workOrderResponsibleTradeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "GetMyDefaultUserOptionsValues->WorkOrderResponsibleTradeId" }, "workOrderTypeOfWorkForConditionMonitoringId": { "title": "workOrderTypeOfWorkForConditionMonitoringId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "GetMyDefaultUserOptionsValues->WorkOrderTypeOfWorkForConditionMonitoringId" }, "workOrderTypeOfWorkId": { "title": "workOrderTypeOfWorkId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "GetMyDefaultUserOptionsValues->WorkOrderTypeOfWorkId" } } }, "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" } } }, "GetMyDefaultWMUserOptionsResourceActionResponse": { "title": "GetMyDefaultWMUserOptionsResourceActionResponse", "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": "GetMyDefaultWMUserOptionsResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "applyWorkOrderStatusRules": { "title": "applyWorkOrderStatusRules", "type": "boolean", "x-nullable": true, "x-propertyPath": "GetMyDefaultWMUserOptionsValues->ApplyWorkOrderStatusRules" }, "defaultWorkOrderTaskResourceCostElementId": { "title": "defaultWorkOrderTaskResourceCostElementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "GetMyDefaultWMUserOptionsValues->DefaultWorkOrderTaskResourceCostElementId" }, "workClassification1Id": { "title": "workClassification1Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "GetMyDefaultWMUserOptionsValues->WorkClassification1Id" }, "workClassification2Id": { "title": "workClassification2Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "GetMyDefaultWMUserOptionsValues->WorkClassification2Id" }, "workClassification3Id": { "title": "workClassification3Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "GetMyDefaultWMUserOptionsValues->WorkClassification3Id" }, "workClassification4Id": { "title": "workClassification4Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "GetMyDefaultWMUserOptionsValues->WorkClassification4Id" }, "workClassification5Id": { "title": "workClassification5Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "GetMyDefaultWMUserOptionsValues->WorkClassification5Id" }, "workOrderCanBeQueued": { "title": "workOrderCanBeQueued", "type": "boolean", "x-nullable": true, "x-propertyPath": "GetMyDefaultWMUserOptionsValues->WorkOrderCanBeQueued" }, "workOrderImportanceId": { "title": "workOrderImportanceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "GetMyDefaultWMUserOptionsValues->WorkOrderImportanceId" }, "workOrderLimit": { "title": "workOrderLimit", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "GetMyDefaultWMUserOptionsValues->WorkOrderLimit" }, "workOrderResponsibleSectionId": { "title": "workOrderResponsibleSectionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "GetMyDefaultWMUserOptionsValues->WorkOrderResponsibleSectionId" }, "workOrderResponsibleStaffId": { "title": "workOrderResponsibleStaffId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "GetMyDefaultWMUserOptionsValues->WorkOrderResponsibleStaffId" }, "workOrderResponsibleTradeId": { "title": "workOrderResponsibleTradeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "GetMyDefaultWMUserOptionsValues->WorkOrderResponsibleTradeId" }, "workOrderTypeOfWorkForConditionMonitoringId": { "title": "workOrderTypeOfWorkForConditionMonitoringId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "GetMyDefaultWMUserOptionsValues->WorkOrderTypeOfWorkForConditionMonitoringId" }, "workOrderTypeOfWorkId": { "title": "workOrderTypeOfWorkId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "GetMyDefaultWMUserOptionsValues->WorkOrderTypeOfWorkId" } } }, "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" } } }, "GetMyOperationalRoleResourceCustomisationForOperationalRoleResourceActionResponse": { "title": "GetMyOperationalRoleResourceCustomisationForOperationalRoleResourceActionResponse", "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": "GetMyOperationalRoleResourceCustomisationForOperationalRoleResourceActionResponseProperties", "type": "object", "x-nullable": false }, "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" } } }, "GetMyOperationalRoleResourceForOperationalRoleResourceActionResponse": { "title": "GetMyOperationalRoleResourceForOperationalRoleResourceActionResponse", "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": "GetMyOperationalRoleResourceForOperationalRoleResourceActionResponseProperties", "type": "object", "x-nullable": false }, "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" } } }, "GetMyOperationalRoleResourceResourceActionResponse": { "title": "GetMyOperationalRoleResourceResourceActionResponse", "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": "GetMyOperationalRoleResourceResourceActionResponseProperties", "type": "object", "x-nullable": false }, "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" } } }, "GetMyOperationalRoleTemplateResourceActionResponse": { "title": "GetMyOperationalRoleTemplateResourceActionResponse", "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": "GetMyOperationalRoleTemplateResourceActionResponseProperties", "type": "object", "x-nullable": false }, "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" } } }, "GetMyTermsAndConditionResourceActionResponse": { "title": "GetMyTermsAndConditionResourceActionResponse", "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": "GetMyTermsAndConditionResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserTermsAndConditionVersion->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "UserTermsAndConditionVersion->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "UserTermsAndConditionVersion->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "UserTermsAndConditionVersion->CreatedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "UserTermsAndConditionVersion->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "UserTermsAndConditionVersion->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "UserTermsAndConditionVersion->PermissionTree_Description" }, "accepted": { "title": "accepted", "type": "boolean", "x-nullable": false, "x-propertyPath": "UserTermsAndConditionVersion->Accepted" }, "acceptedDate": { "title": "acceptedDate", "type": "string", "format": "date", "x-nullable": true, "example": "2005-04-20", "x-propertyPath": "UserTermsAndConditionVersion->AcceptedDate" }, "deprecated": { "title": "deprecated", "type": "boolean", "x-nullable": false, "x-propertyPath": "UserTermsAndConditionVersion->Deprecated" }, "termsAndConditionVersionId": { "title": "termsAndConditionVersionId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "UserTermsAndConditionVersion->TermsAndConditionVersion_Id" }, "termsAndConditionVersionContentVersion": { "title": "termsAndConditionVersionContentVersion", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "UserTermsAndConditionVersion->TermsAndConditionVersion_ContentVersion" }, "termsAndConditionVersionLanguageId": { "title": "termsAndConditionVersionLanguageId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserTermsAndConditionVersion->TermsAndConditionVersion_Language_Id" }, "termsAndConditionVersionLanguageCode": { "title": "termsAndConditionVersionLanguageCode", "type": "string", "x-nullable": true, "x-propertyPath": "UserTermsAndConditionVersion->TermsAndConditionVersion_Language_Code" }, "termsAndConditionVersionTermsAndConditionId": { "title": "termsAndConditionVersionTermsAndConditionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserTermsAndConditionVersion->TermsAndConditionVersion_TermsAndCondition_Id" }, "termsAndConditionVersionTermsAndConditionName": { "title": "termsAndConditionVersionTermsAndConditionName", "type": "string", "x-nullable": true, "x-propertyPath": "UserTermsAndConditionVersion->TermsAndConditionVersion_TermsAndCondition_Name" }, "termsAndConditionVersionContent": { "title": "termsAndConditionVersionContent", "type": "string", "x-nullable": true, "x-propertyPath": "UserTermsAndConditionVersion->TermsAndConditionVersion_Content" }, "userId": { "title": "userId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "UserTermsAndConditionVersion->User_Id" }, "userCode": { "title": "userCode", "type": "string", "x-nullable": true, "x-propertyPath": "UserTermsAndConditionVersion->User_Code" }, "userFullName": { "title": "userFullName", "type": "string", "x-nullable": true, "x-propertyPath": "UserTermsAndConditionVersion->User_FullName" } } }, "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" } } }, "GetMyUserSummaryResourceActionResponse": { "title": "GetMyUserSummaryResourceActionResponse", "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": "GetMyUserSummaryResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "allowWorkOrdersWithoutAssets": { "title": "allowWorkOrdersWithoutAssets", "type": "boolean", "x-nullable": true, "x-propertyPath": "MyUserSummary->AllowWorkOrdersWithoutAssets" }, "applyWorkOrderStatusRules": { "title": "applyWorkOrderStatusRules", "type": "boolean", "x-nullable": true, "x-propertyPath": "MyUserSummary->ApplyWorkOrderStatusRules" }, "autoPopulateStartOnAndCompleteByDates": { "title": "autoPopulateStartOnAndCompleteByDates", "type": "boolean", "x-nullable": true, "x-propertyPath": "MyUserSummary->AutoPopulateStartOnAndCompleteByDates" }, "code": { "title": "code", "type": "string", "x-nullable": true, "x-propertyPath": "MyUserSummary->Code" }, "contentTranslate": { "title": "contentTranslate", "type": "boolean", "x-nullable": true, "x-propertyPath": "MyUserSummary->ContentTranslate" }, "dateFormat": { "title": "dateFormat", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "MyUserSummary->DateFormat", "x-formatSpecifier": "SystemDateFormat" }, "dateSeparator": { "title": "dateSeparator", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "MyUserSummary->DateSeparator", "x-formatSpecifier": "SystemDateSeparator" }, "defaultAssetDevelopmentStatusApplyToChildren": { "title": "defaultAssetDevelopmentStatusApplyToChildren", "type": "boolean", "x-nullable": true, "x-propertyPath": "MyUserSummary->DefaultAssetDevelopmentStatusApplyToChildren" }, "defaultAssetTypeDevelopmentStatusApplyToChildren": { "title": "defaultAssetTypeDevelopmentStatusApplyToChildren", "type": "boolean", "x-nullable": true, "x-propertyPath": "MyUserSummary->DefaultAssetTypeDevelopmentStatusApplyToChildren" }, "defaultAssetTypeDevelopmentStatusApplyToDescendants": { "title": "defaultAssetTypeDevelopmentStatusApplyToDescendants", "type": "boolean", "x-nullable": true, "x-propertyPath": "MyUserSummary->DefaultAssetTypeDevelopmentStatusApplyToDescendants" }, "defaultCreateSaveAction": { "title": "defaultCreateSaveAction", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "MyUserSummary->DefaultCreateSaveAction", "x-formatSpecifier": "DefaultCreateSaveAction" }, "defaultIsActiveApplyToChildren": { "title": "defaultIsActiveApplyToChildren", "type": "boolean", "x-nullable": true, "x-propertyPath": "MyUserSummary->DefaultIsActiveApplyToChildren" }, "defaultIsActiveApplyToDescendants": { "title": "defaultIsActiveApplyToDescendants", "type": "boolean", "x-nullable": true, "x-propertyPath": "MyUserSummary->DefaultIsActiveApplyToDescendants" }, "defaultIsActiveApplyToDetails": { "title": "defaultIsActiveApplyToDetails", "type": "boolean", "x-nullable": true, "x-propertyPath": "MyUserSummary->DefaultIsActiveApplyToDetails" }, "defaultLanguageId": { "title": "defaultLanguageId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "MyUserSummary->DefaultLanguage_Id" }, "defaultLanguageCode": { "title": "defaultLanguageCode", "type": "string", "x-nullable": true, "x-propertyPath": "MyUserSummary->DefaultLanguage_Code" }, "defaultLanguageDescription": { "title": "defaultLanguageDescription", "type": "string", "x-nullable": true, "x-propertyPath": "MyUserSummary->DefaultLanguage_Description" }, "defaultSyncDevelopmentStatusApplyToChildren": { "title": "defaultSyncDevelopmentStatusApplyToChildren", "type": "boolean", "x-nullable": true, "x-propertyPath": "MyUserSummary->DefaultSyncDevelopmentStatusApplyToChildren" }, "defaultTradeLookup": { "title": "defaultTradeLookup", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "MyUserSummary->DefaultTradeLookup", "x-formatSpecifier": "DefaultTradeLookup" }, "defaultUpdateSaveAction": { "title": "defaultUpdateSaveAction", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "MyUserSummary->DefaultUpdateSaveAction", "x-formatSpecifier": "DefaultUpdateSaveAction" }, "enforceAssetWarranty": { "title": "enforceAssetWarranty", "type": "boolean", "x-nullable": true, "x-propertyPath": "MyUserSummary->EnforceAssetWarranty" }, "fullName": { "title": "fullName", "type": "string", "x-nullable": true, "x-propertyPath": "MyUserSummary->FullName" }, "isReportUser": { "title": "isReportUser", "type": "boolean", "x-nullable": true, "x-propertyPath": "MyUserSummary->IsReportUser" }, "mergeAllowedWorkOrderStatus": { "title": "mergeAllowedWorkOrderStatus", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "MyUserSummary->MergeAllowedWorkOrderStatus", "x-formatSpecifier": "SystemOptionMergeAllowedWorkOrderStatus" }, "mergeTypeOfWorkOption": { "title": "mergeTypeOfWorkOption", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "MyUserSummary->MergeTypeOfWorkOption", "x-formatSpecifier": "SystemOptionMergeTypeOfWorkOption" }, "operationalRoleRule": { "title": "operationalRoleRule", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "MyUserSummary->OperationalRoleRule", "x-formatSpecifier": "OperationalRoleRuleType" }, "primaryEmail": { "title": "primaryEmail", "type": "string", "format": "email", "x-nullable": true, "x-propertyPath": "MyUserSummary->PrimaryEmail" }, "reportServerReportLanguage": { "title": "reportServerReportLanguage", "type": "string", "x-nullable": true, "x-propertyPath": "MyUserSummary->ReportServerReportLanguage" }, "reportServerUILanguage": { "title": "reportServerUILanguage", "type": "string", "x-nullable": true, "x-propertyPath": "MyUserSummary->ReportServerUILanguage" }, "reportUserName": { "title": "reportUserName", "type": "string", "x-nullable": true, "x-propertyPath": "MyUserSummary->ReportUserName" }, "reportUserOrganizations": { "title": "reportUserOrganizations", "type": "array", "format": "array", "x-nullable": true, "items": { "type": "string" }, "x-propertyPath": "MyUserSummary->ReportUserOrganizations", "x-formatSpecifier": "String" }, "reportUserRoles": { "title": "reportUserRoles", "type": "array", "format": "array", "x-nullable": true, "items": { "type": "string" }, "x-propertyPath": "MyUserSummary->ReportUserRoles", "x-formatSpecifier": "String" }, "siteId": { "title": "siteId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "MyUserSummary->Site_Id" }, "siteCode": { "title": "siteCode", "type": "string", "x-nullable": true, "x-propertyPath": "MyUserSummary->Site_Code" }, "siteDescription": { "title": "siteDescription", "type": "string", "x-nullable": true, "x-propertyPath": "MyUserSummary->Site_Description" }, "systemDateFormat": { "title": "systemDateFormat", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "MyUserSummary->SystemDateFormat", "x-formatSpecifier": "SystemDateFormat" }, "systemDateSeparator": { "title": "systemDateSeparator", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "MyUserSummary->SystemDateSeparator", "x-formatSpecifier": "SystemDateSeparator" }, "systemDefaultCreateSaveAction": { "title": "systemDefaultCreateSaveAction", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "MyUserSummary->SystemDefaultCreateSaveAction", "x-formatSpecifier": "DefaultCreateSaveAction" }, "systemDefaultLanguageId": { "title": "systemDefaultLanguageId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "MyUserSummary->SystemDefaultLanguage_Id" }, "systemDefaultLanguageCode": { "title": "systemDefaultLanguageCode", "type": "string", "x-nullable": true, "x-propertyPath": "MyUserSummary->SystemDefaultLanguage_Code" }, "systemDefaultLanguageDescription": { "title": "systemDefaultLanguageDescription", "type": "string", "x-nullable": true, "x-propertyPath": "MyUserSummary->SystemDefaultLanguage_Description" }, "systemDefaultUpdateSaveAction": { "title": "systemDefaultUpdateSaveAction", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "MyUserSummary->SystemDefaultUpdateSaveAction", "x-formatSpecifier": "DefaultUpdateSaveAction" }, "systemTimeFormat": { "title": "systemTimeFormat", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "MyUserSummary->SystemTimeFormat", "x-formatSpecifier": "SystemTimeFormat" }, "timeFormat": { "title": "timeFormat", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "MyUserSummary->TimeFormat", "x-formatSpecifier": "SystemTimeFormat" }, "workPerformedEditableBaseStatus": { "title": "workPerformedEditableBaseStatus", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "MyUserSummary->WorkPerformedEditableBaseStatus", "x-formatSpecifier": "WorkPerformedEditableBaseStatus" } } }, "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" } } }, "GetMyBackgroundTaskErrorListResourceActionResponse": { "title": "GetMyBackgroundTaskErrorListResourceActionResponse", "type": "object", "properties": { "id": { "title": "id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "BackgroundTaskError->Id" }, "code": { "title": "code", "type": "string", "x-nullable": true, "x-propertyPath": "BackgroundTaskError->Code" }, "completedOn": { "title": "completedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "BackgroundTaskError->CompletedOn" }, "objectType": { "title": "objectType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "BackgroundTaskError->ObjectType", "x-formatSpecifier": "EntityType" }, "message": { "title": "message", "type": "string", "format": "memo", "x-nullable": true, "x-propertyPath": "BackgroundTaskError->Message" }, "type": { "title": "type", "type": "string", "x-nullable": true, "x-propertyPath": "BackgroundTaskError->Type" }, "objectId": { "title": "objectId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "BackgroundTaskError->ObjectId" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "BackgroundTaskError->SequenceNumber" }, "severity": { "title": "severity", "type": "string", "x-nullable": true, "x-propertyPath": "BackgroundTaskError->Severity" }, "startedOn": { "title": "startedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "BackgroundTaskError->StartedOn" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "BackgroundTaskError->CreatedByUserId" } } }, "GetMyBackgroundTaskErrorListResourceAction": { "title": "GetMyBackgroundTaskErrorListResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of My Identity entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of My Identity entities", "items": { "$ref": "#/definitions/GetMyBackgroundTaskErrorListResourceActionResponse" } }, "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" } } }, "GetMyApprovalForRequisitionCollectionResourceActionResponse": { "title": "GetMyApprovalForRequisitionCollectionResourceActionResponse", "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": "GetMyApprovalForRequisitionCollectionResourceActionResponseItem", "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": "GetMyApprovalForRequisitionCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Requisition->Code" }, "workOrderCode": { "title": "workOrderCode", "type": "string", "x-nullable": false, "x-propertyPath": "Requisition->WorkOrder_Code" }, "workOrderDescription": { "title": "workOrderDescription", "type": "string", "x-nullable": false, "x-propertyPath": "Requisition->WorkOrder_Description" }, "totalItemCost": { "title": "totalItemCost", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "Requisition->TotalItemCost" }, "idApprovalEntityIdEntityId": { "title": "idApprovalEntityIdEntityId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Requisition->*Id.Approval.EntityId_EntityId" }, "idApprovalEntityIdSequenceNumber": { "title": "idApprovalEntityIdSequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "Requisition->*Id.Approval.EntityId_SequenceNumber" }, "idApprovalEntityIdExpressionId": { "title": "idApprovalEntityIdExpressionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Requisition->*Id.Approval.EntityId_Expression_Id" }, "idApprovalEntityIdExpressionApprovalWorkflowId": { "title": "idApprovalEntityIdExpressionApprovalWorkflowId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Requisition->*Id.Approval.EntityId_Expression_ApprovalWorkflow_Id" }, "idApprovalEntityIdExpressionApprovalWorkflowCode": { "title": "idApprovalEntityIdExpressionApprovalWorkflowCode", "type": "string", "x-nullable": false, "x-propertyPath": "Requisition->*Id.Approval.EntityId_Expression_ApprovalWorkflow_Code" }, "idApprovalEntityIdExpressionDescription": { "title": "idApprovalEntityIdExpressionDescription", "type": "string", "x-nullable": false, "x-propertyPath": "Requisition->*Id.Approval.EntityId_Expression_Description" }, "idApprovalEntityIdId": { "title": "idApprovalEntityIdId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Requisition->*Id.Approval.EntityId_Id" }, "idApprovalEntityIdIsLocked": { "title": "idApprovalEntityIdIsLocked", "type": "boolean", "x-nullable": true, "x-propertyPath": "Requisition->*Id.Approval.EntityId_IsLocked" }, "idApprovalEntityIdEntityType": { "title": "idApprovalEntityIdEntityType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "Requisition->*Id.Approval.EntityId_EntityType", "x-formatSpecifier": "EntityType" }, "idApprovalEntityIdRemark": { "title": "idApprovalEntityIdRemark", "type": "string", "x-nullable": true, "x-propertyPath": "Requisition->*Id.Approval.EntityId_Remark" }, "idApprovalEntityIdRoleId": { "title": "idApprovalEntityIdRoleId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Requisition->*Id.Approval.EntityId_Role_Id" }, "idApprovalEntityIdRoleCode": { "title": "idApprovalEntityIdRoleCode", "type": "string", "x-nullable": false, "x-propertyPath": "Requisition->*Id.Approval.EntityId_Role_Code" }, "idApprovalEntityIdRoleDescription": { "title": "idApprovalEntityIdRoleDescription", "type": "string", "x-nullable": false, "x-propertyPath": "Requisition->*Id.Approval.EntityId_Role_Description" }, "idApprovalEntityIdStatus": { "title": "idApprovalEntityIdStatus", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "Requisition->*Id.Approval.EntityId_Status", "x-formatSpecifier": "ApprovalStatus" } } }, "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" } } } }, "GetMyApprovalForRequisitionItemCollectionResourceActionResponse": { "title": "GetMyApprovalForRequisitionItemCollectionResourceActionResponse", "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": "GetMyApprovalForRequisitionItemCollectionResourceActionResponseItem", "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": "GetMyApprovalForRequisitionItemCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": true, "x-propertyPath": "RequisitionItem->Code" }, "description": { "title": "description", "type": "string", "x-nullable": true, "x-propertyPath": "RequisitionItem->Description" }, "requisitionId": { "title": "requisitionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RequisitionItem->Requisition_Id" }, "requisitionCode": { "title": "requisitionCode", "type": "string", "x-nullable": false, "x-propertyPath": "RequisitionItem->Requisition_Code" }, "requisitionWorkOrderCode": { "title": "requisitionWorkOrderCode", "type": "string", "x-nullable": false, "x-propertyPath": "RequisitionItem->Requisition_WorkOrder_Code" }, "requisitionWorkOrderDescription": { "title": "requisitionWorkOrderDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RequisitionItem->Requisition_WorkOrder_Description" }, "totalCostInSiteCurrency": { "title": "totalCostInSiteCurrency", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "RequisitionItem->TotalCostInSiteCurrency" }, "workOrderTaskSpareSpareType": { "title": "workOrderTaskSpareSpareType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RequisitionItem->WorkOrderTaskSpare_SpareType", "x-formatSpecifier": "WorkOrderTaskSpareType" }, "idApprovalEntityIdEntityId": { "title": "idApprovalEntityIdEntityId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RequisitionItem->*Id.Approval.EntityId_EntityId" }, "idApprovalEntityIdSequenceNumber": { "title": "idApprovalEntityIdSequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RequisitionItem->*Id.Approval.EntityId_SequenceNumber" }, "idApprovalEntityIdExpressionId": { "title": "idApprovalEntityIdExpressionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RequisitionItem->*Id.Approval.EntityId_Expression_Id" }, "idApprovalEntityIdExpressionApprovalWorkflowId": { "title": "idApprovalEntityIdExpressionApprovalWorkflowId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RequisitionItem->*Id.Approval.EntityId_Expression_ApprovalWorkflow_Id" }, "idApprovalEntityIdExpressionApprovalWorkflowCode": { "title": "idApprovalEntityIdExpressionApprovalWorkflowCode", "type": "string", "x-nullable": false, "x-propertyPath": "RequisitionItem->*Id.Approval.EntityId_Expression_ApprovalWorkflow_Code" }, "idApprovalEntityIdExpressionDescription": { "title": "idApprovalEntityIdExpressionDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RequisitionItem->*Id.Approval.EntityId_Expression_Description" }, "idApprovalEntityIdId": { "title": "idApprovalEntityIdId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RequisitionItem->*Id.Approval.EntityId_Id" }, "idApprovalEntityIdIsLocked": { "title": "idApprovalEntityIdIsLocked", "type": "boolean", "x-nullable": true, "x-propertyPath": "RequisitionItem->*Id.Approval.EntityId_IsLocked" }, "idApprovalEntityIdEntityType": { "title": "idApprovalEntityIdEntityType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RequisitionItem->*Id.Approval.EntityId_EntityType", "x-formatSpecifier": "EntityType" }, "idApprovalEntityIdRemark": { "title": "idApprovalEntityIdRemark", "type": "string", "x-nullable": true, "x-propertyPath": "RequisitionItem->*Id.Approval.EntityId_Remark" }, "idApprovalEntityIdRoleCode": { "title": "idApprovalEntityIdRoleCode", "type": "string", "x-nullable": false, "x-propertyPath": "RequisitionItem->*Id.Approval.EntityId_Role_Code" }, "idApprovalEntityIdRoleDescription": { "title": "idApprovalEntityIdRoleDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RequisitionItem->*Id.Approval.EntityId_Role_Description" }, "idApprovalEntityIdStatus": { "title": "idApprovalEntityIdStatus", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RequisitionItem->*Id.Approval.EntityId_Status", "x-formatSpecifier": "ApprovalStatus" } } }, "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" } } } }, "GetMyBackgroundTaskCollectionResourceActionResponse": { "title": "GetMyBackgroundTaskCollectionResourceActionResponse", "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": "GetMyBackgroundTaskCollectionResourceActionResponseItem", "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": "GetMyBackgroundTaskCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "name": { "title": "name", "type": "string", "x-nullable": true, "x-propertyPath": "BackgroundTask->Name" }, "type": { "title": "type", "type": "string", "x-nullable": true, "x-propertyPath": "BackgroundTask->Type" }, "origin": { "title": "origin", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "BackgroundTask->Origin", "x-formatSpecifier": "BackgroundTaskOrigin" }, "priority": { "title": "priority", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "BackgroundTask->Priority" }, "status": { "title": "status", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "BackgroundTask->Status", "x-formatSpecifier": "BackgroundTaskStatus" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "BackgroundTask->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "BackgroundTask->ModifiedOn" }, "startedOn": { "title": "startedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "BackgroundTask->StartedOn" }, "completedOn": { "title": "completedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "BackgroundTask->CompletedOn" }, "totalSteps": { "title": "totalSteps", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "BackgroundTask->TotalSteps" }, "failedSteps": { "title": "failedSteps", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "BackgroundTask->FailedSteps" }, "completedSteps": { "title": "completedSteps", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "BackgroundTask->CompletedSteps" }, "remainingSteps": { "title": "remainingSteps", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "BackgroundTask->RemainingSteps" }, "skippedSteps": { "title": "skippedSteps", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "BackgroundTask->SkippedSteps" }, "elapsedTime": { "title": "elapsedTime", "type": "string", "format": "duration", "x-nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "BackgroundTask->ElapsedTime" }, "averageTimePerStep": { "title": "averageTimePerStep", "type": "string", "format": "duration", "x-nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "BackgroundTask->AverageTimePerStep" }, "estimatedTimeRemaining": { "title": "estimatedTimeRemaining", "type": "string", "format": "duration", "x-nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "BackgroundTask->EstimatedTimeRemaining" }, "estimatedCompletion": { "title": "estimatedCompletion", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "BackgroundTask->EstimatedCompletion" } } }, "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" } } } }, "GetMyBackgroundTaskStepForBackgroundTaskCollectionResourceActionResponse": { "title": "GetMyBackgroundTaskStepForBackgroundTaskCollectionResourceActionResponse", "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": "GetMyBackgroundTaskStepForBackgroundTaskCollectionResourceActionResponseItem", "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": "GetMyBackgroundTaskStepForBackgroundTaskCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "name": { "title": "name", "type": "string", "x-nullable": true, "x-propertyPath": "BackgroundTaskStep->Name" }, "backgroundTaskId": { "title": "backgroundTaskId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "BackgroundTaskStep->BackgroundTask_Id" }, "backgroundTaskName": { "title": "backgroundTaskName", "type": "string", "x-nullable": true, "x-propertyPath": "BackgroundTaskStep->BackgroundTask_Name" }, "backgroundTaskType": { "title": "backgroundTaskType", "type": "string", "x-nullable": true, "x-propertyPath": "BackgroundTaskStep->BackgroundTask_Type" }, "backgroundTaskStatus": { "title": "backgroundTaskStatus", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "BackgroundTaskStep->BackgroundTask_Status", "x-formatSpecifier": "BackgroundTaskStatus" }, "backgroundTaskOrigin": { "title": "backgroundTaskOrigin", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "BackgroundTaskStep->BackgroundTask_Origin", "x-formatSpecifier": "BackgroundTaskOrigin" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "BackgroundTaskStep->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "BackgroundTaskStep->ModifiedOn" }, "startedOn": { "title": "startedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "BackgroundTaskStep->StartedOn" }, "completedOn": { "title": "completedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "BackgroundTaskStep->CompletedOn" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "BackgroundTaskStep->SequenceNumber" }, "response": { "title": "response", "x-nullable": true, "$ref": "#/definitions/NotificationSchema", "x-propertyPath": "BackgroundTaskStep->Response" }, "isValid": { "title": "isValid", "type": "boolean", "x-nullable": true, "x-propertyPath": "BackgroundTaskStep->IsValid" } } }, "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" } } } }, "GetMyLanguageCollectionResourceActionResponse": { "title": "GetMyLanguageCollectionResourceActionResponse", "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": "GetMyLanguageCollectionResourceActionResponseItem", "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": "GetMyLanguageCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Language->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "Language->Description" }, "languageCode": { "title": "languageCode", "type": "string", "x-nullable": false, "x-propertyPath": "Language->LanguageCode" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "Language->SequenceNumber" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "Language->IsActive" } } }, "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" } } } }, "GetMyOperationalRoleCollectionResourceActionResponse": { "title": "GetMyOperationalRoleCollectionResourceActionResponse", "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": "GetMyOperationalRoleCollectionResourceActionResponseItem", "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": "GetMyOperationalRoleCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "operationalRoleId": { "title": "operationalRoleId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOperationalRole->OperationalRole_Id" }, "operationalRoleCode": { "title": "operationalRoleCode", "type": "string", "x-nullable": false, "x-propertyPath": "UserOperationalRole->OperationalRole_Code" }, "operationalRoleDescription": { "title": "operationalRoleDescription", "type": "string", "x-nullable": false, "x-propertyPath": "UserOperationalRole->OperationalRole_Description" }, "isDefault": { "title": "isDefault", "type": "boolean", "x-nullable": true, "x-propertyPath": "UserOperationalRole->IsDefault" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "UserOperationalRole->SequenceNumber" } } }, "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" } } } }, "GetMyOperationalRoleResourceCollectionResourceActionResponse": { "title": "GetMyOperationalRoleResourceCollectionResourceActionResponse", "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": "GetMyOperationalRoleResourceCollectionResourceActionResponseItem", "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": "GetMyOperationalRoleResourceCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "userOperationalRoleId": { "title": "userOperationalRoleId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOperationalRoleResource->UserOperationalRole_Id" }, "userOperationalRoleOperationalRoleId": { "title": "userOperationalRoleOperationalRoleId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOperationalRoleResource->UserOperationalRole_OperationalRole_Id" }, "userOperationalRoleOperationalRoleCode": { "title": "userOperationalRoleOperationalRoleCode", "type": "string", "x-nullable": false, "x-propertyPath": "UserOperationalRoleResource->UserOperationalRole_OperationalRole_Code" }, "userOperationalRoleOperationalRoleDescription": { "title": "userOperationalRoleOperationalRoleDescription", "type": "string", "x-nullable": false, "x-propertyPath": "UserOperationalRoleResource->UserOperationalRole_OperationalRole_Description" }, "userOperationalRoleUserId": { "title": "userOperationalRoleUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOperationalRoleResource->UserOperationalRole_User_Id" }, "userOperationalRoleUserFullName": { "title": "userOperationalRoleUserFullName", "type": "string", "x-nullable": false, "x-propertyPath": "UserOperationalRoleResource->UserOperationalRole_User_FullName" }, "resourceActionCustomisationId": { "title": "resourceActionCustomisationId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOperationalRoleResource->ResourceActionCustomisation_Id" }, "resourceActionCustomisationName": { "title": "resourceActionCustomisationName", "type": "string", "x-nullable": false, "x-propertyPath": "UserOperationalRoleResource->ResourceActionCustomisation_Name" }, "module": { "title": "module", "type": "string", "x-nullable": false, "x-propertyPath": "UserOperationalRoleResource->Module" }, "resource": { "title": "resource", "type": "string", "x-nullable": false, "x-propertyPath": "UserOperationalRoleResource->Resource" }, "resourceAction": { "title": "resourceAction", "type": "string", "x-nullable": false, "x-propertyPath": "UserOperationalRoleResource->ResourceAction" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "UserOperationalRoleResource->SequenceNumber" }, "isDefault": { "title": "isDefault", "type": "boolean", "x-nullable": false, "x-propertyPath": "UserOperationalRoleResource->IsDefault" }, "isUserDefault": { "title": "isUserDefault", "type": "boolean", "x-nullable": false, "x-propertyPath": "UserOperationalRoleResource->IsUserDefault" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": true, "x-propertyPath": "UserOperationalRoleResource->IsInherited" } } }, "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" } } } }, "GetMyOperationalRoleTemplateCollectionResourceActionResponse": { "title": "GetMyOperationalRoleTemplateCollectionResourceActionResponse", "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": "GetMyOperationalRoleTemplateCollectionResourceActionResponseItem", "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": "GetMyOperationalRoleTemplateCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "userOperationalRoleId": { "title": "userOperationalRoleId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOperationalRoleTemplate->UserOperationalRole_Id" }, "userOperationalRoleOperationalRoleId": { "title": "userOperationalRoleOperationalRoleId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOperationalRoleTemplate->UserOperationalRole_OperationalRole_Id" }, "userOperationalRoleOperationalRoleCode": { "title": "userOperationalRoleOperationalRoleCode", "type": "string", "x-nullable": false, "x-propertyPath": "UserOperationalRoleTemplate->UserOperationalRole_OperationalRole_Code" }, "userOperationalRoleOperationalRoleDescription": { "title": "userOperationalRoleOperationalRoleDescription", "type": "string", "x-nullable": false, "x-propertyPath": "UserOperationalRoleTemplate->UserOperationalRole_OperationalRole_Description" }, "templateCustomisationId": { "title": "templateCustomisationId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOperationalRoleTemplate->TemplateCustomisation_Id" }, "templateCustomisationName": { "title": "templateCustomisationName", "type": "string", "x-nullable": false, "x-propertyPath": "UserOperationalRoleTemplate->TemplateCustomisation_Name" }, "templateCustomisationDescription": { "title": "templateCustomisationDescription", "type": "string", "x-nullable": true, "x-propertyPath": "UserOperationalRoleTemplate->TemplateCustomisation_Description" }, "templateCustomisationRestrictionLevel": { "title": "templateCustomisationRestrictionLevel", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "UserOperationalRoleTemplate->TemplateCustomisation_RestrictionLevel", "x-formatSpecifier": "RestrictionLevel" }, "module": { "title": "module", "type": "string", "x-nullable": false, "x-propertyPath": "UserOperationalRoleTemplate->Module" }, "template": { "title": "template", "type": "string", "x-nullable": false, "x-propertyPath": "UserOperationalRoleTemplate->Template" }, "type": { "title": "type", "type": "string", "x-nullable": false, "x-propertyPath": "UserOperationalRoleTemplate->Type" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "UserOperationalRoleTemplate->SequenceNumber" }, "isDefault": { "title": "isDefault", "type": "boolean", "x-nullable": false, "x-propertyPath": "UserOperationalRoleTemplate->IsDefault" }, "isUserDefault": { "title": "isUserDefault", "type": "boolean", "x-nullable": false, "x-propertyPath": "UserOperationalRoleTemplate->IsUserDefault" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": true, "x-propertyPath": "UserOperationalRoleTemplate->IsInherited" } } }, "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" } } } }, "GetMyScheduledBackgroundTaskCollectionResourceActionResponse": { "title": "GetMyScheduledBackgroundTaskCollectionResourceActionResponse", "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": "GetMyScheduledBackgroundTaskCollectionResourceActionResponseItem", "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": "GetMyScheduledBackgroundTaskCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "name": { "title": "name", "type": "string", "x-nullable": false, "x-propertyPath": "ScheduledBackgroundTask->Name" }, "type": { "title": "type", "type": "string", "x-nullable": true, "x-propertyPath": "ScheduledBackgroundTask->Type" }, "jobId": { "title": "jobId", "type": "string", "format": "uuid", "x-nullable": false, "example": "f81d4fae-7dec-11d0-a765-00a0c91e6bf6", "x-propertyPath": "ScheduledBackgroundTask->JobId" }, "schedule": { "title": "schedule", "type": "string", "x-nullable": true, "x-propertyPath": "ScheduledBackgroundTask->Schedule" }, "executionMode": { "title": "executionMode", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "ScheduledBackgroundTask->ExecutionMode", "x-formatSpecifier": "OperationExecutionMode" }, "startFrom": { "title": "startFrom", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ScheduledBackgroundTask->StartFrom" }, "requestType": { "title": "requestType", "type": "string", "x-nullable": false, "x-propertyPath": "ScheduledBackgroundTask->RequestType" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "ScheduledBackgroundTask->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ScheduledBackgroundTask->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ScheduledBackgroundTask->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" } } } }, "GetMyTermsAndConditionCollectionResourceActionResponse": { "title": "GetMyTermsAndConditionCollectionResourceActionResponse", "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": "GetMyTermsAndConditionCollectionResourceActionResponseItem", "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": "GetMyTermsAndConditionCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "userCode": { "title": "userCode", "type": "string", "x-nullable": false, "x-propertyPath": "UserTermsAndConditionVersion->User_Code" }, "termsAndConditionVersionTermsAndConditionCode": { "title": "termsAndConditionVersionTermsAndConditionCode", "type": "string", "x-nullable": false, "x-propertyPath": "UserTermsAndConditionVersion->TermsAndConditionVersion_TermsAndCondition_Code" }, "termsAndConditionVersionTermsAndConditionName": { "title": "termsAndConditionVersionTermsAndConditionName", "type": "string", "x-nullable": false, "x-propertyPath": "UserTermsAndConditionVersion->TermsAndConditionVersion_TermsAndCondition_Name" }, "termsAndConditionVersionLanguageCode": { "title": "termsAndConditionVersionLanguageCode", "type": "string", "x-nullable": false, "x-propertyPath": "UserTermsAndConditionVersion->TermsAndConditionVersion_Language_Code" }, "termsAndConditionVersionPublished": { "title": "termsAndConditionVersionPublished", "type": "boolean", "x-nullable": false, "x-propertyPath": "UserTermsAndConditionVersion->TermsAndConditionVersion_Published" }, "termsAndConditionVersionContentVersion": { "title": "termsAndConditionVersionContentVersion", "type": "integer", "format": "int32", "x-nullable": false, "x-propertyPath": "UserTermsAndConditionVersion->TermsAndConditionVersion_ContentVersion" }, "deprecated": { "title": "deprecated", "type": "boolean", "x-nullable": false, "x-propertyPath": "UserTermsAndConditionVersion->Deprecated" }, "accepted": { "title": "accepted", "type": "boolean", "x-nullable": false, "x-propertyPath": "UserTermsAndConditionVersion->Accepted" }, "acceptedDate": { "title": "acceptedDate", "type": "string", "format": "date", "x-nullable": true, "example": "2005-04-20", "x-propertyPath": "UserTermsAndConditionVersion->AcceptedDate" } } }, "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" } } } }, "GetMyTermsAndConditionPendingCollectionResourceActionResponse": { "title": "GetMyTermsAndConditionPendingCollectionResourceActionResponse", "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": "GetMyTermsAndConditionPendingCollectionResourceActionResponseItem", "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": "GetMyTermsAndConditionPendingCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "userCode": { "title": "userCode", "type": "string", "x-nullable": false, "x-propertyPath": "UserTermsAndConditionVersion->User_Code" }, "termsAndConditionVersionTermsAndConditionCode": { "title": "termsAndConditionVersionTermsAndConditionCode", "type": "string", "x-nullable": false, "x-propertyPath": "UserTermsAndConditionVersion->TermsAndConditionVersion_TermsAndCondition_Code" }, "termsAndConditionVersionTermsAndConditionName": { "title": "termsAndConditionVersionTermsAndConditionName", "type": "string", "x-nullable": false, "x-propertyPath": "UserTermsAndConditionVersion->TermsAndConditionVersion_TermsAndCondition_Name" }, "termsAndConditionVersionTermsAndConditionCompulsory": { "title": "termsAndConditionVersionTermsAndConditionCompulsory", "type": "boolean", "x-nullable": false, "x-propertyPath": "UserTermsAndConditionVersion->TermsAndConditionVersion_TermsAndCondition_Compulsory" }, "termsAndConditionVersionLanguageCode": { "title": "termsAndConditionVersionLanguageCode", "type": "string", "x-nullable": false, "x-propertyPath": "UserTermsAndConditionVersion->TermsAndConditionVersion_Language_Code" }, "termsAndConditionVersionPublished": { "title": "termsAndConditionVersionPublished", "type": "boolean", "x-nullable": false, "x-propertyPath": "UserTermsAndConditionVersion->TermsAndConditionVersion_Published" }, "termsAndConditionVersionContentVersion": { "title": "termsAndConditionVersionContentVersion", "type": "integer", "format": "int32", "x-nullable": false, "x-propertyPath": "UserTermsAndConditionVersion->TermsAndConditionVersion_ContentVersion" }, "deprecated": { "title": "deprecated", "type": "boolean", "x-nullable": false, "x-propertyPath": "UserTermsAndConditionVersion->Deprecated" }, "accepted": { "title": "accepted", "type": "boolean", "x-nullable": false, "x-propertyPath": "UserTermsAndConditionVersion->Accepted" }, "acceptedDate": { "title": "acceptedDate", "type": "string", "format": "date", "x-nullable": true, "example": "2005-04-20", "x-propertyPath": "UserTermsAndConditionVersion->AcceptedDate" } } }, "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" } } } }, "DeleteMyBackgroundTaskResourceActionRequest": { "title": "DeleteMyBackgroundTaskResourceActionRequest", "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 } } }, "DeleteMyOperationalRoleResourceResourceActionRequest": { "title": "DeleteMyOperationalRoleResourceResourceActionRequest", "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 } } }, "DeleteMyOperationalRoleTemplateResourceActionRequest": { "title": "DeleteMyOperationalRoleTemplateResourceActionRequest", "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 } } }, "DeleteMyScheduledBackgroundTaskResourceActionRequest": { "title": "DeleteMyScheduledBackgroundTaskResourceActionRequest", "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 } } }, "BatchDeleteMyBackgroundTaskResourceActionRequest": { "title": "BatchDeleteMyBackgroundTaskResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteMyBackgroundTaskResourceActionRequest" } }, "BatchDeleteMyScheduledBackgroundTaskResourceActionRequest": { "title": "BatchDeleteMyScheduledBackgroundTaskResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteMyScheduledBackgroundTaskResourceActionRequest" } }, "AcceptMyTermsAndConditionResourceActionResponse": { "title": "AcceptMyTermsAndConditionResourceActionResponse", "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": "AcceptMyTermsAndConditionResourceActionResponseProperties", "type": "object", "x-nullable": false }, "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" } } }, "AddResourceActionToUserOperationalRoleResourceActionResponse": { "title": "AddResourceActionToUserOperationalRoleResourceActionResponse", "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": "AddResourceActionToUserOperationalRoleResourceActionResponseProperties", "type": "object", "x-nullable": false }, "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" } } }, "AddTemplateToUserOperationalRoleResourceActionResponse": { "title": "AddTemplateToUserOperationalRoleResourceActionResponse", "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": "AddTemplateToUserOperationalRoleResourceActionResponseProperties", "type": "object", "x-nullable": false }, "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" } } }, "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" } } }, "ApproveApprovalResourceActionRequest": { "title": "ApproveApprovalResourceActionRequest", "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": "comment", "type": "string", "x-nullable": true, "x-propertyPath": "MyApproval->Comment" } ] } } }, "RejectApprovalResourceActionRequest": { "title": "RejectApprovalResourceActionRequest", "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": "comment", "type": "string", "x-nullable": true, "x-propertyPath": "MyApproval->Comment" } ] } } }, "BatchRejectApprovalResourceActionRequest": { "title": "BatchRejectApprovalResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/RejectApprovalResourceActionRequest" } }, "SetMyDefaultOperationalRoleResourceActionResponse": { "title": "SetMyDefaultOperationalRoleResourceActionResponse", "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": "SetMyDefaultOperationalRoleResourceActionResponseProperties", "type": "object", "x-nullable": false }, "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" } } }, "SetMyDefaultOperationalRoleResourceResourceActionResponse": { "title": "SetMyDefaultOperationalRoleResourceResourceActionResponse", "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": "SetMyDefaultOperationalRoleResourceResourceActionResponseProperties", "type": "object", "x-nullable": false }, "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" } } }, "SetMyDefaultOperationalRoleTemplateResourceActionResponse": { "title": "SetMyDefaultOperationalRoleTemplateResourceActionResponse", "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": "SetMyDefaultOperationalRoleTemplateResourceActionResponseProperties", "type": "object", "x-nullable": false }, "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" } } }, "UpdateMyUserSummaryResourceActionRequest": { "title": "UpdateMyUserSummaryResourceActionRequest", "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": "dateFormat", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "MyUserSummary->DateFormat", "x-formatSpecifier": "SystemDateFormat" }, { "title": "dateSeparator", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "MyUserSummary->DateSeparator", "x-formatSpecifier": "SystemDateSeparator" }, { "title": "timeFormat", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "MyUserSummary->TimeFormat", "x-formatSpecifier": "SystemTimeFormat" }, { "title": "defaultLanguageId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "MyUserSummary->DefaultLanguage_Id" }, { "title": "defaultCreateSaveAction", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "MyUserSummary->DefaultCreateSaveAction", "x-formatSpecifier": "DefaultCreateSaveAction" }, { "title": "defaultUpdateSaveAction", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "MyUserSummary->DefaultUpdateSaveAction", "x-formatSpecifier": "DefaultUpdateSaveAction" } ] } } }, "BatchApproveMyApprovalResourceActionRequest": { "title": "BatchApproveMyApprovalResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ApproveApprovalResourceActionRequest" } } }, "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": { "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": "My Identity" } ], "x-tagGroups": [ { "name": "IDENTITY", "tags": [ "My Identity" ] } ] }