{"type":"doc","content":[{"type":"paragraph","content":[{"text":"Emakin offers infrastructure services that enable seamless integration with other applications, in addition to its process-based services.","type":"text"}]},{"type":"paragraph","content":[{"text":"These services can be accessed via the URL: \"","type":"text"},{"text":"http(s)://.emakin.com/rest","type":"text","marks":[{"type":"strong"}]},{"text":"\", and service methods are invoked using the REST format.","type":"text"}]},{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"toc","parameters":{"macroParams":{},"macroMetadata":{"macroId":{"value":"8356dbf7-0043-4c4d-bc18-08168ec0afae"},"schemaVersion":{"value":"1"},"title":"Table of Contents"}},"localId":"24798bda-0fbb-4bba-92ae-7f554f9462ca"}},{"type":"heading","attrs":{"level":1},"content":[{"text":"Authentication","type":"text"}]},{"type":"paragraph","content":[{"text":"To execute infrastructure service calls, an API Key is required, which can be obtained from the system administrator.","type":"text"}]},{"type":"paragraph","content":[{"text":"Some methods also require the ","type":"text"},{"text":"logonId","type":"text","marks":[{"type":"code"}]},{"text":" and ","type":"text"},{"text":"logonProvider","type":"text","marks":[{"type":"code"}]},{"text":" parameters to act on behalf of a user. The ","type":"text"},{"text":"logonProvider","type":"text","marks":[{"type":"code"}]},{"text":" specifies the registered Open Authentication provider. If Emakin's default login system is used, this can be specified as 'Organization.' The ","type":"text"},{"text":"logonId","type":"text","marks":[{"type":"code"}]},{"text":" may vary depending on the provider; for example, if Active Directory is used, the ","type":"text"},{"text":"logonId","type":"text","marks":[{"type":"code"}]},{"text":" would be the Windows login username.","type":"text"}]},{"type":"paragraph","content":[{"text":"Token-generating login methods always return tokens within the scope of the registered API Key.","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Services","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"GetToken","type":"text"}]},{"type":"paragraph","content":[{"text":"Generates an authentication token to authorise users. The generated token can be used in the ","type":"text"},{"text":"auth","type":"text","marks":[{"type":"code"}]},{"text":" parameter to authenticate users without requiring them to log in.","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Required Scope","type":"text"}]},{"type":"paragraph","content":[{"text":"login","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Parameters","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"44c3f299-ec66-4905-8595-071951f13468"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Parameter Name","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"apiKey","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"A unique key used to authenticate and authorise the calling system.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"logonId","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"User’s logon Id.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"logonProvider","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The authentication provider used for user login (e.g., 'Organization' for Emakin's default login system).","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Example Call","type":"text"}]},{"type":"codeBlock","content":[{"text":"POST https://mydomain.emakin.com/rest/v1/getToken\n \n{\n \"apiKey\": \"xxxx\",\n \"logonId\": \"user@emakin.com\",\n \"logonProvider\": \"Organization\"\n}","type":"text"}]},{"type":"codeBlock","content":[{"text":"HTTP/1.1 200 OK\nContent-Type: application/json; charset=utf-8\n \n\"41AA3CE3CAFB..............BF8114\"","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"GetTokenFromUserInfo","type":"text"}]},{"type":"paragraph","content":[{"text":"Generates an authentication token based on user information. If the user is not found and auto-registration is enabled for the logon provider, the user is automatically created, and an authentication token is returned for the newly registered user. Otherwise, the method returns an authentication token for an already registered user.","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Required Scope","type":"text"}]},{"type":"paragraph","content":[{"text":"login","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Parameters","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"b08519c7-a23b-4d6c-bd05-0df52b6a3e12"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Parameter Name","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"apiKey","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"A unique key used to authenticate and authorise the calling system.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"userInfo","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"User information.","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Example Call","type":"text"}]},{"type":"codeBlock","content":[{"text":"POST https://mydomain.emakin.com/rest/v1/getTokenFromUserInfo\n \n{\n \"apiKey\": \"xxxx\",\n \"userInfo\": {\n \t\"logonProvider\": \"LinkedIn\",\n \"id\": \"wcomx2h3jd\",\n \"name\": \"John Doe\",\n \"email\": \"john.doe@noreply.com\",\n }\n}","type":"text"}]},{"type":"codeBlock","content":[{"text":"HTTP/1.1 200 OK\nContent-Type: application/json; charset=utf-8\n \n\"41AA3CE3CAFB..............BF8114\"","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"GetWorklist","type":"text"}]},{"type":"paragraph","content":[{"text":"Returns the list of work items on the user's worklist. The ","type":"text"},{"text":"tag","type":"text","marks":[{"type":"code"}]},{"text":" parameter specifies the identifier for the specific list to be returned.","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Required Scope","type":"text"}]},{"type":"paragraph","content":[{"text":"worklist_read","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Parameters","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"7164c9bd-2183-47ea-a125-7d137025cef3"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Parameter Name","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"apiKey","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"A unique key used to authenticate and authorise the calling system.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"logonId","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"User’s logon Id.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"logonProvider","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The authentication provider used for user login (e.g., 'Organization' for Emakin's default login system).","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"tag","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Identifier for the worklist. If set to null, the default inbox is returned.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"start","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Starting point for the list. Use ","type":"text"},{"text":"0","type":"text","marks":[{"type":"code"}]},{"text":" to begin from the first item.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"maxLength","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Limit on the number of rows to return. Use ","type":"text"},{"text":"-1","type":"text","marks":[{"type":"code"}]},{"text":" to retrieve all rows.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"queryXml","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Optional parameter for specifying query XML. See ","type":"text"},{"text":"Rest Services#Query","type":"text","marks":[{"type":"link","attrs":{"href":"https://emakin.atlassian.net/wiki/pages/resumedraft.action?draftId=5244515#RestServices-Query"}}]},{"text":" for more details.","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Example Call","type":"text"}]},{"type":"codeBlock","content":[{"text":"POST https://mydomain.emakin.com/rest/v1/getWorklist\n \n{\n \"apiKey\": \"xxxx\",\n \"logonId\": \"user@emakin.com\",\n \"logonProvider\": \"Organization\",\n \"tag\": null,\n \"start\": 0,\n \"maxLength\": 30,\n \"queryXml\" : \"\"\n}","type":"text"}]},{"type":"codeBlock","content":[{"text":"HTTP/1.1 200 OK\nContent-Type: application/json; charset=utf-8\n \n[\n {\n \"Id\":\"e5134318-88bd-4a33-b561-4d78380734ce\",\n \"Caption\":\"A new task\",\n \"Start\":\"/Date(1445812020394)/\",\n \"End\":null,\n \"Instructions\":\"Please complete.\",\n \"State\":\"Waiting\",\n \"Number\":12471\n },\n {\n \"Id\":\"796a34c6-fd2e-450e-a2af-8124ea68f8ca\",\n \"Caption\":\"A new other task\",\n \"Start\":\"/Date(1445512843034)/\",\n \"End\":null,\n \"Instructions\":\"Please complete.\",\n \"State\":\"Waiting\",\n \"Number\":12468\n }\n]","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"GetWorklistCount","type":"text"}]},{"type":"paragraph","content":[{"text":"Returns the total number of records in the worklist. This method can be used to define paging parameters for the ","type":"text"},{"text":"GetWorklist","type":"text","marks":[{"type":"strong"}]},{"text":" method.","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Required Scope","type":"text"}]},{"type":"paragraph","content":[{"text":"worklist_read","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Parameters","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"1eee6edc-c8bd-4813-a189-118fd8b19f0f"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Parameter Name","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"apiKey","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"A unique key used to authenticate and authorise the calling system.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"logonId","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"User’s logon Id.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"logonProvider","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The authentication provider used for user login (e.g., 'Organization' for Emakin's default login system).","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"tag","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Identifier for the worklist. If set to null, the default inbox is returned.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"queryXml","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Optional parameter for specifying query XML. See ","type":"text"},{"text":"Rest Services#Query","type":"text","marks":[{"type":"link","attrs":{"href":"https://emakin.atlassian.net/wiki/pages/resumedraft.action?draftId=5244515#RestServices-Query"}}]},{"text":" for more details.","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Example Call","type":"text"}]},{"type":"codeBlock","content":[{"text":"POST https://mydomain.emakin.com/rest/v1/getWorklistCount\n \n{\n \"apiKey\": \"xxxx\",\n \"logonId\": \"user@emakin.com\",\n \"logonProvider\": \"Organization\",\n \"tag\": null,\n \"queryXml\" : \"\"\n}","type":"text"}]},{"type":"codeBlock","content":[{"text":"HTTP/1.1 200 OK\nContent-Type: application/json; charset=utf-8\n \n50","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"GetWorkItem","type":"text"}]},{"type":"paragraph","content":[{"text":"Retrieves detailed information about a work item, either for display or to perform an action for its completion.","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Required Scope","type":"text"}]},{"type":"paragraph","content":[{"text":"worklist_read","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Parameters","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"5fc9b624-5d15-49de-92f5-4d64404c449d"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Parameter Name","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"apiKey","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"A unique key used to authenticate and authorise the calling system.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"logonId","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"User’s logon Id.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"logonProvider","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The authentication provider used for user login (e.g., 'Organization' for Emakin's default login system).","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"id","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The unique identifier of the work item.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"readOnly","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Set to ","type":"text"},{"text":"true","type":"text","marks":[{"type":"code"}]},{"text":" to fetch the work item in read-only mode. The default value is ","type":"text"},{"text":"false","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Example Call","type":"text"}]},{"type":"codeBlock","content":[{"text":"POST https://mydomain.emakin.com/rest/v1/getWorkItem\n\n{\n \"apiKey\": \"xxxx\",\n \"logonId\": \"user@emakin.com\",\n \"logonProvider\": \"Organization\",\n \"id\": \"e5134318-88bd-4a33-b561-4d78380734ce\"\n}","type":"text"}]},{"type":"codeBlock","content":[{"text":"HTTP/1.1 200 OK\nContent-Type: application/json; charset=utf-8\n\n{\n \"Id\": \"e5134318-88bd-4a33-b561-4d78380734ce\",\n \"Caption\": \"A new task\",\n \"Culture\": \"en-US\",\n \"Start\": \"/Date(1445812020394)/\",\n \"End\": null,\n \"DeadlineDate\": null,\n \"InstanceNumber\": 12471,\n \"IsReadOnly\": false,\n \"SelectedActionId\": null,\n \"Actions\": [\n {\n \"Id\": \"2b0aa720-82f8-4a62-b7a1-2389203fa5e7\",\n \"Name\": \"Complete\",\n \"Color\": \"\",\n \"BackgroundColor\": \"\",\n \"Order\": 1,\n \"Hidden\" : false,\n \"RequireComment\": false,\n \"ConfirmationMessage\": \"\",\n \"ValidationGroup\": \"\"\n },\n {\n \"Id\": \"c5350e5c-6e03-4b72-9522-49ab7f849b8a\",\n \"Name\": \"Cancel\",\n \"Color\": \"\",\n \"BackgroundColor\": \"\",\n \"Order\": 2,\n \"Hidden\" : false,\n \"RequireComment\": true,\n \"ConfirmationMessage\": \"\",\n \"ValidationGroup\": \"\"\n }\n ]\n }","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"SelectAction","type":"text"}]},{"type":"paragraph","content":[{"text":"Selects an action for a work item and returns an array of identifiers for the next work items in the process.","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Required Scope","type":"text"}]},{"type":"paragraph","content":[{"text":"workitem_action","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Parameters","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"7fefe1c5-dc8e-4808-9ae3-9148acc1e348"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Parameter Name","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"apiKey","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"A unique key used to authenticate and authorise the calling system.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"logonId","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"User’s logon Id.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"logonProvider","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The authentication provider used for user login (e.g., 'Organization' for Emakin's default login system).","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"id","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The unique identifier of the work item.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"action","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The identifier for the selected action.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"data","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The XML data associated with the form. This can be null. (Note: There is no merge operation; the entire form data must be sent. If omitted, the form data will be replaced with the new data. ","type":"text"}]},{"type":"paragraph","content":[{"text":"You can retrieve the current data using the ","type":"text"},{"text":"GetWorkItemData","type":"text","marks":[{"type":"code"}]},{"text":" method. ","type":"text"}]},{"type":"paragraph","content":[{"text":"The final data should be enclosed within a form element, e.g. ","type":"text"},{"text":"","type":"text","marks":[{"type":"code"}]},{"text":".)","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"comments","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"User comments.","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Example Call","type":"text"}]},{"type":"codeBlock","content":[{"text":"POST https://mydomain.emakin.com/rest/v1/selectAction\n\n{\n \"apiKey\": \"xxxx\",\n \"logonId\": \"user@emakin.com\",\n \"logonProvider\": \"Organization\",\n \"id\": \"e5134318-88bd-4a33-b561-4d78380734ce\",\n \"action\": \"c5350e5c-6e03-4b72-9522-49ab7f849b8a\",\n \"data\": null\n}","type":"text"}]},{"type":"codeBlock","content":[{"text":"HTTP/1.1 200 OK\nContent-Type: application/json; charset=utf-8\n\n[ \"716F8FCB-98C2-4591-8C43-043D54DEAADA\" ]\n","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"InitiateByProcess","type":"text"}]},{"type":"paragraph","content":[{"text":"Initiates a new process instance using the specified parameters and returns the Id of the newly created work item.","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Required Scope","type":"text"}]},{"type":"paragraph","content":[{"text":"process_initiate","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Parameters","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"1f3f8e7a-1122-4746-b2ca-2b1f29d81d9c"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Parameter Name","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"apiKey","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"A unique key used to authenticate and authorise the calling system.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"logonId","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"User’s logon Id.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"logonProvider","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The authentication provider used for user login (e.g., 'Organization' for Emakin's default login system).","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"process","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The name or Id of the process to initiate.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"task","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The name or Id of the task within the process.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"version","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The version number or Id of the process. This can be null.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"data","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"XML data associated with the process. This can be null.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"culture","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The culture preference. This can be null.","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Example Call","type":"text"}]},{"type":"codeBlock","content":[{"text":"POST https://mydomain.emakin.com/rest/v1/initiateByProcess\n\n{\n \"apiKey\": \"xxxx\",\n \"logonId\": \"user@emakin.com\",\n \"logonProvider\": \"Organization\",\n \"process\": \"e5134318-88bd-4a33-b561-4d78380734ce\",\n \"task\": \"c5350e5c-6e03-4b72-9522-49ab7f849b8a\",\n \"version\": null,\n \"data\": \"ABC\",\n \"culture\": null\n}","type":"text"}]},{"type":"codeBlock","content":[{"text":"HTTP/1.1 200 OK\n\n\"716F8FCB-98C2-4591-8C43-043D54DEAADA\"\n","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"ExecuteModule","type":"text"}]},{"type":"paragraph","content":[{"text":"Executes the specified module and returns the result of the module function.","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Required Scope","type":"text"}]},{"type":"paragraph","content":[{"text":"module_execute","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Parameters","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"22b93094-72c5-4afd-a309-95f3778c96b6"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Parameter Name","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"apiKey","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"A unique key used to authenticate and authorise the calling system.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"logonId","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"User’s logon Id.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"logonProvider","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The authentication provider used for user login (e.g., 'Organization' for Emakin's default login system).","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"process","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The name or Id of the process to initiate.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"module","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The name of the module to call.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"function","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The name of the function to call within the module.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"arguments","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"An array of parameters to pass to the function.","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Example Call","type":"text"}]},{"type":"codeBlock","content":[{"text":"POST https://mydomain.emakin.com/rest/v1/executeModule\n\n{\n \"apiKey\": \"xxxx\",\n \"logonId\": \"user@emakin.com\",\n \"logonProvider\": \"Organization\",\n \"process\" : \"MyProcess\",\n \"module\": \"MyModule\",\n \"function\": \"myFunction\",\n \"arguments\": [\"myParameter\",\"myOtherParameter\"]\n}","type":"text"}]},{"type":"codeBlock","content":[{"text":"HTTP/1.1 200 OK\nContent-Type: application/json; charset=utf-8\n\n{\n \"property1\": 1,\n \"property2\": \"value\"\n}\n","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Trigger","type":"text"}]},{"type":"paragraph","content":[{"text":"Triggers an event for listeners across all processes and returns an array of IDs for the triggered work items. If no listeners are found, the return value is an empty array.","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Required Scope","type":"text"}]},{"type":"paragraph","content":[{"text":"event_trigger","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Parameters","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"f5fabb4a-c19f-4b76-af9e-b23cb5ded598"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Parameter Name","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"apiKey","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"A unique key used to authenticate and authorise the calling system.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"logonId","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"User’s logon Id.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"logonProvider","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The authentication provider used for user login (e.g., 'Organization' for Emakin's default login system).","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"eventName","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The name of the event to trigger.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"testMode","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Determines whether the event should also trigger for items in test mode.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"inputData","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Event data in XML format. This can be null.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"culture","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The culture preference. This can be null.","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Example Call","type":"text"}]},{"type":"codeBlock","content":[{"text":"POST https://mydomain.emakin.com/rest/v1/trigger\n\n{\n \"apiKey\": \"xxxx\",\n \"logonId\": \"user@emakin.com\",\n \"logonProvider\": \"Organization\",\n \"eventName\" : \"myEvent\",\n \"inputData\": \"ABC\",\n \"testMode\": false,\n \"culture\": null\n}","type":"text"}]},{"type":"codeBlock","content":[{"text":"HTTP/1.1 200 OK\nContent-Type: application/json; charset=utf-8\n\n[\"716F8FCB-98C2-4591-8C43-043D54DEAADA\"]\n","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Query","type":"text"}]},{"type":"paragraph","content":[{"text":"The query is an XML-based string that specifies the desired result set. If not provided, the default query is executed.","type":"text"}]},{"type":"paragraph","content":[{"text":"The query can be defined using the following column names for specifying the result set columns, criteria, and order.","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Worklist Columns","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"e8bbd9fb-8ba5-42be-9de1-5d35f75ca8a7"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Id","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Unique identifier of the work item.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Name of the work item.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Caption","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Localised caption of the work item.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"State","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The current state of the work item.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Start","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Start date of the work item.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"End","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"End date of the work item. Can be null.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"IsDeadlined","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"A boolean that specifies the deadline has occurred.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"DeadlineDate","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Deadline date. Can be null.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"NextReminderDate","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Next reminder date. Can be null.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"SentReminders","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Number of reminders sent.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Instructions","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Instructions for the work item.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"InstanceId","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Unique identifier of the instance.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"PreviousWorkItemId","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Identifier of the previous work item. Can be null.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"ActionId","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Unique identifier for the action. Can be null.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"CompletedById","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Id of the user who completed the work item. Can be null.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"CompletedBy","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Display name of the user who completed the work item. Can be null.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Number","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Instance number.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Priority","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Priority of the instance.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"ProcessId","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The Id of the process.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"ProcessName","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The name of the process.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"FromId","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Identifier of the initiating user. Can be null.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"From","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Display name of the initiator user. Can be null.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"FolderId","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Identifier of the related folder.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"FolderName","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Name of the related folder.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"AssignedTo","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"List of users assigned to the work item.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"VersionNumber","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Version number of the related process.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"VersionId","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Version Id of the related process.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"TestMode","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Boolean indicating whether the instance is in test mode.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Instance.Start","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Start date of the instance.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Instance.State","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"State of the instance.","type":"text"}]}]}]}]},{"type":"paragraph","content":[{"text":"Query contains the following sections;","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Columns","type":"text"}]},{"type":"paragraph","content":[{"text":"A list of column names to be included in the result set.","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Where","type":"text"}]},{"type":"paragraph","content":[{"text":"A list of criteria for filtering the results. The criteria names must correspond to column names.","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Order","type":"text"}]},{"type":"paragraph","content":[{"text":"A list of sorting criteria. The order names must also correspond to column names.","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Example Query Xml","type":"text"}]},{"type":"codeBlock","attrs":{"language":"xml"},"content":[{"text":"\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n My Task*\n \n \n \n \n \n \n","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Decision","type":"text"}]},{"type":"paragraph","content":[{"text":"Returns the result of a decision model evaluation. This method processes input data and applies the business logic defined in the decision model to return an outcome. The decision model may involve rules, conditions, and calculations that lead to the final decision result.","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Required Scope","type":"text"}]},{"type":"paragraph","content":[{"text":"decision_execute","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Parameters","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":604.0,"localId":"950da53c-5a4b-44a2-b2da-6fe0fe23baf0"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[202.0]},"content":[{"type":"paragraph","content":[{"text":"Parameter Name","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[402.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[202.0]},"content":[{"type":"paragraph","content":[{"text":"apiKey","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[402.0]},"content":[{"type":"paragraph","content":[{"text":"A unique key used to authenticate and authorise the calling system.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[202.0]},"content":[{"type":"paragraph","content":[{"text":"logonId","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[402.0]},"content":[{"type":"paragraph","content":[{"text":"User’s logon Id.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[202.0]},"content":[{"type":"paragraph","content":[{"text":"logonProvider","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[402.0]},"content":[{"type":"paragraph","content":[{"text":"The authentication provider used for user login (e.g., 'Organization' for Emakin's default login system).","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[202.0]},"content":[{"type":"paragraph","content":[{"text":"process","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[402.0]},"content":[{"type":"paragraph","content":[{"text":"The name or Id of the process related to the decision.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[202.0]},"content":[{"type":"paragraph","content":[{"text":"model","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[402.0]},"content":[{"type":"paragraph","content":[{"text":"The name or ID of the decision model to be evaluated.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[202.0]},"content":[{"type":"paragraph","content":[{"text":"decision","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[402.0]},"content":[{"type":"paragraph","content":[{"text":"The name or Id of the specific decision to be executed within the model.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[202.0]},"content":[{"type":"paragraph","content":[{"text":"inputData","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[402.0]},"content":[{"type":"paragraph","content":[{"text":"Input data for the decision, provided as either an XML or JSON string.","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Example Call","type":"text"}]},{"type":"codeBlock","content":[{"text":"POST https://mydomain.emakin.com/rest/v1/decision\n\n{\n \"apiKey\": \"\",\n \"logonId\": \"user@emakin.com\",\n \"logonProvider\": \"Organization\",\n \"process\" : \"Decision\",\n \"model\" : \"dinner\",\n \"decision\" : \"Dish\",\n \"inputData\": \"Fall2\"\n}","type":"text"}]},{"type":"codeBlock","content":[{"text":"HTTP/1.1 200 OK\nContent-Type: application/json; charset=utf-8\nContent-Length: 26\n\n{\"Dish\":\"Spareribs\"}\n","type":"text"}]},{"type":"paragraph"},{"type":"paragraph"}],"version":1}