Overview

HTTP verbs

RESTful notes tries to adhere as closely as possible to standard HTTP and REST conventions in its use of HTTP verbs.

Verb	Usage
GET	Used to retrieve a resource
POST	Used to create a new resource
PATCH	Used to update an existing resource, including partial updates
DELETE	Used to delete an existing resource

HTTP status codes

RESTful notes tries to adhere as closely as possible to standard HTTP and REST conventions in its use of HTTP status codes.

Status code	Usage
200 OK	The request completed successfully
201 Created	A new resource has been created successfully. The resource's URI is available from the response's Location header
204 No Content	An update to an existing resource has been applied successfully
400 Bad Request	The request was malformed. The response body will include an error providing further information
404 Not Found	The requested resource did not exist

Resources

Workflow

Create workflow draft

A POST request will create new workflow draft version

Example request

POST /organization/SUBS/workflows HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjU2Mjk0OTk1MzQyMTMxMjAsImV4cCI6MTUyODk2MDg5Mywicm9sZXMiOltdLCJkb21haW5BcHBSb2xlcyI6W10sInBlcm1pc3Npb25zIjpbIlJFVFJZX1dPUktGTE9XIiwiU1VQRVJBRE1JTiIsIkVSUk9SX01BTkFHRU1FTlQiLCJTVUJTQ1JJQkVSU19NQU5BR0VNRU5UIiwiQ1JFQVRFX1VTRVIiLCJFWEVDVVRFX0FDVElPTiIsIkNMSUVOVF9VU0VSU19NQU5BR0VNRU5UIiwiQVBQUk9WRV9DQU5DRUwiLCJSRVFVRVNUX0NBTkNFTCIsIlVTRVJTX01BTkFHRU1FTlQiLCJOT1RJRklDQVRJT05TX01BTkFHRU1FTlQiLCJHRVRfVVNFUlMiLCJSRVNPVVJDRVNfTUFOQUdFTUVOVCIsIkFDQ0VTU19BRE1JTl9QQUdFIiwiVVNFUl9ST0xFU19NQU5BR0VNRU5UIiwiQ0xJRU5UU19NQU5BR0VNRU5UIiwiSEVMUF9BUlRJQ0xFU19NQU5BR0VNRU5UIiwiU1RBUlRfV09SS0ZMT1ciXX0.3HC7XayCopR52LFspSaNXiBVtweJbx8cdS_dkGlGAzHCAco7BfQHoVQZ3ys6ziDiqfs7SFhSEqwejhRdv6mCFQ
Host: corporateservices.com
Content-Length: 419

{
  "SortOrder" : 38,
  "Name" : "Setup a new company",
  "Code" : "new_comp_setup",
  "Description" : "This is a sample workflow for testing in Avocado.",
  "WorkflowCategory" : {
    "Code" : "corporate_services"
  },
  "StartRoles" : [ {
    "Code" : "RegCorpSecExec"
  } ],
  "StartClientTypes" : [ {
    "Code" : "ACTIVE"
  } ],
  "OrgSettingNames" : [ ],
  "AlwaysDisplayed" : false,
  "VisibleToClient" : false
}

$ curl 'https://corporateservices.com:8080/organization/SUBS/workflows' -i -X POST -H 'Content-Type: application/json' -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjU2Mjk0OTk1MzQyMTMxMjAsImV4cCI6MTUyODk2MDg5Mywicm9sZXMiOltdLCJkb21haW5BcHBSb2xlcyI6W10sInBlcm1pc3Npb25zIjpbIlJFVFJZX1dPUktGTE9XIiwiU1VQRVJBRE1JTiIsIkVSUk9SX01BTkFHRU1FTlQiLCJTVUJTQ1JJQkVSU19NQU5BR0VNRU5UIiwiQ1JFQVRFX1VTRVIiLCJFWEVDVVRFX0FDVElPTiIsIkNMSUVOVF9VU0VSU19NQU5BR0VNRU5UIiwiQVBQUk9WRV9DQU5DRUwiLCJSRVFVRVNUX0NBTkNFTCIsIlVTRVJTX01BTkFHRU1FTlQiLCJOT1RJRklDQVRJT05TX01BTkFHRU1FTlQiLCJHRVRfVVNFUlMiLCJSRVNPVVJDRVNfTUFOQUdFTUVOVCIsIkFDQ0VTU19BRE1JTl9QQUdFIiwiVVNFUl9ST0xFU19NQU5BR0VNRU5UIiwiQ0xJRU5UU19NQU5BR0VNRU5UIiwiSEVMUF9BUlRJQ0xFU19NQU5BR0VNRU5UIiwiU1RBUlRfV09SS0ZMT1ciXX0.3HC7XayCopR52LFspSaNXiBVtweJbx8cdS_dkGlGAzHCAco7BfQHoVQZ3ys6ziDiqfs7SFhSEqwejhRdv6mCFQ' -d '{
  "SortOrder" : 38,
  "Name" : "Setup a new company",
  "Code" : "new_comp_setup",
  "Description" : "This is a sample workflow for testing in Avocado.",
  "WorkflowCategory" : {
    "Code" : "corporate_services"
  },
  "StartRoles" : [ {
    "Code" : "RegCorpSecExec"
  } ],
  "StartClientTypes" : [ {
    "Code" : "ACTIVE"
  } ],
  "OrgSettingNames" : [ ],
  "AlwaysDisplayed" : false,
  "VisibleToClient" : false
}'

/organization/{orgCode}/workflows

Parameter	Description
orgCode	Organization code

Path	Type	Description
Name	String	Workflow name
Code	String	Workflow code
SortOrder	Number	Number that is responsible for sorting workflows when showing list of it to a user
Type	String	Workflow type, supported values: NORMAL, ONGOING, PAYMENT, SUPPORT. Field is optional, NORMAL will be used by default
Description	String	Workflow description
IntroScreen	String	Intro Html page
WorkflowCategory	Object	Workflow category resource
WorkflowCategory.Code	String	Workflow category code
Parameters	Array	Workflow parameters(optional field)
IndexedWidoFields	Array	Fields in WIDO that should be indexed for searching
StartRoles	Array	Roles that will be allowed to start this workflow
StartClientTypes	Array	Client types that will be allowed to start this workflow
OrgSettingNames	Array	List of organization setting names
AlwaysDisplayed	Boolean	Property which controls the behavior on the Start new page. Should the workflow be always displayed or hidden in the collapsable area
VisibleToClient	Boolean	Set to true to show in client dashboard

Example response

HTTP/1.1 201 Created
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: POST, GET, PUT, OPTIONS, DELETE
Access-Control-Max-Age: 3600
Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Authorization
Location: https://corporateservices.com:8080/organization/SUBS/workflows/NEW_COMP_SETUP
Content-Type: application/json;charset=UTF-8
Content-Length: 463

{
  "SortOrder" : 38,
  "Id" : "NEW_COMP_SETUP",
  "Name" : "Setup a new company",
  "Code" : "new_comp_setup",
  "Version" : 1,
  "Description" : "This is a sample workflow for testing in Avocado.",
  "WorkflowCategory" : {
    "Code" : "corporate_services"
  },
  "StartRoles" : [ {
    "Code" : "RegCorpSecExec"
  } ],
  "StartClientTypes" : [ {
    "Code" : "ACTIVE"
  } ],
  "OrgSettingNames" : [ ],
  "AlwaysDisplayed" : false,
  "VisibleToClient" : false
}

Path	Type	Description
Id	String	Workflow id
Version	String	Just created workflow draft version
Name	String	Workflow name
Code	String	Workflow code
SortOrder	Number	Number that is responsible for sorting workflows when showing list of it to a user
Type	String	Workflow type, supported values: NORMAL, ONGOING, PAYMENT, SUPPORT. Field is optional, NORMAL will be used by default
Description	String	Workflow description
IntroScreen	String	Intro Html page
WorkflowCategory	Object	Workflow category resource
WorkflowCategory.Code	String	Workflow category code
Parameters	Array	Workflow parameters(optional field)
IndexedWidoFields	Array	Fields in WIDO that should be indexed for searching
StartRoles	Array	Roles that will be allowed to start this workflow
StartClientTypes	Array	Client types that will be allowed to start this workflow
AlwaysDisplayed	Boolean	Property which controls the behavior on the Start new page. Should the workflow be always displayed or hidden in the collapsable area
OrgSettingNames	Array	List of organization setting names
VisibleToClient	Boolean	Set to true to show in client dashboard

Users

Create User

A POST request is used to create a new user

Example request

POST /users HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjU2Mjk0OTk1MzQyMTMxMjAsImV4cCI6MTUyODk2MDg5Mywicm9sZXMiOltdLCJkb21haW5BcHBSb2xlcyI6W10sInBlcm1pc3Npb25zIjpbIlJFVFJZX1dPUktGTE9XIiwiU1VQRVJBRE1JTiIsIkVSUk9SX01BTkFHRU1FTlQiLCJTVUJTQ1JJQkVSU19NQU5BR0VNRU5UIiwiQ1JFQVRFX1VTRVIiLCJFWEVDVVRFX0FDVElPTiIsIkNMSUVOVF9VU0VSU19NQU5BR0VNRU5UIiwiQVBQUk9WRV9DQU5DRUwiLCJSRVFVRVNUX0NBTkNFTCIsIlVTRVJTX01BTkFHRU1FTlQiLCJOT1RJRklDQVRJT05TX01BTkFHRU1FTlQiLCJHRVRfVVNFUlMiLCJSRVNPVVJDRVNfTUFOQUdFTUVOVCIsIkFDQ0VTU19BRE1JTl9QQUdFIiwiVVNFUl9ST0xFU19NQU5BR0VNRU5UIiwiQ0xJRU5UU19NQU5BR0VNRU5UIiwiSEVMUF9BUlRJQ0xFU19NQU5BR0VNRU5UIiwiU1RBUlRfV09SS0ZMT1ciXX0.3HC7XayCopR52LFspSaNXiBVtweJbx8cdS_dkGlGAzHCAco7BfQHoVQZ3ys6ziDiqfs7SFhSEqwejhRdv6mCFQ
Host: corporateservices.com
Content-Length: 155

{
  "FirstName" : "I'm the first",
  "LastName" : "user here",
  "Email" : "user@mail.com",
  "Password" : "hackme",
  "Name" : "I'm the first user here"
}

$ curl 'https://corporateservices.com:8080/users' -i -X POST -H 'Content-Type: application/json' -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjU2Mjk0OTk1MzQyMTMxMjAsImV4cCI6MTUyODk2MDg5Mywicm9sZXMiOltdLCJkb21haW5BcHBSb2xlcyI6W10sInBlcm1pc3Npb25zIjpbIlJFVFJZX1dPUktGTE9XIiwiU1VQRVJBRE1JTiIsIkVSUk9SX01BTkFHRU1FTlQiLCJTVUJTQ1JJQkVSU19NQU5BR0VNRU5UIiwiQ1JFQVRFX1VTRVIiLCJFWEVDVVRFX0FDVElPTiIsIkNMSUVOVF9VU0VSU19NQU5BR0VNRU5UIiwiQVBQUk9WRV9DQU5DRUwiLCJSRVFVRVNUX0NBTkNFTCIsIlVTRVJTX01BTkFHRU1FTlQiLCJOT1RJRklDQVRJT05TX01BTkFHRU1FTlQiLCJHRVRfVVNFUlMiLCJSRVNPVVJDRVNfTUFOQUdFTUVOVCIsIkFDQ0VTU19BRE1JTl9QQUdFIiwiVVNFUl9ST0xFU19NQU5BR0VNRU5UIiwiQ0xJRU5UU19NQU5BR0VNRU5UIiwiSEVMUF9BUlRJQ0xFU19NQU5BR0VNRU5UIiwiU1RBUlRfV09SS0ZMT1ciXX0.3HC7XayCopR52LFspSaNXiBVtweJbx8cdS_dkGlGAzHCAco7BfQHoVQZ3ys6ziDiqfs7SFhSEqwejhRdv6mCFQ' -d '{
  "FirstName" : "I'm the first",
  "LastName" : "user here",
  "Email" : "user@mail.com",
  "Password" : "hackme",
  "Name" : "I'm the first user here"
}'

Path	Type	Description
Name	String	Full name
FirstName	String	First name
LastName	String	Last name
Email	String	Email address
Password	String	Password

Process instances

List all process instances for client

A GET request will return all process instances for client

Example request

GET /organization/SD/process-instances/4556376185503744?status=ACTIVE HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjU5MTA5NzQ1MTA5MjM3NzYsImV4cCI6MTUyODk2MDkzMCwiY2xpZW50SWQiOjUwMzEzNjUyMDg3MDI5NzYsIm9yZ0NvZGUiOiJTRCIsInJvbGVzIjpbImFkbWluaXN0cmF0b3IiXSwiZG9tYWluQXBwUm9sZXMiOlsiQU5BTFlTVCIsIlNVUFBPUlQiLCJDTElFTlQiXSwicGVybWlzc2lvbnMiOlsiUkVUUllfV09SS0ZMT1ciLCJST0xFX2FkbWluaXN0cmF0b3IiLCJFUlJPUl9NQU5BR0VNRU5UIiwiU1VCU0NSSUJFUlNfTUFOQUdFTUVOVCIsIkNSRUFURV9VU0VSIiwiRVhFQ1VURV9BQ1RJT04iLCJDTElFTlRfVVNFUlNfTUFOQUdFTUVOVCIsIkFQUFJPVkVfQ0FOQ0VMIiwiUkVRVUVTVF9DQU5DRUwiLCJVU0VSU19NQU5BR0VNRU5UIiwiTk9USUZJQ0FUSU9OU19NQU5BR0VNRU5UIiwiUEFZTUVOVFNfTUFOQUdFTUVOVCIsIkdFVF9VU0VSUyIsIlJFU09VUkNFU19NQU5BR0VNRU5UIiwiQUNDRVNTX0FETUlOX1BBR0UiLCJVU0VSX1JPTEVTX01BTkFHRU1FTlQiLCJDTElFTlRTX01BTkFHRU1FTlQiLCJIRUxQX0FSVElDTEVTX01BTkFHRU1FTlQiLCJTVEFSVF9XT1JLRkxPVyJdfQ.fgDI5q098OWppTCoui21w1UF_zV8IlECIENmqZEn8395pkwowe6SRSrxI0nOu9JXV0yqpGw4TpnVXkLb39vrKg
Host: corporateservices.com

$ curl 'https://corporateservices.com:8080/organization/SD/process-instances/4556376185503744?status=ACTIVE' -i -H 'Content-Type: application/json' -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjU5MTA5NzQ1MTA5MjM3NzYsImV4cCI6MTUyODk2MDkzMCwiY2xpZW50SWQiOjUwMzEzNjUyMDg3MDI5NzYsIm9yZ0NvZGUiOiJTRCIsInJvbGVzIjpbImFkbWluaXN0cmF0b3IiXSwiZG9tYWluQXBwUm9sZXMiOlsiQU5BTFlTVCIsIlNVUFBPUlQiLCJDTElFTlQiXSwicGVybWlzc2lvbnMiOlsiUkVUUllfV09SS0ZMT1ciLCJST0xFX2FkbWluaXN0cmF0b3IiLCJFUlJPUl9NQU5BR0VNRU5UIiwiU1VCU0NSSUJFUlNfTUFOQUdFTUVOVCIsIkNSRUFURV9VU0VSIiwiRVhFQ1VURV9BQ1RJT04iLCJDTElFTlRfVVNFUlNfTUFOQUdFTUVOVCIsIkFQUFJPVkVfQ0FOQ0VMIiwiUkVRVUVTVF9DQU5DRUwiLCJVU0VSU19NQU5BR0VNRU5UIiwiTk9USUZJQ0FUSU9OU19NQU5BR0VNRU5UIiwiUEFZTUVOVFNfTUFOQUdFTUVOVCIsIkdFVF9VU0VSUyIsIlJFU09VUkNFU19NQU5BR0VNRU5UIiwiQUNDRVNTX0FETUlOX1BBR0UiLCJVU0VSX1JPTEVTX01BTkFHRU1FTlQiLCJDTElFTlRTX01BTkFHRU1FTlQiLCJIRUxQX0FSVElDTEVTX01BTkFHRU1FTlQiLCJTVEFSVF9XT1JLRkxPVyJdfQ.fgDI5q098OWppTCoui21w1UF_zV8IlECIENmqZEn8395pkwowe6SRSrxI0nOu9JXV0yqpGw4TpnVXkLb39vrKg'

/organization/{orgCode}/process-instances/{id}

Parameter	Description
orgCode	Organization code
id	Process instance id

Parameter	Description
status	Status of process instance. Allowed values: ACTIVE, INACTIVE, ALL. Parameter is optional, default value - ALL.

Example response

HTTP/1.1 200 OK
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: POST, GET, PUT, OPTIONS, DELETE
Access-Control-Max-Age: 3600
Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Authorization
Content-Type: application/json;charset=UTF-8
Content-Length: 1075

[ {
  "_type" : "com.avocado.workflow.common.resources.ActiveServiceRequestResource",
  "ServiceName" : "Add or Change Shareholders ",
  "StartedDate" : "2018-05-15T10:22:10.682+03:00",
  "StepDue" : "2018-05-15T10:32:10.725+03:00",
  "MasterRootEntityDisplayProperty" : "avocado2",
  "StepEnteredDate" : "2018-05-15T10:22:10.729+03:00",
  "StepName" : "Initial Application",
  "DataDirty" : true,
  "ClientActionRequired" : true,
  "ActivityInstanceKey" : "ahRzfmF2b2NhZG8tYmFja2VuZC12MXI5CxIPUHJvY2Vzc0luc3RhbmNlGICAgICAgLQLDAsSEEFjdGl2aXR5SW5zdGFuY2UYgICAgICA9AkM",
  "ProcessInstanceKey" : "ahRzfmF2b2NhZG8tYmFja2VuZC12MXIcCxIPUHJvY2Vzc0luc3RhbmNlGICAgICAgLQLDA",
  "ProcessInstanceId" : 6421147906211840,
  "CurrentPublishedForm" : "ahRzfmF2b2NhZG8tYmFja2VuZC12MXJvCxIMT3JnYW5pemF0aW9uIgNTR1AMCxIIV29ya2Zsb3ciHkNIQU5HRS1TSEFSRUFMTE9UTUVOVC1XT1JLRkxPVwwLEg9Xb3JrZmxvd1ZlcnNpb24YAQwLEgxXb3JrZmxvd0Zvcm0YgICAgICAtAoM",
  "StepCode" : "CHANGE-SHAREALLOTMENT-DRAFT",
  "Assignee" : "Adam Analyst",
  "Title" : "Add or Change Shareholders ",
  "ClientName" : "New Startup"
} ]

Path	Type	Description
[]	String	List of process instances
[0].ServiceName	String	Name of service(workflow)
[0].StartedDate	String	Date and time when workflow started
[0].CompletedDate	String	Date and time when workflow was completed (Applicable only for completed workflows)
[0].StepName	String	Name of current step (Applicable only for active workflows)
[0].StepCode	String	Code of current step (Applicable only for active workflows)
[0].StepEnteredDate	String	Start date and time of current step (Applicable only for active workflows)
[0].StepDue	String	Due date and time of current step (Applicable only for active workflows)
[0].Assignee	String	Current assignee (Applicable only for active workflows)
[0].Status	String	Current workflow status (Applicable only for active workflows)
[0].ClientActionRequired	Boolean	If client action is required (Applicable only for active workflows)
[0].ActivityInstanceKey	String	Key of current active activity instance (Applicable only for active workflows)
[0].ProcessInstanceKey	String	Key of process instance (Applicable only for active workflows)
[0].CurrentPublishedForm	String	Form that wos used on start of this workflow (Applicable only for active workflows)
[0].MasterRootEntityDisplayProperty	String	Master root entity name

Search for process instance

A GET request will return all process instances that has indexed properties in WIDO that matches search value

Example request

GET /organization/SD/process-instances/search?q=test HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjU5MTA5NzQ1MTA5MjM3NzYsImV4cCI6MTUyODk2MDkzMCwiY2xpZW50SWQiOjUwMzEzNjUyMDg3MDI5NzYsIm9yZ0NvZGUiOiJTRCIsInJvbGVzIjpbImFkbWluaXN0cmF0b3IiXSwiZG9tYWluQXBwUm9sZXMiOlsiQU5BTFlTVCIsIlNVUFBPUlQiLCJDTElFTlQiXSwicGVybWlzc2lvbnMiOlsiUkVUUllfV09SS0ZMT1ciLCJST0xFX2FkbWluaXN0cmF0b3IiLCJFUlJPUl9NQU5BR0VNRU5UIiwiU1VCU0NSSUJFUlNfTUFOQUdFTUVOVCIsIkNSRUFURV9VU0VSIiwiRVhFQ1VURV9BQ1RJT04iLCJDTElFTlRfVVNFUlNfTUFOQUdFTUVOVCIsIkFQUFJPVkVfQ0FOQ0VMIiwiUkVRVUVTVF9DQU5DRUwiLCJVU0VSU19NQU5BR0VNRU5UIiwiTk9USUZJQ0FUSU9OU19NQU5BR0VNRU5UIiwiUEFZTUVOVFNfTUFOQUdFTUVOVCIsIkdFVF9VU0VSUyIsIlJFU09VUkNFU19NQU5BR0VNRU5UIiwiQUNDRVNTX0FETUlOX1BBR0UiLCJVU0VSX1JPTEVTX01BTkFHRU1FTlQiLCJDTElFTlRTX01BTkFHRU1FTlQiLCJIRUxQX0FSVElDTEVTX01BTkFHRU1FTlQiLCJTVEFSVF9XT1JLRkxPVyJdfQ.fgDI5q098OWppTCoui21w1UF_zV8IlECIENmqZEn8395pkwowe6SRSrxI0nOu9JXV0yqpGw4TpnVXkLb39vrKg
Host: corporateservices.com

$ curl 'https://corporateservices.com:8080/organization/SD/process-instances/search?q=test' -i -H 'Content-Type: application/json' -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjU5MTA5NzQ1MTA5MjM3NzYsImV4cCI6MTUyODk2MDkzMCwiY2xpZW50SWQiOjUwMzEzNjUyMDg3MDI5NzYsIm9yZ0NvZGUiOiJTRCIsInJvbGVzIjpbImFkbWluaXN0cmF0b3IiXSwiZG9tYWluQXBwUm9sZXMiOlsiQU5BTFlTVCIsIlNVUFBPUlQiLCJDTElFTlQiXSwicGVybWlzc2lvbnMiOlsiUkVUUllfV09SS0ZMT1ciLCJST0xFX2FkbWluaXN0cmF0b3IiLCJFUlJPUl9NQU5BR0VNRU5UIiwiU1VCU0NSSUJFUlNfTUFOQUdFTUVOVCIsIkNSRUFURV9VU0VSIiwiRVhFQ1VURV9BQ1RJT04iLCJDTElFTlRfVVNFUlNfTUFOQUdFTUVOVCIsIkFQUFJPVkVfQ0FOQ0VMIiwiUkVRVUVTVF9DQU5DRUwiLCJVU0VSU19NQU5BR0VNRU5UIiwiTk9USUZJQ0FUSU9OU19NQU5BR0VNRU5UIiwiUEFZTUVOVFNfTUFOQUdFTUVOVCIsIkdFVF9VU0VSUyIsIlJFU09VUkNFU19NQU5BR0VNRU5UIiwiQUNDRVNTX0FETUlOX1BBR0UiLCJVU0VSX1JPTEVTX01BTkFHRU1FTlQiLCJDTElFTlRTX01BTkFHRU1FTlQiLCJIRUxQX0FSVElDTEVTX01BTkFHRU1FTlQiLCJTVEFSVF9XT1JLRkxPVyJdfQ.fgDI5q098OWppTCoui21w1UF_zV8IlECIENmqZEn8395pkwowe6SRSrxI0nOu9JXV0yqpGw4TpnVXkLb39vrKg'

/organization/{orgCode}/process-instances/search

Parameter	Description
orgCode	Organization code

Parameter	Description
q	Search value

Example response

HTTP/1.1 200 OK
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: POST, GET, PUT, OPTIONS, DELETE
Access-Control-Max-Age: 3600
Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Authorization
Content-Type: application/json;charset=UTF-8
Content-Length: 1060

[ {
  "_type" : "com.avocado.workflow.common.resources.ActiveServiceRequestResource",
  "ServiceName" : "Change Address Workflow",
  "StartedDate" : "2018-05-15T10:22:10.745+03:00",
  "StepDue" : "2018-05-15T10:32:10.786+03:00",
  "MasterRootEntityDisplayProperty" : "avocado2",
  "StepEnteredDate" : "2018-05-15T10:22:10.791+03:00",
  "StepName" : "Initial Application",
  "DataDirty" : true,
  "ClientActionRequired" : true,
  "ActivityInstanceKey" : "ahRzfmF2b2NhZG8tYmFja2VuZC12MXI5CxIPUHJvY2Vzc0luc3RhbmNlGICAgICAgIwIDAsSEEFjdGl2aXR5SW5zdGFuY2UYgICAgICAjAsM",
  "ProcessInstanceKey" : "ahRzfmF2b2NhZG8tYmFja2VuZC12MXIcCxIPUHJvY2Vzc0luc3RhbmNlGICAgICAgIwIDA",
  "ProcessInstanceId" : 4556376185503744,
  "CurrentPublishedForm" : "ahRzfmF2b2NhZG8tYmFja2VuZC12MXJoCxIMT3JnYW5pemF0aW9uIgNTR1AMCxIIV29ya2Zsb3ciF0NIQU5HRS1BRERSRVNTLVdPUktGTE9XDAsSD1dvcmtmbG93VmVyc2lvbhgBDAsSDFdvcmtmbG93Rm9ybRiAgICAgIC0CQw",
  "StepCode" : "CHANGE-ADDRESS-WORKFLOW-DRAFT",
  "Assignee" : "Adam Analyst",
  "Title" : "Change Address Workflow",
  "ClientName" : "New Startup"
} ]

Path	Type	Description
[]	String	List of process instances
[0].ServiceName	String	Name of service(workflow)
[0].StartedDate	String	Date and time when workflow started
[0].CompletedDate	String	Date and time when workflow was completed (Applicable only for completed workflows)
[0].StepName	String	Name of current step (Applicable only for active workflows)
[0].StepCode	String	Code of current step (Applicable only for active workflows)
[0].StepEnteredDate	String	Start date and time of current step (Applicable only for active workflows)
[0].StepDue	String	Due date and time of current step (Applicable only for active workflows)
[0].Assignee	String	Current assignee (Applicable only for active workflows)
[0].Status	String	Current workflow status (Applicable only for active workflows)
[0].ClientActionRequired	Boolean	If client action is required (Applicable only for active workflows)
[0].ActivityInstanceKey	String	Key of current active activity instance (Applicable only for active workflows)
[0].ProcessInstanceKey	String	Key of process instance (Applicable only for active workflows)
[0].CurrentPublishedForm	String	Form that wos used on start of this workflow (Applicable only for active workflows)
[0].MasterRootEntityDisplayProperty	String	Master root entity name

Request process instance cancellation

A PUT request will mark process instance as CANCELLATION_REQUESTED and delete all task views

Example request

PUT /organization/SD/process-instance/4556376185503744/activity-instance/ahRzfmF2b2NhZG8tYmFja2VuZC12MXI5CxIPUHJvY2Vzc0luc3RhbmNlGICAgICAgLQLDAsSEEFjdGl2aXR5SW5zdGFuY2UYgICAgICA9AkM/request-cancel HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjU5MTA5NzQ1MTA5MjM3NzYsImV4cCI6MTUyODk2MDkzMCwib3JnQ29kZSI6IlNEIiwicm9sZXMiOlsiYWRtaW5pc3RyYXRvciIsInRlY2hfc3VwcG9ydCJdLCJkb21haW5BcHBSb2xlcyI6WyJBTkFMWVNUIiwiU1VQUE9SVCJdLCJwZXJtaXNzaW9ucyI6WyJSRVRSWV9XT1JLRkxPVyIsIlJPTEVfYWRtaW5pc3RyYXRvciIsIkVSUk9SX01BTkFHRU1FTlQiLCJTVUJTQ1JJQkVSU19NQU5BR0VNRU5UIiwiQ1JFQVRFX1VTRVIiLCJFWEVDVVRFX0FDVElPTiIsIlJPTEVfdGVjaF9zdXBwb3J0IiwiQ0xJRU5UX1VTRVJTX01BTkFHRU1FTlQiLCJBUFBST1ZFX0NBTkNFTCIsIlJFUVVFU1RfQ0FOQ0VMIiwiVVNFUlNfTUFOQUdFTUVOVCIsIk5PVElGSUNBVElPTlNfTUFOQUdFTUVOVCIsIlBBWU1FTlRTX01BTkFHRU1FTlQiLCJHRVRfVVNFUlMiLCJSRVNPVVJDRVNfTUFOQUdFTUVOVCIsIkFDQ0VTU19BRE1JTl9QQUdFIiwiVVNFUl9ST0xFU19NQU5BR0VNRU5UIiwiQ0xJRU5UU19NQU5BR0VNRU5UIiwiSEVMUF9BUlRJQ0xFU19NQU5BR0VNRU5UIiwiU1RBUlRfV09SS0ZMT1ciXX0.phsEQMaRTSjbgCpPpIYHG_HkQFdswE7_9iKLOWi4bxy0P5NFyPRHCqyOsyLpyhgM3wD05_tAL5ijnMXONjbU6Q
Host: corporateservices.com
Content-Length: 34

{"reason": "Do not need anymore."}

$ curl 'https://corporateservices.com:8080/organization/SD/process-instance/4556376185503744/activity-instance/ahRzfmF2b2NhZG8tYmFja2VuZC12MXI5CxIPUHJvY2Vzc0luc3RhbmNlGICAgICAgLQLDAsSEEFjdGl2aXR5SW5zdGFuY2UYgICAgICA9AkM/request-cancel' -i -X PUT -H 'Content-Type: application/json' -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjU5MTA5NzQ1MTA5MjM3NzYsImV4cCI6MTUyODk2MDkzMCwib3JnQ29kZSI6IlNEIiwicm9sZXMiOlsiYWRtaW5pc3RyYXRvciIsInRlY2hfc3VwcG9ydCJdLCJkb21haW5BcHBSb2xlcyI6WyJBTkFMWVNUIiwiU1VQUE9SVCJdLCJwZXJtaXNzaW9ucyI6WyJSRVRSWV9XT1JLRkxPVyIsIlJPTEVfYWRtaW5pc3RyYXRvciIsIkVSUk9SX01BTkFHRU1FTlQiLCJTVUJTQ1JJQkVSU19NQU5BR0VNRU5UIiwiQ1JFQVRFX1VTRVIiLCJFWEVDVVRFX0FDVElPTiIsIlJPTEVfdGVjaF9zdXBwb3J0IiwiQ0xJRU5UX1VTRVJTX01BTkFHRU1FTlQiLCJBUFBST1ZFX0NBTkNFTCIsIlJFUVVFU1RfQ0FOQ0VMIiwiVVNFUlNfTUFOQUdFTUVOVCIsIk5PVElGSUNBVElPTlNfTUFOQUdFTUVOVCIsIlBBWU1FTlRTX01BTkFHRU1FTlQiLCJHRVRfVVNFUlMiLCJSRVNPVVJDRVNfTUFOQUdFTUVOVCIsIkFDQ0VTU19BRE1JTl9QQUdFIiwiVVNFUl9ST0xFU19NQU5BR0VNRU5UIiwiQ0xJRU5UU19NQU5BR0VNRU5UIiwiSEVMUF9BUlRJQ0xFU19NQU5BR0VNRU5UIiwiU1RBUlRfV09SS0ZMT1ciXX0.phsEQMaRTSjbgCpPpIYHG_HkQFdswE7_9iKLOWi4bxy0P5NFyPRHCqyOsyLpyhgM3wD05_tAL5ijnMXONjbU6Q' -d '{"reason": "Do not need anymore."}'

/organization/{orgCode}/process-instance/{piId}/activity-instance/{aiKey}/request-cancel

Parameter	Description
orgCode	Organization code
piId	Process instance id
aiKey	Keu of activity instance

Path	Type	Description
reason	String	The reason of cancellation

Example response

HTTP/1.1 200 OK
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: POST, GET, PUT, OPTIONS, DELETE
Access-Control-Max-Age: 3600
Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Authorization

List process instances that waits cancellation

A GET request will return list of waiting cancellation process instances

Example request

GET /organization/SD/process-instances/cancellation-requested HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjU5MTA5NzQ1MTA5MjM3NzYsImV4cCI6MTUyODk2MDkzMCwib3JnQ29kZSI6IlNEIiwicm9sZXMiOlsiYWRtaW5pc3RyYXRvciIsInRlY2hfc3VwcG9ydCJdLCJkb21haW5BcHBSb2xlcyI6WyJBTkFMWVNUIiwiU1VQUE9SVCJdLCJwZXJtaXNzaW9ucyI6WyJSRVRSWV9XT1JLRkxPVyIsIlJPTEVfYWRtaW5pc3RyYXRvciIsIkVSUk9SX01BTkFHRU1FTlQiLCJTVUJTQ1JJQkVSU19NQU5BR0VNRU5UIiwiQ1JFQVRFX1VTRVIiLCJFWEVDVVRFX0FDVElPTiIsIlJPTEVfdGVjaF9zdXBwb3J0IiwiQ0xJRU5UX1VTRVJTX01BTkFHRU1FTlQiLCJBUFBST1ZFX0NBTkNFTCIsIlJFUVVFU1RfQ0FOQ0VMIiwiVVNFUlNfTUFOQUdFTUVOVCIsIk5PVElGSUNBVElPTlNfTUFOQUdFTUVOVCIsIlBBWU1FTlRTX01BTkFHRU1FTlQiLCJHRVRfVVNFUlMiLCJSRVNPVVJDRVNfTUFOQUdFTUVOVCIsIkFDQ0VTU19BRE1JTl9QQUdFIiwiVVNFUl9ST0xFU19NQU5BR0VNRU5UIiwiQ0xJRU5UU19NQU5BR0VNRU5UIiwiSEVMUF9BUlRJQ0xFU19NQU5BR0VNRU5UIiwiU1RBUlRfV09SS0ZMT1ciXX0.phsEQMaRTSjbgCpPpIYHG_HkQFdswE7_9iKLOWi4bxy0P5NFyPRHCqyOsyLpyhgM3wD05_tAL5ijnMXONjbU6Q
Host: corporateservices.com

$ curl 'https://corporateservices.com:8080/organization/SD/process-instances/cancellation-requested' -i -H 'Content-Type: application/json' -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjU5MTA5NzQ1MTA5MjM3NzYsImV4cCI6MTUyODk2MDkzMCwib3JnQ29kZSI6IlNEIiwicm9sZXMiOlsiYWRtaW5pc3RyYXRvciIsInRlY2hfc3VwcG9ydCJdLCJkb21haW5BcHBSb2xlcyI6WyJBTkFMWVNUIiwiU1VQUE9SVCJdLCJwZXJtaXNzaW9ucyI6WyJSRVRSWV9XT1JLRkxPVyIsIlJPTEVfYWRtaW5pc3RyYXRvciIsIkVSUk9SX01BTkFHRU1FTlQiLCJTVUJTQ1JJQkVSU19NQU5BR0VNRU5UIiwiQ1JFQVRFX1VTRVIiLCJFWEVDVVRFX0FDVElPTiIsIlJPTEVfdGVjaF9zdXBwb3J0IiwiQ0xJRU5UX1VTRVJTX01BTkFHRU1FTlQiLCJBUFBST1ZFX0NBTkNFTCIsIlJFUVVFU1RfQ0FOQ0VMIiwiVVNFUlNfTUFOQUdFTUVOVCIsIk5PVElGSUNBVElPTlNfTUFOQUdFTUVOVCIsIlBBWU1FTlRTX01BTkFHRU1FTlQiLCJHRVRfVVNFUlMiLCJSRVNPVVJDRVNfTUFOQUdFTUVOVCIsIkFDQ0VTU19BRE1JTl9QQUdFIiwiVVNFUl9ST0xFU19NQU5BR0VNRU5UIiwiQ0xJRU5UU19NQU5BR0VNRU5UIiwiSEVMUF9BUlRJQ0xFU19NQU5BR0VNRU5UIiwiU1RBUlRfV09SS0ZMT1ciXX0.phsEQMaRTSjbgCpPpIYHG_HkQFdswE7_9iKLOWi4bxy0P5NFyPRHCqyOsyLpyhgM3wD05_tAL5ijnMXONjbU6Q'

/organization/{orgCode}/process-instances/cancellation-requested

Parameter	Description
orgCode	Organization code

Example response

HTTP/1.1 200 OK
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: POST, GET, PUT, OPTIONS, DELETE
Access-Control-Max-Age: 3600
Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Authorization
Content-Type: application/json;charset=UTF-8
Content-Length: 1149

[ {
  "_type" : "com.avocado.workflow.common.resources.ActiveServiceRequestResource",
  "ServiceName" : "Change Address Workflow",
  "StartedDate" : "2018-05-15T10:22:10.745+03:00",
  "StepDue" : "2018-05-15T10:32:10.786+03:00",
  "MasterRootEntityDisplayProperty" : "avocado2",
  "StepEnteredDate" : "2018-05-15T10:22:10.791+03:00",
  "StepName" : "Initial Application",
  "Status" : "Cancellation requested",
  "DataDirty" : true,
  "ClientActionRequired" : false,
  "ActivityInstanceKey" : "ahRzfmF2b2NhZG8tYmFja2VuZC12MXI5CxIPUHJvY2Vzc0luc3RhbmNlGICAgICAgIwIDAsSEEFjdGl2aXR5SW5zdGFuY2UYgICAgICAjAsM",
  "ProcessInstanceKey" : "ahRzfmF2b2NhZG8tYmFja2VuZC12MXIcCxIPUHJvY2Vzc0luc3RhbmNlGICAgICAgIwIDA",
  "ProcessInstanceId" : 4556376185503744,
  "CurrentPublishedForm" : "ahRzfmF2b2NhZG8tYmFja2VuZC12MXJoCxIMT3JnYW5pemF0aW9uIgNTR1AMCxIIV29ya2Zsb3ciF0NIQU5HRS1BRERSRVNTLVdPUktGTE9XDAsSD1dvcmtmbG93VmVyc2lvbhgBDAsSDFdvcmtmbG93Rm9ybRiAgICAgIC0CQw",
  "StepCode" : "CHANGE-ADDRESS-WORKFLOW-DRAFT",
  "Assignee" : "Adam Analyst",
  "Title" : "Change Address Workflow",
  "ClientName" : "New Startup",
  "CancellationReason" : "Do not need anymore."
} ]

Path	Type	Description
[]	Array	List of process instances
[0].ServiceName	String	Name of service(workflow)
[0].StartedDate	String	Date and time when workflow started
[0].CompletedDate	String	Date and time when workflow was completed (Applicable only for completed workflows)
[0].StepName	String	Name of current step (Applicable only for active workflows)
[0].StepCode	String	Code of current step (Applicable only for active workflows)
[0].StepEnteredDate	String	Start date and time of current step (Applicable only for active workflows)
[0].StepDue	String	Due date and time of current step (Applicable only for active workflows)
[0].Assignee	String	Current assignee (Applicable only for active workflows)
[0].Status	String	Current workflow status (Applicable only for active workflows)
[0].ClientActionRequired	Boolean	If client action is required (Applicable only for active workflows)
[0].ActivityInstanceKey	String	Key of current active activity instance (Applicable only for active workflows)
[0].ProcessInstanceKey	String	Key of process instance (Applicable only for active workflows)
[0].ProcessInstanceId	String	Id of process instance (Applicable only for active workflows)
[0].CurrentPublishedForm	String	Form that wos used on start of this workflow (Applicable only for active workflows)
[0].MasterRootEntityDisplayProperty	String	Master root entity name
[0].ClientName	String	Name of client workflow started for
[0].CancellationReason	String	Reason of cancellation of this request

Deny cancellation request

A PUT request will deny cancellation request and make process instance active again

Example request

PUT /organization/SD/process-instance/4556376185503744/deny-cancel HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjU5MTA5NzQ1MTA5MjM3NzYsImV4cCI6MTUyODk2MDkzMCwib3JnQ29kZSI6IlNEIiwicm9sZXMiOlsiYWRtaW5pc3RyYXRvciIsInRlY2hfc3VwcG9ydCJdLCJkb21haW5BcHBSb2xlcyI6WyJBTkFMWVNUIiwiU1VQUE9SVCJdLCJwZXJtaXNzaW9ucyI6WyJSRVRSWV9XT1JLRkxPVyIsIlJPTEVfYWRtaW5pc3RyYXRvciIsIkVSUk9SX01BTkFHRU1FTlQiLCJTVUJTQ1JJQkVSU19NQU5BR0VNRU5UIiwiQ1JFQVRFX1VTRVIiLCJFWEVDVVRFX0FDVElPTiIsIlJPTEVfdGVjaF9zdXBwb3J0IiwiQ0xJRU5UX1VTRVJTX01BTkFHRU1FTlQiLCJBUFBST1ZFX0NBTkNFTCIsIlJFUVVFU1RfQ0FOQ0VMIiwiVVNFUlNfTUFOQUdFTUVOVCIsIk5PVElGSUNBVElPTlNfTUFOQUdFTUVOVCIsIlBBWU1FTlRTX01BTkFHRU1FTlQiLCJHRVRfVVNFUlMiLCJSRVNPVVJDRVNfTUFOQUdFTUVOVCIsIkFDQ0VTU19BRE1JTl9QQUdFIiwiVVNFUl9ST0xFU19NQU5BR0VNRU5UIiwiQ0xJRU5UU19NQU5BR0VNRU5UIiwiSEVMUF9BUlRJQ0xFU19NQU5BR0VNRU5UIiwiU1RBUlRfV09SS0ZMT1ciXX0.phsEQMaRTSjbgCpPpIYHG_HkQFdswE7_9iKLOWi4bxy0P5NFyPRHCqyOsyLpyhgM3wD05_tAL5ijnMXONjbU6Q
Host: corporateservices.com

$ curl 'https://corporateservices.com:8080/organization/SD/process-instance/4556376185503744/deny-cancel' -i -X PUT -H 'Content-Type: application/json' -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjU5MTA5NzQ1MTA5MjM3NzYsImV4cCI6MTUyODk2MDkzMCwib3JnQ29kZSI6IlNEIiwicm9sZXMiOlsiYWRtaW5pc3RyYXRvciIsInRlY2hfc3VwcG9ydCJdLCJkb21haW5BcHBSb2xlcyI6WyJBTkFMWVNUIiwiU1VQUE9SVCJdLCJwZXJtaXNzaW9ucyI6WyJSRVRSWV9XT1JLRkxPVyIsIlJPTEVfYWRtaW5pc3RyYXRvciIsIkVSUk9SX01BTkFHRU1FTlQiLCJTVUJTQ1JJQkVSU19NQU5BR0VNRU5UIiwiQ1JFQVRFX1VTRVIiLCJFWEVDVVRFX0FDVElPTiIsIlJPTEVfdGVjaF9zdXBwb3J0IiwiQ0xJRU5UX1VTRVJTX01BTkFHRU1FTlQiLCJBUFBST1ZFX0NBTkNFTCIsIlJFUVVFU1RfQ0FOQ0VMIiwiVVNFUlNfTUFOQUdFTUVOVCIsIk5PVElGSUNBVElPTlNfTUFOQUdFTUVOVCIsIlBBWU1FTlRTX01BTkFHRU1FTlQiLCJHRVRfVVNFUlMiLCJSRVNPVVJDRVNfTUFOQUdFTUVOVCIsIkFDQ0VTU19BRE1JTl9QQUdFIiwiVVNFUl9ST0xFU19NQU5BR0VNRU5UIiwiQ0xJRU5UU19NQU5BR0VNRU5UIiwiSEVMUF9BUlRJQ0xFU19NQU5BR0VNRU5UIiwiU1RBUlRfV09SS0ZMT1ciXX0.phsEQMaRTSjbgCpPpIYHG_HkQFdswE7_9iKLOWi4bxy0P5NFyPRHCqyOsyLpyhgM3wD05_tAL5ijnMXONjbU6Q'

/organization/{orgCode}/process-instance/{piId}/deny-cancel

Parameter	Description
orgCode	Organization code
piId	Process instance id

Example response

HTTP/1.1 200 OK
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: POST, GET, PUT, OPTIONS, DELETE
Access-Control-Max-Age: 3600
Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Authorization

Approve cancellation request

A PUT request will approve cancellation request and make process instance completed with TERMINATED status

Example request

PUT /organization/SD/process-instance/4556376185503744/approve-cancel HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjU5MTA5NzQ1MTA5MjM3NzYsImV4cCI6MTUyODk2MDkzMCwib3JnQ29kZSI6IlNEIiwicm9sZXMiOlsiYWRtaW5pc3RyYXRvciIsInRlY2hfc3VwcG9ydCJdLCJkb21haW5BcHBSb2xlcyI6WyJBTkFMWVNUIiwiU1VQUE9SVCJdLCJwZXJtaXNzaW9ucyI6WyJSRVRSWV9XT1JLRkxPVyIsIlJPTEVfYWRtaW5pc3RyYXRvciIsIkVSUk9SX01BTkFHRU1FTlQiLCJTVUJTQ1JJQkVSU19NQU5BR0VNRU5UIiwiQ1JFQVRFX1VTRVIiLCJFWEVDVVRFX0FDVElPTiIsIlJPTEVfdGVjaF9zdXBwb3J0IiwiQ0xJRU5UX1VTRVJTX01BTkFHRU1FTlQiLCJBUFBST1ZFX0NBTkNFTCIsIlJFUVVFU1RfQ0FOQ0VMIiwiVVNFUlNfTUFOQUdFTUVOVCIsIk5PVElGSUNBVElPTlNfTUFOQUdFTUVOVCIsIlBBWU1FTlRTX01BTkFHRU1FTlQiLCJHRVRfVVNFUlMiLCJSRVNPVVJDRVNfTUFOQUdFTUVOVCIsIkFDQ0VTU19BRE1JTl9QQUdFIiwiVVNFUl9ST0xFU19NQU5BR0VNRU5UIiwiQ0xJRU5UU19NQU5BR0VNRU5UIiwiSEVMUF9BUlRJQ0xFU19NQU5BR0VNRU5UIiwiU1RBUlRfV09SS0ZMT1ciXX0.phsEQMaRTSjbgCpPpIYHG_HkQFdswE7_9iKLOWi4bxy0P5NFyPRHCqyOsyLpyhgM3wD05_tAL5ijnMXONjbU6Q
Host: corporateservices.com

$ curl 'https://corporateservices.com:8080/organization/SD/process-instance/4556376185503744/approve-cancel' -i -X PUT -H 'Content-Type: application/json' -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjU5MTA5NzQ1MTA5MjM3NzYsImV4cCI6MTUyODk2MDkzMCwib3JnQ29kZSI6IlNEIiwicm9sZXMiOlsiYWRtaW5pc3RyYXRvciIsInRlY2hfc3VwcG9ydCJdLCJkb21haW5BcHBSb2xlcyI6WyJBTkFMWVNUIiwiU1VQUE9SVCJdLCJwZXJtaXNzaW9ucyI6WyJSRVRSWV9XT1JLRkxPVyIsIlJPTEVfYWRtaW5pc3RyYXRvciIsIkVSUk9SX01BTkFHRU1FTlQiLCJTVUJTQ1JJQkVSU19NQU5BR0VNRU5UIiwiQ1JFQVRFX1VTRVIiLCJFWEVDVVRFX0FDVElPTiIsIlJPTEVfdGVjaF9zdXBwb3J0IiwiQ0xJRU5UX1VTRVJTX01BTkFHRU1FTlQiLCJBUFBST1ZFX0NBTkNFTCIsIlJFUVVFU1RfQ0FOQ0VMIiwiVVNFUlNfTUFOQUdFTUVOVCIsIk5PVElGSUNBVElPTlNfTUFOQUdFTUVOVCIsIlBBWU1FTlRTX01BTkFHRU1FTlQiLCJHRVRfVVNFUlMiLCJSRVNPVVJDRVNfTUFOQUdFTUVOVCIsIkFDQ0VTU19BRE1JTl9QQUdFIiwiVVNFUl9ST0xFU19NQU5BR0VNRU5UIiwiQ0xJRU5UU19NQU5BR0VNRU5UIiwiSEVMUF9BUlRJQ0xFU19NQU5BR0VNRU5UIiwiU1RBUlRfV09SS0ZMT1ciXX0.phsEQMaRTSjbgCpPpIYHG_HkQFdswE7_9iKLOWi4bxy0P5NFyPRHCqyOsyLpyhgM3wD05_tAL5ijnMXONjbU6Q'

/organization/{orgCode}/process-instance/{piId}/approve-cancel

Parameter	Description
orgCode	Organization code
piId	Process instance id

Example response

HTTP/1.1 200 OK
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: POST, GET, PUT, OPTIONS, DELETE
Access-Control-Max-Age: 3600
Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Authorization

Soft delete process instance

A POST request will mark process instance and all views as deleted

Example request

POST /organization/SD/process-instances/4556376185503744/delete HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjU5MTA5NzQ1MTA5MjM3NzYsImV4cCI6MTUyODk2MDkzMCwib3JnQ29kZSI6IlNEIiwicm9sZXMiOlsiYWRtaW5pc3RyYXRvciIsInRlY2hfc3VwcG9ydCJdLCJkb21haW5BcHBSb2xlcyI6WyJBTkFMWVNUIiwiU1VQUE9SVCJdLCJwZXJtaXNzaW9ucyI6WyJSRVRSWV9XT1JLRkxPVyIsIlJPTEVfYWRtaW5pc3RyYXRvciIsIkVSUk9SX01BTkFHRU1FTlQiLCJTVUJTQ1JJQkVSU19NQU5BR0VNRU5UIiwiQ1JFQVRFX1VTRVIiLCJFWEVDVVRFX0FDVElPTiIsIlJPTEVfdGVjaF9zdXBwb3J0IiwiQ0xJRU5UX1VTRVJTX01BTkFHRU1FTlQiLCJBUFBST1ZFX0NBTkNFTCIsIlJFUVVFU1RfQ0FOQ0VMIiwiVVNFUlNfTUFOQUdFTUVOVCIsIk5PVElGSUNBVElPTlNfTUFOQUdFTUVOVCIsIlBBWU1FTlRTX01BTkFHRU1FTlQiLCJHRVRfVVNFUlMiLCJSRVNPVVJDRVNfTUFOQUdFTUVOVCIsIkFDQ0VTU19BRE1JTl9QQUdFIiwiVVNFUl9ST0xFU19NQU5BR0VNRU5UIiwiQ0xJRU5UU19NQU5BR0VNRU5UIiwiSEVMUF9BUlRJQ0xFU19NQU5BR0VNRU5UIiwiU1RBUlRfV09SS0ZMT1ciXX0.phsEQMaRTSjbgCpPpIYHG_HkQFdswE7_9iKLOWi4bxy0P5NFyPRHCqyOsyLpyhgM3wD05_tAL5ijnMXONjbU6Q
Host: corporateservices.com

$ curl 'https://corporateservices.com:8080/organization/SD/process-instances/4556376185503744/delete' -i -X POST -H 'Content-Type: application/json' -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjU5MTA5NzQ1MTA5MjM3NzYsImV4cCI6MTUyODk2MDkzMCwib3JnQ29kZSI6IlNEIiwicm9sZXMiOlsiYWRtaW5pc3RyYXRvciIsInRlY2hfc3VwcG9ydCJdLCJkb21haW5BcHBSb2xlcyI6WyJBTkFMWVNUIiwiU1VQUE9SVCJdLCJwZXJtaXNzaW9ucyI6WyJSRVRSWV9XT1JLRkxPVyIsIlJPTEVfYWRtaW5pc3RyYXRvciIsIkVSUk9SX01BTkFHRU1FTlQiLCJTVUJTQ1JJQkVSU19NQU5BR0VNRU5UIiwiQ1JFQVRFX1VTRVIiLCJFWEVDVVRFX0FDVElPTiIsIlJPTEVfdGVjaF9zdXBwb3J0IiwiQ0xJRU5UX1VTRVJTX01BTkFHRU1FTlQiLCJBUFBST1ZFX0NBTkNFTCIsIlJFUVVFU1RfQ0FOQ0VMIiwiVVNFUlNfTUFOQUdFTUVOVCIsIk5PVElGSUNBVElPTlNfTUFOQUdFTUVOVCIsIlBBWU1FTlRTX01BTkFHRU1FTlQiLCJHRVRfVVNFUlMiLCJSRVNPVVJDRVNfTUFOQUdFTUVOVCIsIkFDQ0VTU19BRE1JTl9QQUdFIiwiVVNFUl9ST0xFU19NQU5BR0VNRU5UIiwiQ0xJRU5UU19NQU5BR0VNRU5UIiwiSEVMUF9BUlRJQ0xFU19NQU5BR0VNRU5UIiwiU1RBUlRfV09SS0ZMT1ciXX0.phsEQMaRTSjbgCpPpIYHG_HkQFdswE7_9iKLOWi4bxy0P5NFyPRHCqyOsyLpyhgM3wD05_tAL5ijnMXONjbU6Q'

/organization/{orgCode}/process-instances/{id}/delete

Parameter	Description
orgCode	Organization code
id	Process instance id

Example response

HTTP/1.1 200 OK
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: POST, GET, PUT, OPTIONS, DELETE
Access-Control-Max-Age: 3600
Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Authorization

Undelete process instance

A POST request will mark process instance and all views as NOT deleted

Example request

POST /organization/SD/process-instances/4556376185503744/undelete HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjU5MTA5NzQ1MTA5MjM3NzYsImV4cCI6MTUyODk2MDkzMCwib3JnQ29kZSI6IlNEIiwicm9sZXMiOlsiYWRtaW5pc3RyYXRvciIsInRlY2hfc3VwcG9ydCJdLCJkb21haW5BcHBSb2xlcyI6WyJBTkFMWVNUIiwiU1VQUE9SVCJdLCJwZXJtaXNzaW9ucyI6WyJSRVRSWV9XT1JLRkxPVyIsIlJPTEVfYWRtaW5pc3RyYXRvciIsIkVSUk9SX01BTkFHRU1FTlQiLCJTVUJTQ1JJQkVSU19NQU5BR0VNRU5UIiwiQ1JFQVRFX1VTRVIiLCJFWEVDVVRFX0FDVElPTiIsIlJPTEVfdGVjaF9zdXBwb3J0IiwiQ0xJRU5UX1VTRVJTX01BTkFHRU1FTlQiLCJBUFBST1ZFX0NBTkNFTCIsIlJFUVVFU1RfQ0FOQ0VMIiwiVVNFUlNfTUFOQUdFTUVOVCIsIk5PVElGSUNBVElPTlNfTUFOQUdFTUVOVCIsIlBBWU1FTlRTX01BTkFHRU1FTlQiLCJHRVRfVVNFUlMiLCJSRVNPVVJDRVNfTUFOQUdFTUVOVCIsIkFDQ0VTU19BRE1JTl9QQUdFIiwiVVNFUl9ST0xFU19NQU5BR0VNRU5UIiwiQ0xJRU5UU19NQU5BR0VNRU5UIiwiSEVMUF9BUlRJQ0xFU19NQU5BR0VNRU5UIiwiU1RBUlRfV09SS0ZMT1ciXX0.phsEQMaRTSjbgCpPpIYHG_HkQFdswE7_9iKLOWi4bxy0P5NFyPRHCqyOsyLpyhgM3wD05_tAL5ijnMXONjbU6Q
Host: corporateservices.com

$ curl 'https://corporateservices.com:8080/organization/SD/process-instances/4556376185503744/undelete' -i -X POST -H 'Content-Type: application/json' -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjU5MTA5NzQ1MTA5MjM3NzYsImV4cCI6MTUyODk2MDkzMCwib3JnQ29kZSI6IlNEIiwicm9sZXMiOlsiYWRtaW5pc3RyYXRvciIsInRlY2hfc3VwcG9ydCJdLCJkb21haW5BcHBSb2xlcyI6WyJBTkFMWVNUIiwiU1VQUE9SVCJdLCJwZXJtaXNzaW9ucyI6WyJSRVRSWV9XT1JLRkxPVyIsIlJPTEVfYWRtaW5pc3RyYXRvciIsIkVSUk9SX01BTkFHRU1FTlQiLCJTVUJTQ1JJQkVSU19NQU5BR0VNRU5UIiwiQ1JFQVRFX1VTRVIiLCJFWEVDVVRFX0FDVElPTiIsIlJPTEVfdGVjaF9zdXBwb3J0IiwiQ0xJRU5UX1VTRVJTX01BTkFHRU1FTlQiLCJBUFBST1ZFX0NBTkNFTCIsIlJFUVVFU1RfQ0FOQ0VMIiwiVVNFUlNfTUFOQUdFTUVOVCIsIk5PVElGSUNBVElPTlNfTUFOQUdFTUVOVCIsIlBBWU1FTlRTX01BTkFHRU1FTlQiLCJHRVRfVVNFUlMiLCJSRVNPVVJDRVNfTUFOQUdFTUVOVCIsIkFDQ0VTU19BRE1JTl9QQUdFIiwiVVNFUl9ST0xFU19NQU5BR0VNRU5UIiwiQ0xJRU5UU19NQU5BR0VNRU5UIiwiSEVMUF9BUlRJQ0xFU19NQU5BR0VNRU5UIiwiU1RBUlRfV09SS0ZMT1ciXX0.phsEQMaRTSjbgCpPpIYHG_HkQFdswE7_9iKLOWi4bxy0P5NFyPRHCqyOsyLpyhgM3wD05_tAL5ijnMXONjbU6Q'

/organization/{orgCode}/process-instances/{id}/undelete

Parameter	Description
orgCode	Organization code
id	Process instance id

Example response

HTTP/1.1 200 OK
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: POST, GET, PUT, OPTIONS, DELETE
Access-Control-Max-Age: 3600
Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Authorization

Undelete process instance

A DELETE request will completely delete process instance and all activities and views

Example request

DELETE /organization/SD/process-instances/4556376185503744 HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjU5MTA5NzQ1MTA5MjM3NzYsImV4cCI6MTUyODk2MDkzMCwib3JnQ29kZSI6IlNEIiwicm9sZXMiOlsiYWRtaW5pc3RyYXRvciIsInRlY2hfc3VwcG9ydCJdLCJkb21haW5BcHBSb2xlcyI6WyJBTkFMWVNUIiwiU1VQUE9SVCJdLCJwZXJtaXNzaW9ucyI6WyJSRVRSWV9XT1JLRkxPVyIsIlJPTEVfYWRtaW5pc3RyYXRvciIsIkVSUk9SX01BTkFHRU1FTlQiLCJTVUJTQ1JJQkVSU19NQU5BR0VNRU5UIiwiQ1JFQVRFX1VTRVIiLCJFWEVDVVRFX0FDVElPTiIsIlJPTEVfdGVjaF9zdXBwb3J0IiwiQ0xJRU5UX1VTRVJTX01BTkFHRU1FTlQiLCJBUFBST1ZFX0NBTkNFTCIsIlJFUVVFU1RfQ0FOQ0VMIiwiVVNFUlNfTUFOQUdFTUVOVCIsIk5PVElGSUNBVElPTlNfTUFOQUdFTUVOVCIsIlBBWU1FTlRTX01BTkFHRU1FTlQiLCJHRVRfVVNFUlMiLCJSRVNPVVJDRVNfTUFOQUdFTUVOVCIsIkFDQ0VTU19BRE1JTl9QQUdFIiwiVVNFUl9ST0xFU19NQU5BR0VNRU5UIiwiQ0xJRU5UU19NQU5BR0VNRU5UIiwiSEVMUF9BUlRJQ0xFU19NQU5BR0VNRU5UIiwiU1RBUlRfV09SS0ZMT1ciXX0.phsEQMaRTSjbgCpPpIYHG_HkQFdswE7_9iKLOWi4bxy0P5NFyPRHCqyOsyLpyhgM3wD05_tAL5ijnMXONjbU6Q
Host: corporateservices.com

$ curl 'https://corporateservices.com:8080/organization/SD/process-instances/4556376185503744' -i -X DELETE -H 'Content-Type: application/json' -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjU5MTA5NzQ1MTA5MjM3NzYsImV4cCI6MTUyODk2MDkzMCwib3JnQ29kZSI6IlNEIiwicm9sZXMiOlsiYWRtaW5pc3RyYXRvciIsInRlY2hfc3VwcG9ydCJdLCJkb21haW5BcHBSb2xlcyI6WyJBTkFMWVNUIiwiU1VQUE9SVCJdLCJwZXJtaXNzaW9ucyI6WyJSRVRSWV9XT1JLRkxPVyIsIlJPTEVfYWRtaW5pc3RyYXRvciIsIkVSUk9SX01BTkFHRU1FTlQiLCJTVUJTQ1JJQkVSU19NQU5BR0VNRU5UIiwiQ1JFQVRFX1VTRVIiLCJFWEVDVVRFX0FDVElPTiIsIlJPTEVfdGVjaF9zdXBwb3J0IiwiQ0xJRU5UX1VTRVJTX01BTkFHRU1FTlQiLCJBUFBST1ZFX0NBTkNFTCIsIlJFUVVFU1RfQ0FOQ0VMIiwiVVNFUlNfTUFOQUdFTUVOVCIsIk5PVElGSUNBVElPTlNfTUFOQUdFTUVOVCIsIlBBWU1FTlRTX01BTkFHRU1FTlQiLCJHRVRfVVNFUlMiLCJSRVNPVVJDRVNfTUFOQUdFTUVOVCIsIkFDQ0VTU19BRE1JTl9QQUdFIiwiVVNFUl9ST0xFU19NQU5BR0VNRU5UIiwiQ0xJRU5UU19NQU5BR0VNRU5UIiwiSEVMUF9BUlRJQ0xFU19NQU5BR0VNRU5UIiwiU1RBUlRfV09SS0ZMT1ciXX0.phsEQMaRTSjbgCpPpIYHG_HkQFdswE7_9iKLOWi4bxy0P5NFyPRHCqyOsyLpyhgM3wD05_tAL5ijnMXONjbU6Q'

/organization/{orgCode}/process-instances/{id}

Parameter	Description
orgCode	Organization code
id	Process instance id

Example response

HTTP/1.1 200 OK
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: POST, GET, PUT, OPTIONS, DELETE
Access-Control-Max-Age: 3600
Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Authorization

Process instance tags

List tags for org

A GET request will return all tags for organization

Example request

GET /organization/SD/tags HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjU5MTA5NzQ1MTA5MjM3NzYsImV4cCI6MTUyODk2MDkxMywiY2xpZW50SWQiOjUwMzEzNjUyMDg3MDI5NzYsIm9yZ0NvZGUiOiJTRCIsInJvbGVzIjpbImFkbWluaXN0cmF0b3IiXSwiZG9tYWluQXBwUm9sZXMiOlsiQU5BTFlTVCIsIlNVUFBPUlQiLCJDTElFTlQiXSwicGVybWlzc2lvbnMiOlsiUkVUUllfV09SS0ZMT1ciLCJST0xFX2FkbWluaXN0cmF0b3IiLCJFUlJPUl9NQU5BR0VNRU5UIiwiU1VCU0NSSUJFUlNfTUFOQUdFTUVOVCIsIkNSRUFURV9VU0VSIiwiRVhFQ1VURV9BQ1RJT04iLCJDTElFTlRfVVNFUlNfTUFOQUdFTUVOVCIsIkFQUFJPVkVfQ0FOQ0VMIiwiUkVRVUVTVF9DQU5DRUwiLCJVU0VSU19NQU5BR0VNRU5UIiwiTk9USUZJQ0FUSU9OU19NQU5BR0VNRU5UIiwiUEFZTUVOVFNfTUFOQUdFTUVOVCIsIkdFVF9VU0VSUyIsIlJFU09VUkNFU19NQU5BR0VNRU5UIiwiQUNDRVNTX0FETUlOX1BBR0UiLCJVU0VSX1JPTEVTX01BTkFHRU1FTlQiLCJDTElFTlRTX01BTkFHRU1FTlQiLCJIRUxQX0FSVElDTEVTX01BTkFHRU1FTlQiLCJTVEFSVF9XT1JLRkxPVyJdfQ.lx7I99jpLq6WogaRGbN1ttLi4WaTI8fXQtaoZ2pRi0rjoBNK2maTtAcnY4dO_KhzHLiWJ_5Tjn9OKwFBCjzrRg
Host: corporateservices.com

$ curl 'https://corporateservices.com:8080/organization/SD/tags' -i -H 'Content-Type: application/json' -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjU5MTA5NzQ1MTA5MjM3NzYsImV4cCI6MTUyODk2MDkxMywiY2xpZW50SWQiOjUwMzEzNjUyMDg3MDI5NzYsIm9yZ0NvZGUiOiJTRCIsInJvbGVzIjpbImFkbWluaXN0cmF0b3IiXSwiZG9tYWluQXBwUm9sZXMiOlsiQU5BTFlTVCIsIlNVUFBPUlQiLCJDTElFTlQiXSwicGVybWlzc2lvbnMiOlsiUkVUUllfV09SS0ZMT1ciLCJST0xFX2FkbWluaXN0cmF0b3IiLCJFUlJPUl9NQU5BR0VNRU5UIiwiU1VCU0NSSUJFUlNfTUFOQUdFTUVOVCIsIkNSRUFURV9VU0VSIiwiRVhFQ1VURV9BQ1RJT04iLCJDTElFTlRfVVNFUlNfTUFOQUdFTUVOVCIsIkFQUFJPVkVfQ0FOQ0VMIiwiUkVRVUVTVF9DQU5DRUwiLCJVU0VSU19NQU5BR0VNRU5UIiwiTk9USUZJQ0FUSU9OU19NQU5BR0VNRU5UIiwiUEFZTUVOVFNfTUFOQUdFTUVOVCIsIkdFVF9VU0VSUyIsIlJFU09VUkNFU19NQU5BR0VNRU5UIiwiQUNDRVNTX0FETUlOX1BBR0UiLCJVU0VSX1JPTEVTX01BTkFHRU1FTlQiLCJDTElFTlRTX01BTkFHRU1FTlQiLCJIRUxQX0FSVElDTEVTX01BTkFHRU1FTlQiLCJTVEFSVF9XT1JLRkxPVyJdfQ.lx7I99jpLq6WogaRGbN1ttLi4WaTI8fXQtaoZ2pRi0rjoBNK2maTtAcnY4dO_KhzHLiWJ_5Tjn9OKwFBCjzrRg'

/organization/{orgCode}/tags

Parameter	Description
orgCode	Organization code

Example response

HTTP/1.1 200 OK
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: POST, GET, PUT, OPTIONS, DELETE
Access-Control-Max-Age: 3600
Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Authorization
Content-Type: application/json;charset=UTF-8
Content-Length: 52

[ {
  "Id" : 5154510511013888,
  "Name" : "TAG1"
} ]

Path	Type	Description
[]	Array	Tags list
[0].Id	String	Tag id
[0].Name	String	Tag name

Create process instance tag

A POST request will create tag

Example request

POST /organization/SD/tags HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjU5MTA5NzQ1MTA5MjM3NzYsImV4cCI6MTUyODk2MDkxMywiY2xpZW50SWQiOjUwMzEzNjUyMDg3MDI5NzYsIm9yZ0NvZGUiOiJTRCIsInJvbGVzIjpbImFkbWluaXN0cmF0b3IiXSwiZG9tYWluQXBwUm9sZXMiOlsiQU5BTFlTVCIsIlNVUFBPUlQiLCJDTElFTlQiXSwicGVybWlzc2lvbnMiOlsiUkVUUllfV09SS0ZMT1ciLCJST0xFX2FkbWluaXN0cmF0b3IiLCJFUlJPUl9NQU5BR0VNRU5UIiwiU1VCU0NSSUJFUlNfTUFOQUdFTUVOVCIsIkNSRUFURV9VU0VSIiwiRVhFQ1VURV9BQ1RJT04iLCJDTElFTlRfVVNFUlNfTUFOQUdFTUVOVCIsIkFQUFJPVkVfQ0FOQ0VMIiwiUkVRVUVTVF9DQU5DRUwiLCJVU0VSU19NQU5BR0VNRU5UIiwiTk9USUZJQ0FUSU9OU19NQU5BR0VNRU5UIiwiUEFZTUVOVFNfTUFOQUdFTUVOVCIsIkdFVF9VU0VSUyIsIlJFU09VUkNFU19NQU5BR0VNRU5UIiwiQUNDRVNTX0FETUlOX1BBR0UiLCJVU0VSX1JPTEVTX01BTkFHRU1FTlQiLCJDTElFTlRTX01BTkFHRU1FTlQiLCJIRUxQX0FSVElDTEVTX01BTkFHRU1FTlQiLCJTVEFSVF9XT1JLRkxPVyJdfQ.lx7I99jpLq6WogaRGbN1ttLi4WaTI8fXQtaoZ2pRi0rjoBNK2maTtAcnY4dO_KhzHLiWJ_5Tjn9OKwFBCjzrRg
Host: corporateservices.com
Content-Length: 16

{"Name": "TAG1"}

$ curl 'https://corporateservices.com:8080/organization/SD/tags' -i -X POST -H 'Content-Type: application/json' -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjU5MTA5NzQ1MTA5MjM3NzYsImV4cCI6MTUyODk2MDkxMywiY2xpZW50SWQiOjUwMzEzNjUyMDg3MDI5NzYsIm9yZ0NvZGUiOiJTRCIsInJvbGVzIjpbImFkbWluaXN0cmF0b3IiXSwiZG9tYWluQXBwUm9sZXMiOlsiQU5BTFlTVCIsIlNVUFBPUlQiLCJDTElFTlQiXSwicGVybWlzc2lvbnMiOlsiUkVUUllfV09SS0ZMT1ciLCJST0xFX2FkbWluaXN0cmF0b3IiLCJFUlJPUl9NQU5BR0VNRU5UIiwiU1VCU0NSSUJFUlNfTUFOQUdFTUVOVCIsIkNSRUFURV9VU0VSIiwiRVhFQ1VURV9BQ1RJT04iLCJDTElFTlRfVVNFUlNfTUFOQUdFTUVOVCIsIkFQUFJPVkVfQ0FOQ0VMIiwiUkVRVUVTVF9DQU5DRUwiLCJVU0VSU19NQU5BR0VNRU5UIiwiTk9USUZJQ0FUSU9OU19NQU5BR0VNRU5UIiwiUEFZTUVOVFNfTUFOQUdFTUVOVCIsIkdFVF9VU0VSUyIsIlJFU09VUkNFU19NQU5BR0VNRU5UIiwiQUNDRVNTX0FETUlOX1BBR0UiLCJVU0VSX1JPTEVTX01BTkFHRU1FTlQiLCJDTElFTlRTX01BTkFHRU1FTlQiLCJIRUxQX0FSVElDTEVTX01BTkFHRU1FTlQiLCJTVEFSVF9XT1JLRkxPVyJdfQ.lx7I99jpLq6WogaRGbN1ttLi4WaTI8fXQtaoZ2pRi0rjoBNK2maTtAcnY4dO_KhzHLiWJ_5Tjn9OKwFBCjzrRg' -d '{"Name": "TAG1"}'

/organization/{orgCode}/tags

Parameter	Description
orgCode	Organization code

Path	Type	Description
Name	String	Tag name

Example response

HTTP/1.1 201 Created
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: POST, GET, PUT, OPTIONS, DELETE
Access-Control-Max-Age: 3600
Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Authorization
Content-Type: application/json;charset=UTF-8
Content-Length: 48

{
  "Id" : 5154510511013888,
  "Name" : "TAG1"
}

Path	Type	Description
Id	String	Tag id
Name	String	Tag name

Update process instance tag

A PUT request will update tag

Example request

PUT /organization/SD/tags/5154510511013888 HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjU5MTA5NzQ1MTA5MjM3NzYsImV4cCI6MTUyODk2MDkxMywiY2xpZW50SWQiOjUwMzEzNjUyMDg3MDI5NzYsIm9yZ0NvZGUiOiJTRCIsInJvbGVzIjpbImFkbWluaXN0cmF0b3IiXSwiZG9tYWluQXBwUm9sZXMiOlsiQU5BTFlTVCIsIlNVUFBPUlQiLCJDTElFTlQiXSwicGVybWlzc2lvbnMiOlsiUkVUUllfV09SS0ZMT1ciLCJST0xFX2FkbWluaXN0cmF0b3IiLCJFUlJPUl9NQU5BR0VNRU5UIiwiU1VCU0NSSUJFUlNfTUFOQUdFTUVOVCIsIkNSRUFURV9VU0VSIiwiRVhFQ1VURV9BQ1RJT04iLCJDTElFTlRfVVNFUlNfTUFOQUdFTUVOVCIsIkFQUFJPVkVfQ0FOQ0VMIiwiUkVRVUVTVF9DQU5DRUwiLCJVU0VSU19NQU5BR0VNRU5UIiwiTk9USUZJQ0FUSU9OU19NQU5BR0VNRU5UIiwiUEFZTUVOVFNfTUFOQUdFTUVOVCIsIkdFVF9VU0VSUyIsIlJFU09VUkNFU19NQU5BR0VNRU5UIiwiQUNDRVNTX0FETUlOX1BBR0UiLCJVU0VSX1JPTEVTX01BTkFHRU1FTlQiLCJDTElFTlRTX01BTkFHRU1FTlQiLCJIRUxQX0FSVElDTEVTX01BTkFHRU1FTlQiLCJTVEFSVF9XT1JLRkxPVyJdfQ.lx7I99jpLq6WogaRGbN1ttLi4WaTI8fXQtaoZ2pRi0rjoBNK2maTtAcnY4dO_KhzHLiWJ_5Tjn9OKwFBCjzrRg
Host: corporateservices.com
Content-Length: 16

{"Name": "TAG1"}

$ curl 'https://corporateservices.com:8080/organization/SD/tags/5154510511013888' -i -X PUT -H 'Content-Type: application/json' -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjU5MTA5NzQ1MTA5MjM3NzYsImV4cCI6MTUyODk2MDkxMywiY2xpZW50SWQiOjUwMzEzNjUyMDg3MDI5NzYsIm9yZ0NvZGUiOiJTRCIsInJvbGVzIjpbImFkbWluaXN0cmF0b3IiXSwiZG9tYWluQXBwUm9sZXMiOlsiQU5BTFlTVCIsIlNVUFBPUlQiLCJDTElFTlQiXSwicGVybWlzc2lvbnMiOlsiUkVUUllfV09SS0ZMT1ciLCJST0xFX2FkbWluaXN0cmF0b3IiLCJFUlJPUl9NQU5BR0VNRU5UIiwiU1VCU0NSSUJFUlNfTUFOQUdFTUVOVCIsIkNSRUFURV9VU0VSIiwiRVhFQ1VURV9BQ1RJT04iLCJDTElFTlRfVVNFUlNfTUFOQUdFTUVOVCIsIkFQUFJPVkVfQ0FOQ0VMIiwiUkVRVUVTVF9DQU5DRUwiLCJVU0VSU19NQU5BR0VNRU5UIiwiTk9USUZJQ0FUSU9OU19NQU5BR0VNRU5UIiwiUEFZTUVOVFNfTUFOQUdFTUVOVCIsIkdFVF9VU0VSUyIsIlJFU09VUkNFU19NQU5BR0VNRU5UIiwiQUNDRVNTX0FETUlOX1BBR0UiLCJVU0VSX1JPTEVTX01BTkFHRU1FTlQiLCJDTElFTlRTX01BTkFHRU1FTlQiLCJIRUxQX0FSVElDTEVTX01BTkFHRU1FTlQiLCJTVEFSVF9XT1JLRkxPVyJdfQ.lx7I99jpLq6WogaRGbN1ttLi4WaTI8fXQtaoZ2pRi0rjoBNK2maTtAcnY4dO_KhzHLiWJ_5Tjn9OKwFBCjzrRg' -d '{"Name": "TAG1"}'

/organization/{orgCode}/tags/{tagId}

Parameter	Description
orgCode	Organization code
tagId	Tag id

Path	Type	Description
Name	String	Tag name

Example response

HTTP/1.1 200 OK
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: POST, GET, PUT, OPTIONS, DELETE
Access-Control-Max-Age: 3600
Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Authorization
Content-Type: application/json;charset=UTF-8
Content-Length: 48

{
  "Id" : 5154510511013888,
  "Name" : "TAG1"
}

Path	Type	Description
Id	String	Tag id
Name	String	Tag name

Delete process instance tag

A DELETE request will delete tag

Example request

DELETE /organization/SD/tags/5154510511013888 HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjU5MTA5NzQ1MTA5MjM3NzYsImV4cCI6MTUyODk2MDkxMywiY2xpZW50SWQiOjUwMzEzNjUyMDg3MDI5NzYsIm9yZ0NvZGUiOiJTRCIsInJvbGVzIjpbImFkbWluaXN0cmF0b3IiXSwiZG9tYWluQXBwUm9sZXMiOlsiQU5BTFlTVCIsIlNVUFBPUlQiLCJDTElFTlQiXSwicGVybWlzc2lvbnMiOlsiUkVUUllfV09SS0ZMT1ciLCJST0xFX2FkbWluaXN0cmF0b3IiLCJFUlJPUl9NQU5BR0VNRU5UIiwiU1VCU0NSSUJFUlNfTUFOQUdFTUVOVCIsIkNSRUFURV9VU0VSIiwiRVhFQ1VURV9BQ1RJT04iLCJDTElFTlRfVVNFUlNfTUFOQUdFTUVOVCIsIkFQUFJPVkVfQ0FOQ0VMIiwiUkVRVUVTVF9DQU5DRUwiLCJVU0VSU19NQU5BR0VNRU5UIiwiTk9USUZJQ0FUSU9OU19NQU5BR0VNRU5UIiwiUEFZTUVOVFNfTUFOQUdFTUVOVCIsIkdFVF9VU0VSUyIsIlJFU09VUkNFU19NQU5BR0VNRU5UIiwiQUNDRVNTX0FETUlOX1BBR0UiLCJVU0VSX1JPTEVTX01BTkFHRU1FTlQiLCJDTElFTlRTX01BTkFHRU1FTlQiLCJIRUxQX0FSVElDTEVTX01BTkFHRU1FTlQiLCJTVEFSVF9XT1JLRkxPVyJdfQ.lx7I99jpLq6WogaRGbN1ttLi4WaTI8fXQtaoZ2pRi0rjoBNK2maTtAcnY4dO_KhzHLiWJ_5Tjn9OKwFBCjzrRg
Host: corporateservices.com

$ curl 'https://corporateservices.com:8080/organization/SD/tags/5154510511013888' -i -X DELETE -H 'Content-Type: application/json' -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjU5MTA5NzQ1MTA5MjM3NzYsImV4cCI6MTUyODk2MDkxMywiY2xpZW50SWQiOjUwMzEzNjUyMDg3MDI5NzYsIm9yZ0NvZGUiOiJTRCIsInJvbGVzIjpbImFkbWluaXN0cmF0b3IiXSwiZG9tYWluQXBwUm9sZXMiOlsiQU5BTFlTVCIsIlNVUFBPUlQiLCJDTElFTlQiXSwicGVybWlzc2lvbnMiOlsiUkVUUllfV09SS0ZMT1ciLCJST0xFX2FkbWluaXN0cmF0b3IiLCJFUlJPUl9NQU5BR0VNRU5UIiwiU1VCU0NSSUJFUlNfTUFOQUdFTUVOVCIsIkNSRUFURV9VU0VSIiwiRVhFQ1VURV9BQ1RJT04iLCJDTElFTlRfVVNFUlNfTUFOQUdFTUVOVCIsIkFQUFJPVkVfQ0FOQ0VMIiwiUkVRVUVTVF9DQU5DRUwiLCJVU0VSU19NQU5BR0VNRU5UIiwiTk9USUZJQ0FUSU9OU19NQU5BR0VNRU5UIiwiUEFZTUVOVFNfTUFOQUdFTUVOVCIsIkdFVF9VU0VSUyIsIlJFU09VUkNFU19NQU5BR0VNRU5UIiwiQUNDRVNTX0FETUlOX1BBR0UiLCJVU0VSX1JPTEVTX01BTkFHRU1FTlQiLCJDTElFTlRTX01BTkFHRU1FTlQiLCJIRUxQX0FSVElDTEVTX01BTkFHRU1FTlQiLCJTVEFSVF9XT1JLRkxPVyJdfQ.lx7I99jpLq6WogaRGbN1ttLi4WaTI8fXQtaoZ2pRi0rjoBNK2maTtAcnY4dO_KhzHLiWJ_5Tjn9OKwFBCjzrRg'

/organization/{orgCode}/tags/{tagId}

Parameter	Description
orgCode	Organization code
tagId	Tag id

Example response

HTTP/1.1 204 No Content
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: POST, GET, PUT, OPTIONS, DELETE
Access-Control-Max-Age: 3600
Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Authorization

List tags for process instance

A GET request will return all tags assigned to process instance

Example request

GET /organization/SD/process-instances/ahRzfmF2b2NhZG8tYmFja2VuZC12MXIcCxIPUHJvY2Vzc0luc3RhbmNlGICAgICAgOQJDA/tags HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjU5MTA5NzQ1MTA5MjM3NzYsImV4cCI6MTUyODk2MDkxMywiY2xpZW50SWQiOjUwMzEzNjUyMDg3MDI5NzYsIm9yZ0NvZGUiOiJTRCIsInJvbGVzIjpbImFkbWluaXN0cmF0b3IiXSwiZG9tYWluQXBwUm9sZXMiOlsiQU5BTFlTVCIsIlNVUFBPUlQiLCJDTElFTlQiXSwicGVybWlzc2lvbnMiOlsiUkVUUllfV09SS0ZMT1ciLCJST0xFX2FkbWluaXN0cmF0b3IiLCJFUlJPUl9NQU5BR0VNRU5UIiwiU1VCU0NSSUJFUlNfTUFOQUdFTUVOVCIsIkNSRUFURV9VU0VSIiwiRVhFQ1VURV9BQ1RJT04iLCJDTElFTlRfVVNFUlNfTUFOQUdFTUVOVCIsIkFQUFJPVkVfQ0FOQ0VMIiwiUkVRVUVTVF9DQU5DRUwiLCJVU0VSU19NQU5BR0VNRU5UIiwiTk9USUZJQ0FUSU9OU19NQU5BR0VNRU5UIiwiUEFZTUVOVFNfTUFOQUdFTUVOVCIsIkdFVF9VU0VSUyIsIlJFU09VUkNFU19NQU5BR0VNRU5UIiwiQUNDRVNTX0FETUlOX1BBR0UiLCJVU0VSX1JPTEVTX01BTkFHRU1FTlQiLCJDTElFTlRTX01BTkFHRU1FTlQiLCJIRUxQX0FSVElDTEVTX01BTkFHRU1FTlQiLCJTVEFSVF9XT1JLRkxPVyJdfQ.lx7I99jpLq6WogaRGbN1ttLi4WaTI8fXQtaoZ2pRi0rjoBNK2maTtAcnY4dO_KhzHLiWJ_5Tjn9OKwFBCjzrRg
Host: corporateservices.com

$ curl 'https://corporateservices.com:8080/organization/SD/process-instances/ahRzfmF2b2NhZG8tYmFja2VuZC12MXIcCxIPUHJvY2Vzc0luc3RhbmNlGICAgICAgOQJDA/tags' -i -H 'Content-Type: application/json' -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjU5MTA5NzQ1MTA5MjM3NzYsImV4cCI6MTUyODk2MDkxMywiY2xpZW50SWQiOjUwMzEzNjUyMDg3MDI5NzYsIm9yZ0NvZGUiOiJTRCIsInJvbGVzIjpbImFkbWluaXN0cmF0b3IiXSwiZG9tYWluQXBwUm9sZXMiOlsiQU5BTFlTVCIsIlNVUFBPUlQiLCJDTElFTlQiXSwicGVybWlzc2lvbnMiOlsiUkVUUllfV09SS0ZMT1ciLCJST0xFX2FkbWluaXN0cmF0b3IiLCJFUlJPUl9NQU5BR0VNRU5UIiwiU1VCU0NSSUJFUlNfTUFOQUdFTUVOVCIsIkNSRUFURV9VU0VSIiwiRVhFQ1VURV9BQ1RJT04iLCJDTElFTlRfVVNFUlNfTUFOQUdFTUVOVCIsIkFQUFJPVkVfQ0FOQ0VMIiwiUkVRVUVTVF9DQU5DRUwiLCJVU0VSU19NQU5BR0VNRU5UIiwiTk9USUZJQ0FUSU9OU19NQU5BR0VNRU5UIiwiUEFZTUVOVFNfTUFOQUdFTUVOVCIsIkdFVF9VU0VSUyIsIlJFU09VUkNFU19NQU5BR0VNRU5UIiwiQUNDRVNTX0FETUlOX1BBR0UiLCJVU0VSX1JPTEVTX01BTkFHRU1FTlQiLCJDTElFTlRTX01BTkFHRU1FTlQiLCJIRUxQX0FSVElDTEVTX01BTkFHRU1FTlQiLCJTVEFSVF9XT1JLRkxPVyJdfQ.lx7I99jpLq6WogaRGbN1ttLi4WaTI8fXQtaoZ2pRi0rjoBNK2maTtAcnY4dO_KhzHLiWJ_5Tjn9OKwFBCjzrRg'

/organization/{orgCode}/process-instances/{processInstanceKey}/tags

Parameter	Description
orgCode	Organization code
processInstanceKey	Process instance key that should be tagged.

Example response

HTTP/1.1 200 OK
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: POST, GET, PUT, OPTIONS, DELETE
Access-Control-Max-Age: 3600
Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Authorization
Content-Type: application/json;charset=UTF-8
Content-Length: 52

[ {
  "Id" : 5154510511013888,
  "Name" : "TAG1"
} ]

Assign tags to process instance

A POST request will return all tags assigned to process instance

Example request

POST /organization/SD/process-instances/ahRzfmF2b2NhZG8tYmFja2VuZC12MXIcCxIPUHJvY2Vzc0luc3RhbmNlGICAgICAgOQJDA/tags HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjU5MTA5NzQ1MTA5MjM3NzYsImV4cCI6MTUyODk2MDkxMywiY2xpZW50SWQiOjUwMzEzNjUyMDg3MDI5NzYsIm9yZ0NvZGUiOiJTRCIsInJvbGVzIjpbImFkbWluaXN0cmF0b3IiXSwiZG9tYWluQXBwUm9sZXMiOlsiQU5BTFlTVCIsIlNVUFBPUlQiLCJDTElFTlQiXSwicGVybWlzc2lvbnMiOlsiUkVUUllfV09SS0ZMT1ciLCJST0xFX2FkbWluaXN0cmF0b3IiLCJFUlJPUl9NQU5BR0VNRU5UIiwiU1VCU0NSSUJFUlNfTUFOQUdFTUVOVCIsIkNSRUFURV9VU0VSIiwiRVhFQ1VURV9BQ1RJT04iLCJDTElFTlRfVVNFUlNfTUFOQUdFTUVOVCIsIkFQUFJPVkVfQ0FOQ0VMIiwiUkVRVUVTVF9DQU5DRUwiLCJVU0VSU19NQU5BR0VNRU5UIiwiTk9USUZJQ0FUSU9OU19NQU5BR0VNRU5UIiwiUEFZTUVOVFNfTUFOQUdFTUVOVCIsIkdFVF9VU0VSUyIsIlJFU09VUkNFU19NQU5BR0VNRU5UIiwiQUNDRVNTX0FETUlOX1BBR0UiLCJVU0VSX1JPTEVTX01BTkFHRU1FTlQiLCJDTElFTlRTX01BTkFHRU1FTlQiLCJIRUxQX0FSVElDTEVTX01BTkFHRU1FTlQiLCJTVEFSVF9XT1JLRkxPVyJdfQ.lx7I99jpLq6WogaRGbN1ttLi4WaTI8fXQtaoZ2pRi0rjoBNK2maTtAcnY4dO_KhzHLiWJ_5Tjn9OKwFBCjzrRg
Host: corporateservices.com
Content-Length: 26

[{"Id": 5154510511013888}]

$ curl 'https://corporateservices.com:8080/organization/SD/process-instances/ahRzfmF2b2NhZG8tYmFja2VuZC12MXIcCxIPUHJvY2Vzc0luc3RhbmNlGICAgICAgOQJDA/tags' -i -X POST -H 'Content-Type: application/json' -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjU5MTA5NzQ1MTA5MjM3NzYsImV4cCI6MTUyODk2MDkxMywiY2xpZW50SWQiOjUwMzEzNjUyMDg3MDI5NzYsIm9yZ0NvZGUiOiJTRCIsInJvbGVzIjpbImFkbWluaXN0cmF0b3IiXSwiZG9tYWluQXBwUm9sZXMiOlsiQU5BTFlTVCIsIlNVUFBPUlQiLCJDTElFTlQiXSwicGVybWlzc2lvbnMiOlsiUkVUUllfV09SS0ZMT1ciLCJST0xFX2FkbWluaXN0cmF0b3IiLCJFUlJPUl9NQU5BR0VNRU5UIiwiU1VCU0NSSUJFUlNfTUFOQUdFTUVOVCIsIkNSRUFURV9VU0VSIiwiRVhFQ1VURV9BQ1RJT04iLCJDTElFTlRfVVNFUlNfTUFOQUdFTUVOVCIsIkFQUFJPVkVfQ0FOQ0VMIiwiUkVRVUVTVF9DQU5DRUwiLCJVU0VSU19NQU5BR0VNRU5UIiwiTk9USUZJQ0FUSU9OU19NQU5BR0VNRU5UIiwiUEFZTUVOVFNfTUFOQUdFTUVOVCIsIkdFVF9VU0VSUyIsIlJFU09VUkNFU19NQU5BR0VNRU5UIiwiQUNDRVNTX0FETUlOX1BBR0UiLCJVU0VSX1JPTEVTX01BTkFHRU1FTlQiLCJDTElFTlRTX01BTkFHRU1FTlQiLCJIRUxQX0FSVElDTEVTX01BTkFHRU1FTlQiLCJTVEFSVF9XT1JLRkxPVyJdfQ.lx7I99jpLq6WogaRGbN1ttLi4WaTI8fXQtaoZ2pRi0rjoBNK2maTtAcnY4dO_KhzHLiWJ_5Tjn9OKwFBCjzrRg' -d '[{"Id": 5154510511013888}]'

/organization/{orgCode}/process-instances/{processInstanceKey}/tags

Parameter	Description
orgCode	Organization code
processInstanceKey	Process instance key that should be tagged.

Path	Type	Description
[]	Array	TList of tags
[].Id	String	Tag id

Example response

HTTP/1.1 200 OK
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: POST, GET, PUT, OPTIONS, DELETE
Access-Control-Max-Age: 3600
Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Authorization
Content-Type: application/json;charset=UTF-8
Content-Length: 33

[ {
  "Id" : 5154510511013888
} ]

Process instance notes

Get note for process instance

A GET request will return note for specified process instance(started workflow) for current user

Example request

GET /organization/SD/process-instances/ahRzfmF2b2NhZG8tYmFja2VuZC12MXIcCxIPUHJvY2Vzc0luc3RhbmNlGICAgICAgOQJDA/notes HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjU5MTA5NzQ1MTA5MjM3NzYsImV4cCI6MTUyODk2MDk1OSwiY2xpZW50SWQiOjUwMzEzNjUyMDg3MDI5NzYsIm9yZ0NvZGUiOiJTRCIsInJvbGVzIjpbImFkbWluaXN0cmF0b3IiXSwiZG9tYWluQXBwUm9sZXMiOlsiQU5BTFlTVCIsIlNVUFBPUlQiLCJDTElFTlQiXSwicGVybWlzc2lvbnMiOlsiUkVUUllfV09SS0ZMT1ciLCJST0xFX2FkbWluaXN0cmF0b3IiLCJFUlJPUl9NQU5BR0VNRU5UIiwiU1VCU0NSSUJFUlNfTUFOQUdFTUVOVCIsIkNSRUFURV9VU0VSIiwiRVhFQ1VURV9BQ1RJT04iLCJDTElFTlRfVVNFUlNfTUFOQUdFTUVOVCIsIkFQUFJPVkVfQ0FOQ0VMIiwiUkVRVUVTVF9DQU5DRUwiLCJVU0VSU19NQU5BR0VNRU5UIiwiTk9USUZJQ0FUSU9OU19NQU5BR0VNRU5UIiwiUEFZTUVOVFNfTUFOQUdFTUVOVCIsIkdFVF9VU0VSUyIsIlJFU09VUkNFU19NQU5BR0VNRU5UIiwiQUNDRVNTX0FETUlOX1BBR0UiLCJVU0VSX1JPTEVTX01BTkFHRU1FTlQiLCJDTElFTlRTX01BTkFHRU1FTlQiLCJIRUxQX0FSVElDTEVTX01BTkFHRU1FTlQiLCJTVEFSVF9XT1JLRkxPVyJdfQ.Ap8xQS1o_mXfJ7IdOTQeh8_BUaYUc3yxwJWIMEwkY4FOEERT3AoYaGkXTwy_KVN8le7a_K3DdKdR7ABii2ZlBg
Host: corporateservices.com

$ curl 'https://corporateservices.com:8080/organization/SD/process-instances/ahRzfmF2b2NhZG8tYmFja2VuZC12MXIcCxIPUHJvY2Vzc0luc3RhbmNlGICAgICAgOQJDA/notes' -i -H 'Content-Type: application/json' -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjU5MTA5NzQ1MTA5MjM3NzYsImV4cCI6MTUyODk2MDk1OSwiY2xpZW50SWQiOjUwMzEzNjUyMDg3MDI5NzYsIm9yZ0NvZGUiOiJTRCIsInJvbGVzIjpbImFkbWluaXN0cmF0b3IiXSwiZG9tYWluQXBwUm9sZXMiOlsiQU5BTFlTVCIsIlNVUFBPUlQiLCJDTElFTlQiXSwicGVybWlzc2lvbnMiOlsiUkVUUllfV09SS0ZMT1ciLCJST0xFX2FkbWluaXN0cmF0b3IiLCJFUlJPUl9NQU5BR0VNRU5UIiwiU1VCU0NSSUJFUlNfTUFOQUdFTUVOVCIsIkNSRUFURV9VU0VSIiwiRVhFQ1VURV9BQ1RJT04iLCJDTElFTlRfVVNFUlNfTUFOQUdFTUVOVCIsIkFQUFJPVkVfQ0FOQ0VMIiwiUkVRVUVTVF9DQU5DRUwiLCJVU0VSU19NQU5BR0VNRU5UIiwiTk9USUZJQ0FUSU9OU19NQU5BR0VNRU5UIiwiUEFZTUVOVFNfTUFOQUdFTUVOVCIsIkdFVF9VU0VSUyIsIlJFU09VUkNFU19NQU5BR0VNRU5UIiwiQUNDRVNTX0FETUlOX1BBR0UiLCJVU0VSX1JPTEVTX01BTkFHRU1FTlQiLCJDTElFTlRTX01BTkFHRU1FTlQiLCJIRUxQX0FSVElDTEVTX01BTkFHRU1FTlQiLCJTVEFSVF9XT1JLRkxPVyJdfQ.Ap8xQS1o_mXfJ7IdOTQeh8_BUaYUc3yxwJWIMEwkY4FOEERT3AoYaGkXTwy_KVN8le7a_K3DdKdR7ABii2ZlBg'

/organization/{orgCode}/process-instances/{key}/notes

Parameter	Description
orgCode	Organization code
key	Process instance id

Example response

HTTP/1.1 200 OK
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: POST, GET, PUT, OPTIONS, DELETE
Access-Control-Max-Age: 3600
Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Authorization
Content-Type: application/json;charset=UTF-8
Content-Length: 112

{
  "CreatedOn" : "2018-05-15T10:22:39.505+03:00",
  "Id" : 5154510511013888,
  "Text" : "Some important note"
}

Path	Type	Description
Id	Number	Note id
Text	String	Note text
CreatedOn	String	Date time when note was created
UpdatedOn	String	Date time when note was updated

Create process instance note

A POST request will create and add note to process instance

Example request

POST /organization/SD/process-instances/ahRzfmF2b2NhZG8tYmFja2VuZC12MXIcCxIPUHJvY2Vzc0luc3RhbmNlGICAgICAgOQJDA/notes HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjU5MTA5NzQ1MTA5MjM3NzYsImV4cCI6MTUyODk2MDk2MSwiY2xpZW50SWQiOjUwMzEzNjUyMDg3MDI5NzYsIm9yZ0NvZGUiOiJTRCIsInJvbGVzIjpbImFkbWluaXN0cmF0b3IiXSwiZG9tYWluQXBwUm9sZXMiOlsiQU5BTFlTVCIsIlNVUFBPUlQiLCJDTElFTlQiXSwicGVybWlzc2lvbnMiOlsiUkVUUllfV09SS0ZMT1ciLCJST0xFX2FkbWluaXN0cmF0b3IiLCJFUlJPUl9NQU5BR0VNRU5UIiwiU1VCU0NSSUJFUlNfTUFOQUdFTUVOVCIsIkNSRUFURV9VU0VSIiwiRVhFQ1VURV9BQ1RJT04iLCJDTElFTlRfVVNFUlNfTUFOQUdFTUVOVCIsIkFQUFJPVkVfQ0FOQ0VMIiwiUkVRVUVTVF9DQU5DRUwiLCJVU0VSU19NQU5BR0VNRU5UIiwiTk9USUZJQ0FUSU9OU19NQU5BR0VNRU5UIiwiUEFZTUVOVFNfTUFOQUdFTUVOVCIsIkdFVF9VU0VSUyIsIlJFU09VUkNFU19NQU5BR0VNRU5UIiwiQUNDRVNTX0FETUlOX1BBR0UiLCJVU0VSX1JPTEVTX01BTkFHRU1FTlQiLCJDTElFTlRTX01BTkFHRU1FTlQiLCJIRUxQX0FSVElDTEVTX01BTkFHRU1FTlQiLCJTVEFSVF9XT1JLRkxPVyJdfQ.6SA9wqSHk79WSZ3S16IQ-iyEZrpQ0ttsizhjDFlzCP9a2x6ZzhyoRe9W3szLGFDQBRmezO9GK9_JjkHZfVbbmQ
Host: corporateservices.com
Content-Length: 19

Some important note

$ curl 'https://corporateservices.com:8080/organization/SD/process-instances/ahRzfmF2b2NhZG8tYmFja2VuZC12MXIcCxIPUHJvY2Vzc0luc3RhbmNlGICAgICAgOQJDA/notes' -i -X POST -H 'Content-Type: application/json' -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjU5MTA5NzQ1MTA5MjM3NzYsImV4cCI6MTUyODk2MDk2MSwiY2xpZW50SWQiOjUwMzEzNjUyMDg3MDI5NzYsIm9yZ0NvZGUiOiJTRCIsInJvbGVzIjpbImFkbWluaXN0cmF0b3IiXSwiZG9tYWluQXBwUm9sZXMiOlsiQU5BTFlTVCIsIlNVUFBPUlQiLCJDTElFTlQiXSwicGVybWlzc2lvbnMiOlsiUkVUUllfV09SS0ZMT1ciLCJST0xFX2FkbWluaXN0cmF0b3IiLCJFUlJPUl9NQU5BR0VNRU5UIiwiU1VCU0NSSUJFUlNfTUFOQUdFTUVOVCIsIkNSRUFURV9VU0VSIiwiRVhFQ1VURV9BQ1RJT04iLCJDTElFTlRfVVNFUlNfTUFOQUdFTUVOVCIsIkFQUFJPVkVfQ0FOQ0VMIiwiUkVRVUVTVF9DQU5DRUwiLCJVU0VSU19NQU5BR0VNRU5UIiwiTk9USUZJQ0FUSU9OU19NQU5BR0VNRU5UIiwiUEFZTUVOVFNfTUFOQUdFTUVOVCIsIkdFVF9VU0VSUyIsIlJFU09VUkNFU19NQU5BR0VNRU5UIiwiQUNDRVNTX0FETUlOX1BBR0UiLCJVU0VSX1JPTEVTX01BTkFHRU1FTlQiLCJDTElFTlRTX01BTkFHRU1FTlQiLCJIRUxQX0FSVElDTEVTX01BTkFHRU1FTlQiLCJTVEFSVF9XT1JLRkxPVyJdfQ.6SA9wqSHk79WSZ3S16IQ-iyEZrpQ0ttsizhjDFlzCP9a2x6ZzhyoRe9W3szLGFDQBRmezO9GK9_JjkHZfVbbmQ' -d 'Some important note'

/organization/{orgCode}/process-instances/{key}/notes

Parameter	Description
orgCode	Organization code
key	Process instance key

====== Request body Text of note

Example response

HTTP/1.1 200 OK
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: POST, GET, PUT, OPTIONS, DELETE
Access-Control-Max-Age: 3600
Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Authorization
Content-Type: application/json;charset=UTF-8
Content-Length: 112

{
  "CreatedOn" : "2018-05-15T10:22:41.033+03:00",
  "Id" : 5154510511013888,
  "Text" : "Some important note"
}

Process instance history

Get process instance history

A GET request will return all comleted user activities for process instance

Example request

GET /dashboard/process-instance/ahRzfmF2b2NhZG8tYmFja2VuZC12MXIcCxIPUHJvY2Vzc0luc3RhbmNlGICAgICAgOQJDA/history HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjU5MTA5NzQ1MTA5MjM3NzYsImV4cCI6MTUyODk2MDk0NSwiY2xpZW50SWQiOjUwMzEzNjUyMDg3MDI5NzYsIm9yZ0NvZGUiOiJTRCIsInJvbGVzIjpbImFkbWluaXN0cmF0b3IiXSwiZG9tYWluQXBwUm9sZXMiOlsiQU5BTFlTVCIsIlNVUFBPUlQiLCJDTElFTlQiXSwicGVybWlzc2lvbnMiOlsiUkVUUllfV09SS0ZMT1ciLCJST0xFX2FkbWluaXN0cmF0b3IiLCJFUlJPUl9NQU5BR0VNRU5UIiwiU1VCU0NSSUJFUlNfTUFOQUdFTUVOVCIsIkNSRUFURV9VU0VSIiwiRVhFQ1VURV9BQ1RJT04iLCJDTElFTlRfVVNFUlNfTUFOQUdFTUVOVCIsIkFQUFJPVkVfQ0FOQ0VMIiwiUkVRVUVTVF9DQU5DRUwiLCJVU0VSU19NQU5BR0VNRU5UIiwiTk9USUZJQ0FUSU9OU19NQU5BR0VNRU5UIiwiUEFZTUVOVFNfTUFOQUdFTUVOVCIsIkdFVF9VU0VSUyIsIlJFU09VUkNFU19NQU5BR0VNRU5UIiwiQUNDRVNTX0FETUlOX1BBR0UiLCJVU0VSX1JPTEVTX01BTkFHRU1FTlQiLCJDTElFTlRTX01BTkFHRU1FTlQiLCJIRUxQX0FSVElDTEVTX01BTkFHRU1FTlQiLCJTVEFSVF9XT1JLRkxPVyJdfQ.9KLTHA9MHJaREiLsedobsRfY-Vtw35w7OhhbE3TgQ5d5e-meCwS5lwOeWK7PTztk7OkDqjs_o6sbq9nwsOPDiA
Host: corporateservices.com

$ curl 'https://corporateservices.com:8080/dashboard/process-instance/ahRzfmF2b2NhZG8tYmFja2VuZC12MXIcCxIPUHJvY2Vzc0luc3RhbmNlGICAgICAgOQJDA/history' -i -H 'Content-Type: application/json' -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjU5MTA5NzQ1MTA5MjM3NzYsImV4cCI6MTUyODk2MDk0NSwiY2xpZW50SWQiOjUwMzEzNjUyMDg3MDI5NzYsIm9yZ0NvZGUiOiJTRCIsInJvbGVzIjpbImFkbWluaXN0cmF0b3IiXSwiZG9tYWluQXBwUm9sZXMiOlsiQU5BTFlTVCIsIlNVUFBPUlQiLCJDTElFTlQiXSwicGVybWlzc2lvbnMiOlsiUkVUUllfV09SS0ZMT1ciLCJST0xFX2FkbWluaXN0cmF0b3IiLCJFUlJPUl9NQU5BR0VNRU5UIiwiU1VCU0NSSUJFUlNfTUFOQUdFTUVOVCIsIkNSRUFURV9VU0VSIiwiRVhFQ1VURV9BQ1RJT04iLCJDTElFTlRfVVNFUlNfTUFOQUdFTUVOVCIsIkFQUFJPVkVfQ0FOQ0VMIiwiUkVRVUVTVF9DQU5DRUwiLCJVU0VSU19NQU5BR0VNRU5UIiwiTk9USUZJQ0FUSU9OU19NQU5BR0VNRU5UIiwiUEFZTUVOVFNfTUFOQUdFTUVOVCIsIkdFVF9VU0VSUyIsIlJFU09VUkNFU19NQU5BR0VNRU5UIiwiQUNDRVNTX0FETUlOX1BBR0UiLCJVU0VSX1JPTEVTX01BTkFHRU1FTlQiLCJDTElFTlRTX01BTkFHRU1FTlQiLCJIRUxQX0FSVElDTEVTX01BTkFHRU1FTlQiLCJTVEFSVF9XT1JLRkxPVyJdfQ.9KLTHA9MHJaREiLsedobsRfY-Vtw35w7OhhbE3TgQ5d5e-meCwS5lwOeWK7PTztk7OkDqjs_o6sbq9nwsOPDiA'

/dashboard/process-instance/{processInstanceKey}/history

Parameter	Description
processInstanceKey	Process instance key

Example response

HTTP/1.1 200 OK
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: POST, GET, PUT, OPTIONS, DELETE
Access-Control-Max-Age: 3600
Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Authorization
Content-Type: application/json;charset=UTF-8
Content-Length: 1407

{
  "RequestId" : "5afa8ab00000abe0c097638f",
  "ResponseTimestamp" : "2018-05-15T10:22:25.716+03:00",
  "Data" : {
    "StartedBy" : "Adam Analyst",
    "StartedOn" : "2018-05-15T10:22:25.535+03:00",
    "Records" : [ {
      "Name" : "Initial Application",
      "CompletedOn" : "2018-05-15T10:22:25.635+03:00",
      "CompletedBy" : "Adam Analyst",
      "ActivityInstanceKey" : "ahRzfmF2b2NhZG8tYmFja2VuZC12MXI5CxIPUHJvY2Vzc0luc3RhbmNlGICAgICAgOQJDAsSEEFjdGl2aXR5SW5zdGFuY2UYgICAgICA1AgM",
      "WorkflowFormKey" : "ahRzfmF2b2NhZG8tYmFja2VuZC12MXJ-CxIMT3JnYW5pemF0aW9uIgNTR1AMCxIIV29ya2Zsb3ciLU5FVy1DT01QQU5ZLUlOQ09SUE9SQVRJT04tU0hPUlQtVkVSMi1XT1JLRkxPVwwLEg9Xb3JrZmxvd1ZlcnNpb24YAQwLEgxXb3JrZmxvd0Zvcm0YgICAgICAkAsM",
      "ActivityCode" : "NEW-COMPANY-INCORPORATION-WORKFLOW-SHORT-KYC-REVIEW"
    }, {
      "Name" : "Collecting documents",
      "CompletedOn" : "2018-05-15T10:22:25.605+03:00",
      "CompletedBy" : "Adam Analyst",
      "ActivityInstanceKey" : "ahRzfmF2b2NhZG8tYmFja2VuZC12MXI5CxIPUHJvY2Vzc0luc3RhbmNlGICAgICAgOQJDAsSEEFjdGl2aXR5SW5zdGFuY2UYgICAgICAlAkM",
      "WorkflowFormKey" : "ahRzfmF2b2NhZG8tYmFja2VuZC12MXJ-CxIMT3JnYW5pemF0aW9uIgNTR1AMCxIIV29ya2Zsb3ciLU5FVy1DT01QQU5ZLUlOQ09SUE9SQVRJT04tU0hPUlQtVkVSMi1XT1JLRkxPVwwLEg9Xb3JrZmxvd1ZlcnNpb24YAQwLEgxXb3JrZmxvd0Zvcm0YgICAgICAkAsM",
      "ActivityCode" : "NEW-COMPANY-INCORPORATION-WORKFLOW-SHORT-INTAKE-REVIEW"
    } ]
  }
}

Path	Type	Description
RequestId	String	Request Id
ResponseTimestamp	String	Date and time
Data	Object	Actual response data
Data.StartedBy	Object	User that started workflow
Data.StartedOn	Object	Date of starting workflow
Data.Records	Array	History records of workflow
Data.Records[0].Name	String	Step name
Data.Records[0].CompletedOn	String	Date and time of completing
Data.Records[0].CompletedBy	String	User that completed step
Data.Records[0].ActivityInstanceKey	String	Key of activity instance(step)
Data.Records[0].WorkflowFormKey	String	Key of workflow form

Activity instances

Set assignee

A PUT set current assignee for activity instance

Example request

PUT /organization/SD/activityInstance/ahRzfmF2b2NhZG8tYmFja2VuZC12MXI5CxIPUHJvY2Vzc0luc3RhbmNlGICAgICAgOQLDAsSEEFjdGl2aXR5SW5zdGFuY2UYgICAgICAlAoM/assignee HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjUyMjQ4NzkyNTUxOTE1NTIsImV4cCI6MTUyODk2MDk2Niwib3JnQ29kZSI6IlNEIiwicm9sZXMiOltdLCJkb21haW5BcHBSb2xlcyI6W10sInBlcm1pc3Npb25zIjpbXX0.uw5UcL2QmU_5GUAlODXQJK32_OePto7SLmh8ifbaNSigfwAXLG0S01y21f5lWlbuOa9ELwQ4DXQ6imPnZAiYUQ
Host: corporateservices.com
Content-Length: 221

{
  "Assignee" : {
    "Id" : 5910974510923776,
    "Role" : "SUPPORT"
  },
  "Comment" : {
    "CommentText" : "Test comment",
    "ShowToClient" : false
  },
  "ReturnToSender" : false,
  "ParticipantType" : "SUPPORT"
}

$ curl 'https://corporateservices.com:8080/organization/SD/activityInstance/ahRzfmF2b2NhZG8tYmFja2VuZC12MXI5CxIPUHJvY2Vzc0luc3RhbmNlGICAgICAgOQLDAsSEEFjdGl2aXR5SW5zdGFuY2UYgICAgICAlAoM/assignee' -i -X PUT -H 'Content-Type: application/json' -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjUyMjQ4NzkyNTUxOTE1NTIsImV4cCI6MTUyODk2MDk2Niwib3JnQ29kZSI6IlNEIiwicm9sZXMiOltdLCJkb21haW5BcHBSb2xlcyI6W10sInBlcm1pc3Npb25zIjpbXX0.uw5UcL2QmU_5GUAlODXQJK32_OePto7SLmh8ifbaNSigfwAXLG0S01y21f5lWlbuOa9ELwQ4DXQ6imPnZAiYUQ' -d '{
  "Assignee" : {
    "Id" : 5910974510923776,
    "Role" : "SUPPORT"
  },
  "Comment" : {
    "CommentText" : "Test comment",
    "ShowToClient" : false
  },
  "ReturnToSender" : false,
  "ParticipantType" : "SUPPORT"
}'

/organization/{orgCode}/activityInstance/{key}/assignee

Parameter	Description
orgCode	Organization code
key	ActivityInstance key(web safe string)

Path	Type	Description
Assignee	Object	Assignee resource
Assignee.Role	String	Assignee role
Assignee.Id	Number	Assignee user id
Comment	Object	Comment resource
Comment.CommentText	String	Text of the comment resource
ReturnToSender	Boolean	If activity instance should be assigned to current user after editing
ParticipantType	String	Type of participant to assign to. Can be one of next values: [Lcom.avocado.workflow.domain.enums.ParticipantType;@40c41851

Example response

HTTP/1.1 200 OK
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: POST, GET, PUT, OPTIONS, DELETE
Access-Control-Max-Age: 3600
Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Authorization
Content-Type: application/json;charset=UTF-8
Content-Length: 255

{
  "Assignee" : {
    "Id" : 5910974510923776,
    "Role" : "SUPPORT"
  },
  "Comment" : {
    "CommentText" : "Test comment",
    "ShowToClient" : false
  },
  "CommentId" : 4873035534303232,
  "ReturnToSender" : false,
  "ParticipantType" : "SUPPORT"
}

Path	Type	Description
Assignee	Object	Assignee resource
Assignee.Role	String	Assignee role
Assignee.Id	Number	Assignee user id
Comment	Object	Comment resource
Comment.CommentText	String	Text of comment
CommentId	Number	Comment id
ReturnToSender	Boolean	If activity instance should be assigned to current user after editing
ParticipantType	String	Type of participant to assign to. Can be one of next values: [Lcom.avocado.workflow.domain.enums.ParticipantType;@4561e688

Return activity instance to sender

A PUT request will return previously assigned activity instance to assigner

Example request

PUT /organization/SD/activityInstance/ahRzfmF2b2NhZG8tYmFja2VuZC12MXI5CxIPUHJvY2Vzc0luc3RhbmNlGICAgICAgOQLDAsSEEFjdGl2aXR5SW5zdGFuY2UYgICAgICAlAoM/return-to-sender HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjUyMjQ4NzkyNTUxOTE1NTIsImV4cCI6MTUyODk2MDk2Niwib3JnQ29kZSI6IlNEIiwicm9sZXMiOltdLCJkb21haW5BcHBSb2xlcyI6W10sInBlcm1pc3Npb25zIjpbXX0.uw5UcL2QmU_5GUAlODXQJK32_OePto7SLmh8ifbaNSigfwAXLG0S01y21f5lWlbuOa9ELwQ4DXQ6imPnZAiYUQ
Host: corporateservices.com

$ curl 'https://corporateservices.com:8080/organization/SD/activityInstance/ahRzfmF2b2NhZG8tYmFja2VuZC12MXI5CxIPUHJvY2Vzc0luc3RhbmNlGICAgICAgOQLDAsSEEFjdGl2aXR5SW5zdGFuY2UYgICAgICAlAoM/return-to-sender' -i -X PUT -H 'Content-Type: application/json' -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjUyMjQ4NzkyNTUxOTE1NTIsImV4cCI6MTUyODk2MDk2Niwib3JnQ29kZSI6IlNEIiwicm9sZXMiOltdLCJkb21haW5BcHBSb2xlcyI6W10sInBlcm1pc3Npb25zIjpbXX0.uw5UcL2QmU_5GUAlODXQJK32_OePto7SLmh8ifbaNSigfwAXLG0S01y21f5lWlbuOa9ELwQ4DXQ6imPnZAiYUQ'

/organization/{orgCode}/activityInstance/{key}/return-to-sender

Parameter	Description
orgCode	Organization code
key	ActivityInstance key(web safe string)

Example response

HTTP/1.1 200 OK
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: POST, GET, PUT, OPTIONS, DELETE
Access-Control-Max-Age: 3600
Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Authorization

Get activity instance

A GET request will return workflow step info

Example request

GET /organization/SD/activityInstance/ahRzfmF2b2NhZG8tYmFja2VuZC12MXI5CxIPUHJvY2Vzc0luc3RhbmNlGICAgICAgOQLDAsSEEFjdGl2aXR5SW5zdGFuY2UYgICAgICAlAoM HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjUyMjQ4NzkyNTUxOTE1NTIsImV4cCI6MTUyODk2MDk2Niwib3JnQ29kZSI6IlNEIiwicm9sZXMiOltdLCJkb21haW5BcHBSb2xlcyI6W10sInBlcm1pc3Npb25zIjpbXX0.uw5UcL2QmU_5GUAlODXQJK32_OePto7SLmh8ifbaNSigfwAXLG0S01y21f5lWlbuOa9ELwQ4DXQ6imPnZAiYUQ
Host: corporateservices.com

$ curl 'https://corporateservices.com:8080/organization/SD/activityInstance/ahRzfmF2b2NhZG8tYmFja2VuZC12MXI5CxIPUHJvY2Vzc0luc3RhbmNlGICAgICAgOQLDAsSEEFjdGl2aXR5SW5zdGFuY2UYgICAgICAlAoM' -i -H 'Content-Type: application/json' -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjUyMjQ4NzkyNTUxOTE1NTIsImV4cCI6MTUyODk2MDk2Niwib3JnQ29kZSI6IlNEIiwicm9sZXMiOltdLCJkb21haW5BcHBSb2xlcyI6W10sInBlcm1pc3Npb25zIjpbXX0.uw5UcL2QmU_5GUAlODXQJK32_OePto7SLmh8ifbaNSigfwAXLG0S01y21f5lWlbuOa9ELwQ4DXQ6imPnZAiYUQ'

/organization/{orgCode}/activityInstance/{key}

Parameter	Description
orgCode	Organization code
key	ActivityInstance key(web safe string)

Example response

HTTP/1.1 200 OK
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: POST, GET, PUT, OPTIONS, DELETE
Access-Control-Max-Age: 3600
Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Authorization
Content-Type: application/json;charset=UTF-8
Content-Length: 5805

{
  "ActivityInstance" : {
    "Key" : "ahRzfmF2b2NhZG8tYmFja2VuZC12MXI5CxIPUHJvY2Vzc0luc3RhbmNlGICAgICAgOQLDAsSEEFjdGl2aXR5SW5zdGFuY2UYgICAgICAlAoM",
    "Id" : 5717460464435200,
    "Status" : "ACTIVE",
    "Activity" : {
      "Id" : "NEW-COMPANY-INCORPORATION-WORKFLOW-SHORT-DRAFT",
      "Code" : "NEW-COMPANY-INCORPORATION-WORKFLOW-SHORT-DRAFT",
      "Type" : "STEP",
      "Name" : "Draft",
      "ExpectedDuration" : 10,
      "ShowCancelToClientUser" : false
    },
    "Actions" : [ {
      "Type" : "USER",
      "Code" : "Draft-Submit",
      "Name" : "Submit",
      "DefaultExecutionComment" : "Submitting draft company data",
      "Instructions" : "Just press 'OK' button",
      "CommentRequired" : true,
      "ReverseAction" : false,
      "ShowDocumentsConfirmation" : false,
      "RequestPaymentAction" : false,
      "default" : false
    } ],
    "AssignedTo" : {
      "Id" : 5224879255191552,
      "FirstName" : "Mr. customerUser",
      "Email" : "customerUser@gmail.com",
      "Active" : true,
      "Name" : "Mr. customerUser"
    },
    "CreatedDate" : "2018-05-15T10:22:46.171+03:00"
  },
  "ProcessInstance" : {
    "Id" : 6632254138744832,
    "_Key" : "ahRzfmF2b2NhZG8tYmFja2VuZC12MXIcCxIPUHJvY2Vzc0luc3RhbmNlGICAgICAgOQLDA",
    "Status" : "ACTIVE",
    "Parameters" : { },
    "InitiatedBy" : {
      "Id" : 5224879255191552,
      "FirstName" : "Mr. customerUser",
      "Email" : "customerUser@gmail.com",
      "Active" : true,
      "Name" : "Mr. customerUser"
    },
    "SeqNo" : 1,
    "Prices" : [ {
      "Workflow" : {
        "SortOrder" : 0,
        "Id" : "NEW-COMPANY-INCORPORATION-SHORT-VER2-WORKFLOW",
        "Key" : "ahRzfmF2b2NhZG8tYmFja2VuZC12MXJQCxIMT3JnYW5pemF0aW9uIgNTR1AMCxIIV29ya2Zsb3ciLU5FVy1DT01QQU5ZLUlOQ09SUE9SQVRJT04tU0hPUlQtVkVSMi1XT1JLRkxPVww",
        "Name" : "Incorporate a New Company Quickly",
        "Code" : "NEW-COMPANY-INCORPORATION-SHORT-VER2-WORKFLOW",
        "Version" : 1,
        "Description" : "Use this Workflow to Incorporate a New Company quickly.",
        "FirstStepCode" : "NEW-COMPANY-INCORPORATION-WORKFLOW-SHORT-DRAFT",
        "WorkflowCategory" : {
          "SortOrder" : 0,
          "Id" : "CORP-SERVICES",
          "Code" : "CORP-SERVICES",
          "Description" : "This Section contains workflow for Company Services.",
          "Icon" : "chevron-right",
          "Name" : "Company Services"
        },
        "CurrentFormVersionKey" : "ahRzfmF2b2NhZG8tYmFja2VuZC12MXJ-CxIMT3JnYW5pemF0aW9uIgNTR1AMCxIIV29ya2Zsb3ciLU5FVy1DT01QQU5ZLUlOQ09SUE9SQVRJT04tU0hPUlQtVkVSMi1XT1JLRkxPVwwLEg9Xb3JrZmxvd1ZlcnNpb24YAQwLEgxXb3JrZmxvd0Zvcm0YgICAgICAkAsM",
        "AlwaysDisplayed" : false,
        "VisibleToClient" : false
      },
      "Price" : 100.0,
      "Deposit" : 100.0,
      "ParentWorkflow" : true,
      "AdditionalServices" : {
        "SHIPPING_COST" : {
          "Group" : "SHIPPING",
          "Code" : "SHIPPING_COST",
          "Label" : "Shipping Cost",
          "Price" : 100.0,
          "Units" : 1
        },
        "MISCELLANEOUS" : {
          "Group" : "MISCELLANEOUS",
          "Code" : "MISCELLANEOUS",
          "Label" : "Miscellaneous",
          "Price" : 100.0,
          "Units" : 1
        }
      },
      "Units" : 1,
      "Discount" : { }
    } ],
    "Tags" : [ ],
    "MasterRootEntityDisplayProperty" : ""
  },
  "DocumentInstance" : {
    "Id" : 6632254138744832,
    "Client" : {
      "CreatedOn" : "2018-05-15T10:22:46.096+03:00",
      "Id" : 5031365208702976,
      "Name" : "New Startup",
      "Code" : "NEW_STARTUP",
      "Email" : "sd_new_startup@gmail.com",
      "Status" : {
        "Id" : "ACTIVE",
        "Code" : "ACTIVE",
        "Description" : "Active customer",
        "Name" : "Active customer"
      },
      "_Key" : "ahRzfmF2b2NhZG8tYmFja2VuZC12MXInCxIMT3JnYW5pemF0aW9uIgJTRAwLEgZDbGllbnQYgICAgICA-AgM"
    },
    "DocumentModel" : {
      "_RUNTIME" : {
        "org_settings" : {
          "phoneNumber" : "1234567890",
          "timeZone" : "PST"
        },
        "PUBLISHER_RUNTIME" : {
          "WorkflowInitiator" : {
            "id" : 5224879255191552,
            "firstName" : "Mr. customerUser",
            "email" : "customerUser@gmail.com",
            "active" : true
          },
          "Client" : {
            "Id" : 5031365208702976,
            "Name" : "New Startup",
            "Email" : "sd_new_startup@gmail.com",
            "Type" : {
              "Name" : "Active customer",
              "Description" : "Active customer"
            }
          },
          "ProcessInstance" : {
            "Id" : 6632254138744832,
            "_Key" : "ahRzfmF2b2NhZG8tYmFja2VuZC12MXIcCxIPUHJvY2Vzc0luc3RhbmNlGICAgICAgOQLDA",
            "Title" : "Incorporate a New Company Quickly"
          }
        }
      }
    }
  },
  "Workflow" : {
    "Id" : "NEW-COMPANY-INCORPORATION-SHORT-VER2-WORKFLOW",
    "Key" : "ahRzfmF2b2NhZG8tYmFja2VuZC12MXJQCxIMT3JnYW5pemF0aW9uIgNTR1AMCxIIV29ya2Zsb3ciLU5FVy1DT01QQU5ZLUlOQ09SUE9SQVRJT04tU0hPUlQtVkVSMi1XT1JLRkxPVww",
    "Name" : "Incorporate a New Company Quickly",
    "Code" : "NEW-COMPANY-INCORPORATION-SHORT-VER2-WORKFLOW",
    "CurrentFormVersionKey" : "ahRzfmF2b2NhZG8tYmFja2VuZC12MXJ-CxIMT3JnYW5pemF0aW9uIgNTR1AMCxIIV29ya2Zsb3ciLU5FVy1DT01QQU5ZLUlOQ09SUE9SQVRJT04tU0hPUlQtVkVSMi1XT1JLRkxPVwwLEg9Xb3JrZmxvd1ZlcnNpb24YAQwLEgxXb3JrZmxvd0Zvcm0YgICAgICAkAsM",
    "AlwaysDisplayed" : false,
    "VisibleToClient" : false
  },
  "CommentsCount" : 1,
  "ReturnToSender" : false,
  "CurrentFormVersionKey" : "ahRzfmF2b2NhZG8tYmFja2VuZC12MXJ-CxIMT3JnYW5pemF0aW9uIgNTR1AMCxIIV29ya2Zsb3ciLU5FVy1DT01QQU5ZLUlOQ09SUE9SQVRJT04tU0hPUlQtVkVSMi1XT1JLRkxPVwwLEg9Xb3JrZmxvd1ZlcnNpb24YAQwLEgxXb3JrZmxvd0Zvcm0YgICAgICAkAsM",
  "AssignedToSupport" : false,
  "AcceptPayment" : false
}

Business Information

Create Business Information Link

Creates a Business Information link

Example request

POST /organization/SD/business-information/link HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjU2Mjk0OTk1MzQyMTMxMjAsImV4cCI6MTUyODk2MDkyMywicm9sZXMiOltdLCJkb21haW5BcHBSb2xlcyI6W10sInBlcm1pc3Npb25zIjpbIlJFVFJZX1dPUktGTE9XIiwiU1VQRVJBRE1JTiIsIkVSUk9SX01BTkFHRU1FTlQiLCJTVUJTQ1JJQkVSU19NQU5BR0VNRU5UIiwiQ1JFQVRFX1VTRVIiLCJFWEVDVVRFX0FDVElPTiIsIkNMSUVOVF9VU0VSU19NQU5BR0VNRU5UIiwiQVBQUk9WRV9DQU5DRUwiLCJSRVFVRVNUX0NBTkNFTCIsIlVTRVJTX01BTkFHRU1FTlQiLCJOT1RJRklDQVRJT05TX01BTkFHRU1FTlQiLCJHRVRfVVNFUlMiLCJSRVNPVVJDRVNfTUFOQUdFTUVOVCIsIkFDQ0VTU19BRE1JTl9QQUdFIiwiVVNFUl9ST0xFU19NQU5BR0VNRU5UIiwiQ0xJRU5UU19NQU5BR0VNRU5UIiwiSEVMUF9BUlRJQ0xFU19NQU5BR0VNRU5UIiwiU1RBUlRfV09SS0ZMT1ciXX0.UtQC0PRVAxPh1uulYbpuUu8f6vllXaTq9NKFW8hUD_EjTwv7h-s2eNLndsa7gMWFuutM4ODaL-B4jPqUGGRDlg
Host: corporateservices.com
Content-Length: 252

{
  "Url" : "www.google.com",
  "Name" : "Rules and Regulations",
  "Description" : "Rules and regulations for your reference",
  "RoleCodes" : "ANALYST,MANAGER",
  "ValidFrom" : "2018-05-10T07:30:45.555Z",
  "ValidUntil" : "2018-05-20T07:30:45.555Z"
}

$ curl 'https://corporateservices.com:8080/organization/SD/business-information/link' -i -X POST -H 'Content-Type: application/json' -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjU2Mjk0OTk1MzQyMTMxMjAsImV4cCI6MTUyODk2MDkyMywicm9sZXMiOltdLCJkb21haW5BcHBSb2xlcyI6W10sInBlcm1pc3Npb25zIjpbIlJFVFJZX1dPUktGTE9XIiwiU1VQRVJBRE1JTiIsIkVSUk9SX01BTkFHRU1FTlQiLCJTVUJTQ1JJQkVSU19NQU5BR0VNRU5UIiwiQ1JFQVRFX1VTRVIiLCJFWEVDVVRFX0FDVElPTiIsIkNMSUVOVF9VU0VSU19NQU5BR0VNRU5UIiwiQVBQUk9WRV9DQU5DRUwiLCJSRVFVRVNUX0NBTkNFTCIsIlVTRVJTX01BTkFHRU1FTlQiLCJOT1RJRklDQVRJT05TX01BTkFHRU1FTlQiLCJHRVRfVVNFUlMiLCJSRVNPVVJDRVNfTUFOQUdFTUVOVCIsIkFDQ0VTU19BRE1JTl9QQUdFIiwiVVNFUl9ST0xFU19NQU5BR0VNRU5UIiwiQ0xJRU5UU19NQU5BR0VNRU5UIiwiSEVMUF9BUlRJQ0xFU19NQU5BR0VNRU5UIiwiU1RBUlRfV09SS0ZMT1ciXX0.UtQC0PRVAxPh1uulYbpuUu8f6vllXaTq9NKFW8hUD_EjTwv7h-s2eNLndsa7gMWFuutM4ODaL-B4jPqUGGRDlg' -d '{
  "Url" : "www.google.com",
  "Name" : "Rules and Regulations",
  "Description" : "Rules and regulations for your reference",
  "RoleCodes" : "ANALYST,MANAGER",
  "ValidFrom" : "2018-05-10T07:30:45.555Z",
  "ValidUntil" : "2018-05-20T07:30:45.555Z"
}'

/organization/{organizationCode}/business-information/link

Parameter	Description
organizationCode	Organization code

Path	Type	Description
Name	String	Name of the resource
Url	String	URL of the resource
Description	String	Description
RoleCodes	String	Comma separated role codes
ValidFrom	String	Valid from
ValidUntil	String	Valid until

Example response

HTTP/1.1 200 OK
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: POST, GET, PUT, OPTIONS, DELETE
Access-Control-Max-Age: 3600
Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Authorization
Content-Type: application/json;charset=UTF-8
Content-Length: 698

{
  "Id" : 5506354231902208,
  "Url" : "www.google.com",
  "Type" : "LINK",
  "Name" : "Rules and Regulations",
  "Description" : "Rules and regulations for your reference",
  "ValidFrom" : "2018-05-10T07:30:45.555Z",
  "ValidUntil" : "2018-05-20T07:30:45.555Z",
  "Roles" : [ {
    "Id" : "ANALYST",
    "Type" : "TEAM_ROLE",
    "Permissions" : [ "START_WORKFLOW", "EXECUTE_ACTION", "REQUEST_CANCEL", "RETRY_WORKFLOW", "PAYMENTS_MANAGEMENT" ],
    "Code" : "ANALYST",
    "Name" : "Analyst"
  }, {
    "Id" : "MANAGER",
    "Type" : "TEAM_ROLE",
    "Permissions" : [ "START_WORKFLOW", "EXECUTE_ACTION", "REQUEST_CANCEL", "RETRY_WORKFLOW" ],
    "Code" : "MANAGER",
    "Name" : "Manager"
  } ]
}

Path	Type	Description
Id	Number	ID of the resource
Name	String	Name of the resource
Url	String	URL of the resource
Description	String	Description
Type	String	Description
Roles	Array	Roles assinged to the resource
ValidFrom	String	Valid from
ValidUntil	String	Valid until

Update business information link

Update a business information resource of type LINK

Example request

PUT /organization/SD/business-information/link/5506354231902208 HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjU2Mjk0OTk1MzQyMTMxMjAsImV4cCI6MTUyODk2MDkyNCwicm9sZXMiOltdLCJkb21haW5BcHBSb2xlcyI6W10sInBlcm1pc3Npb25zIjpbIlJFVFJZX1dPUktGTE9XIiwiU1VQRVJBRE1JTiIsIkVSUk9SX01BTkFHRU1FTlQiLCJTVUJTQ1JJQkVSU19NQU5BR0VNRU5UIiwiQ1JFQVRFX1VTRVIiLCJFWEVDVVRFX0FDVElPTiIsIkNMSUVOVF9VU0VSU19NQU5BR0VNRU5UIiwiQVBQUk9WRV9DQU5DRUwiLCJSRVFVRVNUX0NBTkNFTCIsIlVTRVJTX01BTkFHRU1FTlQiLCJOT1RJRklDQVRJT05TX01BTkFHRU1FTlQiLCJHRVRfVVNFUlMiLCJSRVNPVVJDRVNfTUFOQUdFTUVOVCIsIkFDQ0VTU19BRE1JTl9QQUdFIiwiVVNFUl9ST0xFU19NQU5BR0VNRU5UIiwiQ0xJRU5UU19NQU5BR0VNRU5UIiwiSEVMUF9BUlRJQ0xFU19NQU5BR0VNRU5UIiwiU1RBUlRfV09SS0ZMT1ciXX0.o_QiLc1DUCX44wXWWiTBsdmkGvlBpVZvoMf9g3BiZrFemabSHUP7XtWa0VeamzT-NZFi2QQFMmbh2ATsybEQpg
Host: corporateservices.com
Content-Length: 252

{
  "Url" : "www.google.com",
  "Name" : "Rules and Regulations",
  "Description" : "Rules and regulations for your reference",
  "RoleCodes" : "ANALYST,MANAGER",
  "ValidFrom" : "2018-05-10T07:30:45.555Z",
  "ValidUntil" : "2018-05-20T07:30:45.555Z"
}

$ curl 'https://corporateservices.com:8080/organization/SD/business-information/link/5506354231902208' -i -X PUT -H 'Content-Type: application/json' -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjU2Mjk0OTk1MzQyMTMxMjAsImV4cCI6MTUyODk2MDkyNCwicm9sZXMiOltdLCJkb21haW5BcHBSb2xlcyI6W10sInBlcm1pc3Npb25zIjpbIlJFVFJZX1dPUktGTE9XIiwiU1VQRVJBRE1JTiIsIkVSUk9SX01BTkFHRU1FTlQiLCJTVUJTQ1JJQkVSU19NQU5BR0VNRU5UIiwiQ1JFQVRFX1VTRVIiLCJFWEVDVVRFX0FDVElPTiIsIkNMSUVOVF9VU0VSU19NQU5BR0VNRU5UIiwiQVBQUk9WRV9DQU5DRUwiLCJSRVFVRVNUX0NBTkNFTCIsIlVTRVJTX01BTkFHRU1FTlQiLCJOT1RJRklDQVRJT05TX01BTkFHRU1FTlQiLCJHRVRfVVNFUlMiLCJSRVNPVVJDRVNfTUFOQUdFTUVOVCIsIkFDQ0VTU19BRE1JTl9QQUdFIiwiVVNFUl9ST0xFU19NQU5BR0VNRU5UIiwiQ0xJRU5UU19NQU5BR0VNRU5UIiwiSEVMUF9BUlRJQ0xFU19NQU5BR0VNRU5UIiwiU1RBUlRfV09SS0ZMT1ciXX0.o_QiLc1DUCX44wXWWiTBsdmkGvlBpVZvoMf9g3BiZrFemabSHUP7XtWa0VeamzT-NZFi2QQFMmbh2ATsybEQpg' -d '{
  "Url" : "www.google.com",
  "Name" : "Rules and Regulations",
  "Description" : "Rules and regulations for your reference",
  "RoleCodes" : "ANALYST,MANAGER",
  "ValidFrom" : "2018-05-10T07:30:45.555Z",
  "ValidUntil" : "2018-05-20T07:30:45.555Z"
}'

/organization/{organizationCode}/business-information/link/{id}

Parameter	Description
organizationCode	Organization code
id	Id

Path	Type	Description
Name	String	Name of the resource
Url	String	URL of the resource
Description	String	Description
RoleCodes	String	Comma separated role codes
ValidFrom	String	Valid from
ValidUntil	String	Valid until

Example response

HTTP/1.1 200 OK
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: POST, GET, PUT, OPTIONS, DELETE
Access-Control-Max-Age: 3600
Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Authorization
Content-Type: application/json;charset=UTF-8
Content-Length: 698

{
  "Id" : 5506354231902208,
  "Url" : "www.google.com",
  "Type" : "LINK",
  "Name" : "Rules and Regulations",
  "Description" : "Rules and regulations for your reference",
  "ValidFrom" : "2018-05-10T07:30:45.555Z",
  "ValidUntil" : "2018-05-20T07:30:45.555Z",
  "Roles" : [ {
    "Id" : "ANALYST",
    "Type" : "TEAM_ROLE",
    "Permissions" : [ "START_WORKFLOW", "EXECUTE_ACTION", "REQUEST_CANCEL", "RETRY_WORKFLOW", "PAYMENTS_MANAGEMENT" ],
    "Code" : "ANALYST",
    "Name" : "Analyst"
  }, {
    "Id" : "MANAGER",
    "Type" : "TEAM_ROLE",
    "Permissions" : [ "START_WORKFLOW", "EXECUTE_ACTION", "REQUEST_CANCEL", "RETRY_WORKFLOW" ],
    "Code" : "MANAGER",
    "Name" : "Manager"
  } ]
}

Path	Type	Description
Id	Number	ID of the resource
Name	String	Name of the resource
Url	String	URL of the resource
Description	String	Description
Type	String	Description
Roles	Array	Roles assinged to the resource
ValidFrom	String	Valid from
ValidUntil	String	Valid until

Delete business information link

Deletes a business information resource of type LINK

Example request

DELETE /organization/SD/business-information/link/123456 HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjU5MTA5NzQ1MTA5MjM3NzYsImV4cCI6MTUyODk2MDkyMSwib3JnQ29kZSI6IlNEIiwicm9sZXMiOlsiYWRtaW5pc3RyYXRvciJdLCJkb21haW5BcHBSb2xlcyI6WyJBTkFMWVNUIiwiU1VQUE9SVCJdLCJwZXJtaXNzaW9ucyI6WyJSRVRSWV9XT1JLRkxPVyIsIlJPTEVfYWRtaW5pc3RyYXRvciIsIkVSUk9SX01BTkFHRU1FTlQiLCJTVUJTQ1JJQkVSU19NQU5BR0VNRU5UIiwiQ1JFQVRFX1VTRVIiLCJFWEVDVVRFX0FDVElPTiIsIkNMSUVOVF9VU0VSU19NQU5BR0VNRU5UIiwiQVBQUk9WRV9DQU5DRUwiLCJSRVFVRVNUX0NBTkNFTCIsIlVTRVJTX01BTkFHRU1FTlQiLCJOT1RJRklDQVRJT05TX01BTkFHRU1FTlQiLCJQQVlNRU5UU19NQU5BR0VNRU5UIiwiR0VUX1VTRVJTIiwiUkVTT1VSQ0VTX01BTkFHRU1FTlQiLCJBQ0NFU1NfQURNSU5fUEFHRSIsIlVTRVJfUk9MRVNfTUFOQUdFTUVOVCIsIkNMSUVOVFNfTUFOQUdFTUVOVCIsIkhFTFBfQVJUSUNMRVNfTUFOQUdFTUVOVCIsIlNUQVJUX1dPUktGTE9XIl19.wyNTNX_mH4BVhxMLRVbvW0GqIrlCCWSskboakHzukSCr_0P_0QK21Rd31L-PtT3h4-i_jWEKqjygpolbUx-A6A
Host: corporateservices.com

$ curl 'https://corporateservices.com:8080/organization/SD/business-information/link/123456' -i -X DELETE -H 'Content-Type: application/json' -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjU5MTA5NzQ1MTA5MjM3NzYsImV4cCI6MTUyODk2MDkyMSwib3JnQ29kZSI6IlNEIiwicm9sZXMiOlsiYWRtaW5pc3RyYXRvciJdLCJkb21haW5BcHBSb2xlcyI6WyJBTkFMWVNUIiwiU1VQUE9SVCJdLCJwZXJtaXNzaW9ucyI6WyJSRVRSWV9XT1JLRkxPVyIsIlJPTEVfYWRtaW5pc3RyYXRvciIsIkVSUk9SX01BTkFHRU1FTlQiLCJTVUJTQ1JJQkVSU19NQU5BR0VNRU5UIiwiQ1JFQVRFX1VTRVIiLCJFWEVDVVRFX0FDVElPTiIsIkNMSUVOVF9VU0VSU19NQU5BR0VNRU5UIiwiQVBQUk9WRV9DQU5DRUwiLCJSRVFVRVNUX0NBTkNFTCIsIlVTRVJTX01BTkFHRU1FTlQiLCJOT1RJRklDQVRJT05TX01BTkFHRU1FTlQiLCJQQVlNRU5UU19NQU5BR0VNRU5UIiwiR0VUX1VTRVJTIiwiUkVTT1VSQ0VTX01BTkFHRU1FTlQiLCJBQ0NFU1NfQURNSU5fUEFHRSIsIlVTRVJfUk9MRVNfTUFOQUdFTUVOVCIsIkNMSUVOVFNfTUFOQUdFTUVOVCIsIkhFTFBfQVJUSUNMRVNfTUFOQUdFTUVOVCIsIlNUQVJUX1dPUktGTE9XIl19.wyNTNX_mH4BVhxMLRVbvW0GqIrlCCWSskboakHzukSCr_0P_0QK21Rd31L-PtT3h4-i_jWEKqjygpolbUx-A6A'

/organization/{organizationCode}/business-information/link/{id}

Parameter	Description
organizationCode	Organization code
id	Id

Example response

HTTP/1.1 200 OK
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: POST, GET, PUT, OPTIONS, DELETE
Access-Control-Max-Age: 3600
Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Authorization

Delete business information document

Deletes a business information resource of type DOCUMENT

Example request

DELETE /organization/SD/business-information/document/123456 HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjU5MTA5NzQ1MTA5MjM3NzYsImV4cCI6MTUyODk2MDkxOCwib3JnQ29kZSI6IlNEIiwicm9sZXMiOlsiYWRtaW5pc3RyYXRvciJdLCJkb21haW5BcHBSb2xlcyI6WyJBTkFMWVNUIiwiU1VQUE9SVCJdLCJwZXJtaXNzaW9ucyI6WyJSRVRSWV9XT1JLRkxPVyIsIlJPTEVfYWRtaW5pc3RyYXRvciIsIkVSUk9SX01BTkFHRU1FTlQiLCJTVUJTQ1JJQkVSU19NQU5BR0VNRU5UIiwiQ1JFQVRFX1VTRVIiLCJFWEVDVVRFX0FDVElPTiIsIkNMSUVOVF9VU0VSU19NQU5BR0VNRU5UIiwiQVBQUk9WRV9DQU5DRUwiLCJSRVFVRVNUX0NBTkNFTCIsIlVTRVJTX01BTkFHRU1FTlQiLCJOT1RJRklDQVRJT05TX01BTkFHRU1FTlQiLCJQQVlNRU5UU19NQU5BR0VNRU5UIiwiR0VUX1VTRVJTIiwiUkVTT1VSQ0VTX01BTkFHRU1FTlQiLCJBQ0NFU1NfQURNSU5fUEFHRSIsIlVTRVJfUk9MRVNfTUFOQUdFTUVOVCIsIkNMSUVOVFNfTUFOQUdFTUVOVCIsIkhFTFBfQVJUSUNMRVNfTUFOQUdFTUVOVCIsIlNUQVJUX1dPUktGTE9XIl19.yCEHXT0-OKytCQ4u4UZZfUBX9aGATHYupOgqlv0eJG3wOnuAUIgF8sYODhYIgEpZUIJIan-ckyqSB5SipROlrA
Host: corporateservices.com

$ curl 'https://corporateservices.com:8080/organization/SD/business-information/document/123456' -i -X DELETE -H 'Content-Type: application/json' -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjU5MTA5NzQ1MTA5MjM3NzYsImV4cCI6MTUyODk2MDkxOCwib3JnQ29kZSI6IlNEIiwicm9sZXMiOlsiYWRtaW5pc3RyYXRvciJdLCJkb21haW5BcHBSb2xlcyI6WyJBTkFMWVNUIiwiU1VQUE9SVCJdLCJwZXJtaXNzaW9ucyI6WyJSRVRSWV9XT1JLRkxPVyIsIlJPTEVfYWRtaW5pc3RyYXRvciIsIkVSUk9SX01BTkFHRU1FTlQiLCJTVUJTQ1JJQkVSU19NQU5BR0VNRU5UIiwiQ1JFQVRFX1VTRVIiLCJFWEVDVVRFX0FDVElPTiIsIkNMSUVOVF9VU0VSU19NQU5BR0VNRU5UIiwiQVBQUk9WRV9DQU5DRUwiLCJSRVFVRVNUX0NBTkNFTCIsIlVTRVJTX01BTkFHRU1FTlQiLCJOT1RJRklDQVRJT05TX01BTkFHRU1FTlQiLCJQQVlNRU5UU19NQU5BR0VNRU5UIiwiR0VUX1VTRVJTIiwiUkVTT1VSQ0VTX01BTkFHRU1FTlQiLCJBQ0NFU1NfQURNSU5fUEFHRSIsIlVTRVJfUk9MRVNfTUFOQUdFTUVOVCIsIkNMSUVOVFNfTUFOQUdFTUVOVCIsIkhFTFBfQVJUSUNMRVNfTUFOQUdFTUVOVCIsIlNUQVJUX1dPUktGTE9XIl19.yCEHXT0-OKytCQ4u4UZZfUBX9aGATHYupOgqlv0eJG3wOnuAUIgF8sYODhYIgEpZUIJIan-ckyqSB5SipROlrA'

/organization/{organizationCode}/business-information/document/{id}

Parameter	Description
organizationCode	Organization code
id	Id

Example response

HTTP/1.1 500 Internal Server Error
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: POST, GET, PUT, OPTIONS, DELETE
Access-Control-Max-Age: 3600
Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Authorization
Content-Type: application/json;charset=UTF-8
Content-Length: 133

{
  "ErrorCode" : "BIE007",
  "Message" : "Business information Key<?>(Organization(\"SD\")/BusinessInformation(123456)) not found"
}

Get all business information resources

A request to retrieve all the business information resources in the organization

Example request

GET /organization/SD/business-information HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjU5MTA5NzQ1MTA5MjM3NzYsImV4cCI6MTUyODk2MDkxOSwib3JnQ29kZSI6IlNEIiwicm9sZXMiOlsiYWRtaW5pc3RyYXRvciJdLCJkb21haW5BcHBSb2xlcyI6WyJBTkFMWVNUIiwiU1VQUE9SVCJdLCJwZXJtaXNzaW9ucyI6WyJSRVRSWV9XT1JLRkxPVyIsIlJPTEVfYWRtaW5pc3RyYXRvciIsIkVSUk9SX01BTkFHRU1FTlQiLCJTVUJTQ1JJQkVSU19NQU5BR0VNRU5UIiwiQ1JFQVRFX1VTRVIiLCJFWEVDVVRFX0FDVElPTiIsIkNMSUVOVF9VU0VSU19NQU5BR0VNRU5UIiwiQVBQUk9WRV9DQU5DRUwiLCJSRVFVRVNUX0NBTkNFTCIsIlVTRVJTX01BTkFHRU1FTlQiLCJOT1RJRklDQVRJT05TX01BTkFHRU1FTlQiLCJQQVlNRU5UU19NQU5BR0VNRU5UIiwiR0VUX1VTRVJTIiwiUkVTT1VSQ0VTX01BTkFHRU1FTlQiLCJBQ0NFU1NfQURNSU5fUEFHRSIsIlVTRVJfUk9MRVNfTUFOQUdFTUVOVCIsIkNMSUVOVFNfTUFOQUdFTUVOVCIsIkhFTFBfQVJUSUNMRVNfTUFOQUdFTUVOVCIsIlNUQVJUX1dPUktGTE9XIl19.dpC4Pqpcf0EoH-JbINPJmxesa1CZWfQlBVfhlcKdDd8ydmWwEcOljbTHATxrYYrXUfUC2SSDPoI1hfden32lYQ
Host: corporateservices.com

$ curl 'https://corporateservices.com:8080/organization/SD/business-information' -i -H 'Content-Type: application/json' -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjU5MTA5NzQ1MTA5MjM3NzYsImV4cCI6MTUyODk2MDkxOSwib3JnQ29kZSI6IlNEIiwicm9sZXMiOlsiYWRtaW5pc3RyYXRvciJdLCJkb21haW5BcHBSb2xlcyI6WyJBTkFMWVNUIiwiU1VQUE9SVCJdLCJwZXJtaXNzaW9ucyI6WyJSRVRSWV9XT1JLRkxPVyIsIlJPTEVfYWRtaW5pc3RyYXRvciIsIkVSUk9SX01BTkFHRU1FTlQiLCJTVUJTQ1JJQkVSU19NQU5BR0VNRU5UIiwiQ1JFQVRFX1VTRVIiLCJFWEVDVVRFX0FDVElPTiIsIkNMSUVOVF9VU0VSU19NQU5BR0VNRU5UIiwiQVBQUk9WRV9DQU5DRUwiLCJSRVFVRVNUX0NBTkNFTCIsIlVTRVJTX01BTkFHRU1FTlQiLCJOT1RJRklDQVRJT05TX01BTkFHRU1FTlQiLCJQQVlNRU5UU19NQU5BR0VNRU5UIiwiR0VUX1VTRVJTIiwiUkVTT1VSQ0VTX01BTkFHRU1FTlQiLCJBQ0NFU1NfQURNSU5fUEFHRSIsIlVTRVJfUk9MRVNfTUFOQUdFTUVOVCIsIkNMSUVOVFNfTUFOQUdFTUVOVCIsIkhFTFBfQVJUSUNMRVNfTUFOQUdFTUVOVCIsIlNUQVJUX1dPUktGTE9XIl19.dpC4Pqpcf0EoH-JbINPJmxesa1CZWfQlBVfhlcKdDd8ydmWwEcOljbTHATxrYYrXUfUC2SSDPoI1hfden32lYQ'

/organization/{organizationCode}/business-information

Parameter	Description
organizationCode	Organization code

Example response

HTTP/1.1 200 OK
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: POST, GET, PUT, OPTIONS, DELETE
Access-Control-Max-Age: 3600
Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Authorization
Content-Type: application/json;charset=UTF-8
Content-Length: 702

[ {
  "Id" : 5506354231902208,
  "Url" : "www.google.com",
  "Type" : "LINK",
  "Name" : "Rules and Regulations",
  "Description" : "Rules and regulations for your reference",
  "ValidFrom" : "2018-05-10T07:30:45.555Z",
  "ValidUntil" : "2018-05-20T07:30:45.555Z",
  "Roles" : [ {
    "Id" : "ANALYST",
    "Type" : "TEAM_ROLE",
    "Permissions" : [ "START_WORKFLOW", "EXECUTE_ACTION", "REQUEST_CANCEL", "RETRY_WORKFLOW", "PAYMENTS_MANAGEMENT" ],
    "Code" : "ANALYST",
    "Name" : "Analyst"
  }, {
    "Id" : "MANAGER",
    "Type" : "TEAM_ROLE",
    "Permissions" : [ "START_WORKFLOW", "EXECUTE_ACTION", "REQUEST_CANCEL", "RETRY_WORKFLOW" ],
    "Code" : "MANAGER",
    "Name" : "Manager"
  } ]
} ]

Path	Type	Description
[]	Array	An array of business information
[].Id	Number	ID of the resource
[].Name	String	Name of the resource
[].Url	String	URL of the resource
[].Description	String	Description
[].Type	String	Type of resource (LINK/DOCUMENT)
[].Roles	Array	Roles assinged to the resource
[].ValidFrom	String	Valid from
[].ValidUntil	String	Valid until

Get my business information resources

A request to retrieve all the business information resources that are applicable to the current logged in user. Both publisher and subscriber resources are returned.

Example request

GET /organization/SD/business-information/my HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjU5MTA5NzQ1MTA5MjM3NzYsImV4cCI6MTUyODk2MDkxNiwib3JnQ29kZSI6IlNEIiwicm9sZXMiOlsiYWRtaW5pc3RyYXRvciJdLCJkb21haW5BcHBSb2xlcyI6WyJBTkFMWVNUIiwiU1VQUE9SVCJdLCJwZXJtaXNzaW9ucyI6WyJSRVRSWV9XT1JLRkxPVyIsIlJPTEVfYWRtaW5pc3RyYXRvciIsIkVSUk9SX01BTkFHRU1FTlQiLCJTVUJTQ1JJQkVSU19NQU5BR0VNRU5UIiwiQ1JFQVRFX1VTRVIiLCJFWEVDVVRFX0FDVElPTiIsIkNMSUVOVF9VU0VSU19NQU5BR0VNRU5UIiwiQVBQUk9WRV9DQU5DRUwiLCJSRVFVRVNUX0NBTkNFTCIsIlVTRVJTX01BTkFHRU1FTlQiLCJOT1RJRklDQVRJT05TX01BTkFHRU1FTlQiLCJQQVlNRU5UU19NQU5BR0VNRU5UIiwiR0VUX1VTRVJTIiwiUkVTT1VSQ0VTX01BTkFHRU1FTlQiLCJBQ0NFU1NfQURNSU5fUEFHRSIsIlVTRVJfUk9MRVNfTUFOQUdFTUVOVCIsIkNMSUVOVFNfTUFOQUdFTUVOVCIsIkhFTFBfQVJUSUNMRVNfTUFOQUdFTUVOVCIsIlNUQVJUX1dPUktGTE9XIl19.sjBf4ELHS5hAungCuh5l_TwXFHW6F4y7ncXZzbtTxJUW93kc8cwEa6WBHisQTQfOE2TaASItHgEv_HAfGjKqwQ
Host: corporateservices.com

$ curl 'https://corporateservices.com:8080/organization/SD/business-information/my' -i -H 'Content-Type: application/json' -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjU5MTA5NzQ1MTA5MjM3NzYsImV4cCI6MTUyODk2MDkxNiwib3JnQ29kZSI6IlNEIiwicm9sZXMiOlsiYWRtaW5pc3RyYXRvciJdLCJkb21haW5BcHBSb2xlcyI6WyJBTkFMWVNUIiwiU1VQUE9SVCJdLCJwZXJtaXNzaW9ucyI6WyJSRVRSWV9XT1JLRkxPVyIsIlJPTEVfYWRtaW5pc3RyYXRvciIsIkVSUk9SX01BTkFHRU1FTlQiLCJTVUJTQ1JJQkVSU19NQU5BR0VNRU5UIiwiQ1JFQVRFX1VTRVIiLCJFWEVDVVRFX0FDVElPTiIsIkNMSUVOVF9VU0VSU19NQU5BR0VNRU5UIiwiQVBQUk9WRV9DQU5DRUwiLCJSRVFVRVNUX0NBTkNFTCIsIlVTRVJTX01BTkFHRU1FTlQiLCJOT1RJRklDQVRJT05TX01BTkFHRU1FTlQiLCJQQVlNRU5UU19NQU5BR0VNRU5UIiwiR0VUX1VTRVJTIiwiUkVTT1VSQ0VTX01BTkFHRU1FTlQiLCJBQ0NFU1NfQURNSU5fUEFHRSIsIlVTRVJfUk9MRVNfTUFOQUdFTUVOVCIsIkNMSUVOVFNfTUFOQUdFTUVOVCIsIkhFTFBfQVJUSUNMRVNfTUFOQUdFTUVOVCIsIlNUQVJUX1dPUktGTE9XIl19.sjBf4ELHS5hAungCuh5l_TwXFHW6F4y7ncXZzbtTxJUW93kc8cwEa6WBHisQTQfOE2TaASItHgEv_HAfGjKqwQ'

/organization/{organizationCode}/business-information/my

Parameter	Description
organizationCode	Organization code

Example response

HTTP/1.1 200 OK
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: POST, GET, PUT, OPTIONS, DELETE
Access-Control-Max-Age: 3600
Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Authorization
Content-Type: application/json;charset=UTF-8
Content-Length: 702

[ {
  "Id" : 5506354231902208,
  "Url" : "www.google.com",
  "Type" : "LINK",
  "Name" : "Rules and Regulations",
  "Description" : "Rules and regulations for your reference",
  "ValidFrom" : "2018-05-10T07:30:45.555Z",
  "ValidUntil" : "2018-05-20T07:30:45.555Z",
  "Roles" : [ {
    "Id" : "ANALYST",
    "Type" : "TEAM_ROLE",
    "Permissions" : [ "START_WORKFLOW", "EXECUTE_ACTION", "REQUEST_CANCEL", "RETRY_WORKFLOW", "PAYMENTS_MANAGEMENT" ],
    "Code" : "ANALYST",
    "Name" : "Analyst"
  }, {
    "Id" : "MANAGER",
    "Type" : "TEAM_ROLE",
    "Permissions" : [ "START_WORKFLOW", "EXECUTE_ACTION", "REQUEST_CANCEL", "RETRY_WORKFLOW" ],
    "Code" : "MANAGER",
    "Name" : "Manager"
  } ]
} ]

Path	Type	Description
[]	Array	An array of business information
[].Id	Number	ID of the resource
[].Name	String	Name of the resource
[].Url	String	URL of the resource
[].Description	String	Description
[].Type	String	Type of resource (LINK/DOCUMENT)
[].Roles	Array	Roles assinged to the resource
[].ValidFrom	String	Valid from
[].ValidUntil	String	Valid until

User routes

Create User route

Creates a User route

Example request

POST /organization/someorg482/user-routes HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjU2Mjk0OTk1MzQyMTMxMjAsImV4cCI6MTUyODk2MDk1Niwicm9sZXMiOltdLCJkb21haW5BcHBSb2xlcyI6W10sInBlcm1pc3Npb25zIjpbIlJFVFJZX1dPUktGTE9XIiwiU1VQRVJBRE1JTiIsIkVSUk9SX01BTkFHRU1FTlQiLCJTVUJTQ1JJQkVSU19NQU5BR0VNRU5UIiwiQ1JFQVRFX1VTRVIiLCJFWEVDVVRFX0FDVElPTiIsIkNMSUVOVF9VU0VSU19NQU5BR0VNRU5UIiwiQVBQUk9WRV9DQU5DRUwiLCJSRVFVRVNUX0NBTkNFTCIsIlVTRVJTX01BTkFHRU1FTlQiLCJOT1RJRklDQVRJT05TX01BTkFHRU1FTlQiLCJHRVRfVVNFUlMiLCJSRVNPVVJDRVNfTUFOQUdFTUVOVCIsIkFDQ0VTU19BRE1JTl9QQUdFIiwiVVNFUl9ST0xFU19NQU5BR0VNRU5UIiwiQ0xJRU5UU19NQU5BR0VNRU5UIiwiSEVMUF9BUlRJQ0xFU19NQU5BR0VNRU5UIiwiU1RBUlRfV09SS0ZMT1ciXX0.AxppMpgTm9OD3kVyQ64kFNT-P5i7rRR-vDCDpP44FJ65deRfakrqCxzComzKBWNDmKLVHE7aP2WwTISXzEPJDg
Host: corporateservices.com
Content-Length: 161

{
  "Name" : "Directors",
  "Users" : [ {
    "Id" : 5066549580791808
  } ],
  "Team" : {
    "Code" : "TEAM"
  },
  "Description" : "Directors approval route"
}

$ curl 'https://corporateservices.com:8080/organization/someorg482/user-routes' -i -X POST -H 'Content-Type: application/json' -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjU2Mjk0OTk1MzQyMTMxMjAsImV4cCI6MTUyODk2MDk1Niwicm9sZXMiOltdLCJkb21haW5BcHBSb2xlcyI6W10sInBlcm1pc3Npb25zIjpbIlJFVFJZX1dPUktGTE9XIiwiU1VQRVJBRE1JTiIsIkVSUk9SX01BTkFHRU1FTlQiLCJTVUJTQ1JJQkVSU19NQU5BR0VNRU5UIiwiQ1JFQVRFX1VTRVIiLCJFWEVDVVRFX0FDVElPTiIsIkNMSUVOVF9VU0VSU19NQU5BR0VNRU5UIiwiQVBQUk9WRV9DQU5DRUwiLCJSRVFVRVNUX0NBTkNFTCIsIlVTRVJTX01BTkFHRU1FTlQiLCJOT1RJRklDQVRJT05TX01BTkFHRU1FTlQiLCJHRVRfVVNFUlMiLCJSRVNPVVJDRVNfTUFOQUdFTUVOVCIsIkFDQ0VTU19BRE1JTl9QQUdFIiwiVVNFUl9ST0xFU19NQU5BR0VNRU5UIiwiQ0xJRU5UU19NQU5BR0VNRU5UIiwiSEVMUF9BUlRJQ0xFU19NQU5BR0VNRU5UIiwiU1RBUlRfV09SS0ZMT1ciXX0.AxppMpgTm9OD3kVyQ64kFNT-P5i7rRR-vDCDpP44FJ65deRfakrqCxzComzKBWNDmKLVHE7aP2WwTISXzEPJDg' -d '{
  "Name" : "Directors",
  "Users" : [ {
    "Id" : 5066549580791808
  } ],
  "Team" : {
    "Code" : "TEAM"
  },
  "Description" : "Directors approval route"
}'

/organization/{orgCode}/user-routes

Parameter	Description
orgCode	Code of organization

Path	Type	Description
Name	String	User route name
Description	String	User route description
Users	Array	List of users in user route. Order of users in the list will be used in route. In case of using team based user routes, users should belong to the team.
Users.[0]	Object	User object
Users.[0].Id	Number	User id
Team	Object	Team resource to which user route should be assigned. If setting TEAM_BASED_USER_ROUTES is set to false will be ignored, should be provided otherwise.
Team.Code	String	Team code

Example response

HTTP/1.1 201 Created
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: POST, GET, PUT, OPTIONS, DELETE
Access-Control-Max-Age: 3600
Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Authorization
Content-Type: application/json;charset=UTF-8
Content-Length: 188

{
  "Id" : 5910974510923776,
  "Name" : "Directors",
  "Users" : [ {
    "Id" : 5066549580791808
  } ],
  "Team" : {
    "Code" : "TEAM"
  },
  "Description" : "Directors approval route"
}

Get all user routes

A request to retrieve all user routes for organization or team(Depend on settings)

Example request

GET /organization/someorg482/user-routes HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjU2Mjk0OTk1MzQyMTMxMjAsImV4cCI6MTUyODk2MDk1Niwicm9sZXMiOltdLCJkb21haW5BcHBSb2xlcyI6W10sInBlcm1pc3Npb25zIjpbIlJFVFJZX1dPUktGTE9XIiwiU1VQRVJBRE1JTiIsIkVSUk9SX01BTkFHRU1FTlQiLCJTVUJTQ1JJQkVSU19NQU5BR0VNRU5UIiwiQ1JFQVRFX1VTRVIiLCJFWEVDVVRFX0FDVElPTiIsIkNMSUVOVF9VU0VSU19NQU5BR0VNRU5UIiwiQVBQUk9WRV9DQU5DRUwiLCJSRVFVRVNUX0NBTkNFTCIsIlVTRVJTX01BTkFHRU1FTlQiLCJOT1RJRklDQVRJT05TX01BTkFHRU1FTlQiLCJHRVRfVVNFUlMiLCJSRVNPVVJDRVNfTUFOQUdFTUVOVCIsIkFDQ0VTU19BRE1JTl9QQUdFIiwiVVNFUl9ST0xFU19NQU5BR0VNRU5UIiwiQ0xJRU5UU19NQU5BR0VNRU5UIiwiSEVMUF9BUlRJQ0xFU19NQU5BR0VNRU5UIiwiU1RBUlRfV09SS0ZMT1ciXX0.AxppMpgTm9OD3kVyQ64kFNT-P5i7rRR-vDCDpP44FJ65deRfakrqCxzComzKBWNDmKLVHE7aP2WwTISXzEPJDg
Host: corporateservices.com

$ curl 'https://corporateservices.com:8080/organization/someorg482/user-routes' -i -H 'Content-Type: application/json' -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjU2Mjk0OTk1MzQyMTMxMjAsImV4cCI6MTUyODk2MDk1Niwicm9sZXMiOltdLCJkb21haW5BcHBSb2xlcyI6W10sInBlcm1pc3Npb25zIjpbIlJFVFJZX1dPUktGTE9XIiwiU1VQRVJBRE1JTiIsIkVSUk9SX01BTkFHRU1FTlQiLCJTVUJTQ1JJQkVSU19NQU5BR0VNRU5UIiwiQ1JFQVRFX1VTRVIiLCJFWEVDVVRFX0FDVElPTiIsIkNMSUVOVF9VU0VSU19NQU5BR0VNRU5UIiwiQVBQUk9WRV9DQU5DRUwiLCJSRVFVRVNUX0NBTkNFTCIsIlVTRVJTX01BTkFHRU1FTlQiLCJOT1RJRklDQVRJT05TX01BTkFHRU1FTlQiLCJHRVRfVVNFUlMiLCJSRVNPVVJDRVNfTUFOQUdFTUVOVCIsIkFDQ0VTU19BRE1JTl9QQUdFIiwiVVNFUl9ST0xFU19NQU5BR0VNRU5UIiwiQ0xJRU5UU19NQU5BR0VNRU5UIiwiSEVMUF9BUlRJQ0xFU19NQU5BR0VNRU5UIiwiU1RBUlRfV09SS0ZMT1ciXX0.AxppMpgTm9OD3kVyQ64kFNT-P5i7rRR-vDCDpP44FJ65deRfakrqCxzComzKBWNDmKLVHE7aP2WwTISXzEPJDg'

/organization/{orgCode}/user-routes

Parameter	Description
orgCode	Code of organization

Example response

HTTP/1.1 200 OK
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: POST, GET, PUT, OPTIONS, DELETE
Access-Control-Max-Age: 3600
Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Authorization
Content-Type: application/json;charset=UTF-8
Content-Length: 412

[ {
  "Id" : 5910974510923776,
  "Name" : "Directors",
  "Users" : [ {
    "Id" : 5066549580791808,
    "FirstName" : "Mr. someexistinguser",
    "Email" : "someexistinguser@gmail.com",
    "Active" : true,
    "Name" : "Mr. someexistinguser"
  } ],
  "Description" : "Directors approval route",
  "_Key" : "ahRzfmF2b2NhZG8tYmFja2VuZC12MXIyCxIMT3JnYW5pemF0aW9uIgpTT01FT1JHNDgyDAsSCVVzZXJSb3V0ZRiAgICAgIDACgw"
} ]

Path	Type	Description
[]	Object	listOf user routes
[].Name	String	User route name
[].Description	String	User route description
[].Users	Array	List of users in user route. Order of users in the list will be used in route

Get one user route

Returns one user route

Example request

GET /organization/someorg482/user-routes/5910974510923776 HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjU2Mjk0OTk1MzQyMTMxMjAsImV4cCI6MTUyODk2MDk1Niwicm9sZXMiOltdLCJkb21haW5BcHBSb2xlcyI6W10sInBlcm1pc3Npb25zIjpbIlJFVFJZX1dPUktGTE9XIiwiU1VQRVJBRE1JTiIsIkVSUk9SX01BTkFHRU1FTlQiLCJTVUJTQ1JJQkVSU19NQU5BR0VNRU5UIiwiQ1JFQVRFX1VTRVIiLCJFWEVDVVRFX0FDVElPTiIsIkNMSUVOVF9VU0VSU19NQU5BR0VNRU5UIiwiQVBQUk9WRV9DQU5DRUwiLCJSRVFVRVNUX0NBTkNFTCIsIlVTRVJTX01BTkFHRU1FTlQiLCJOT1RJRklDQVRJT05TX01BTkFHRU1FTlQiLCJHRVRfVVNFUlMiLCJSRVNPVVJDRVNfTUFOQUdFTUVOVCIsIkFDQ0VTU19BRE1JTl9QQUdFIiwiVVNFUl9ST0xFU19NQU5BR0VNRU5UIiwiQ0xJRU5UU19NQU5BR0VNRU5UIiwiSEVMUF9BUlRJQ0xFU19NQU5BR0VNRU5UIiwiU1RBUlRfV09SS0ZMT1ciXX0.AxppMpgTm9OD3kVyQ64kFNT-P5i7rRR-vDCDpP44FJ65deRfakrqCxzComzKBWNDmKLVHE7aP2WwTISXzEPJDg
Host: corporateservices.com

$ curl 'https://corporateservices.com:8080/organization/someorg482/user-routes/5910974510923776' -i -H 'Content-Type: application/json' -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjU2Mjk0OTk1MzQyMTMxMjAsImV4cCI6MTUyODk2MDk1Niwicm9sZXMiOltdLCJkb21haW5BcHBSb2xlcyI6W10sInBlcm1pc3Npb25zIjpbIlJFVFJZX1dPUktGTE9XIiwiU1VQRVJBRE1JTiIsIkVSUk9SX01BTkFHRU1FTlQiLCJTVUJTQ1JJQkVSU19NQU5BR0VNRU5UIiwiQ1JFQVRFX1VTRVIiLCJFWEVDVVRFX0FDVElPTiIsIkNMSUVOVF9VU0VSU19NQU5BR0VNRU5UIiwiQVBQUk9WRV9DQU5DRUwiLCJSRVFVRVNUX0NBTkNFTCIsIlVTRVJTX01BTkFHRU1FTlQiLCJOT1RJRklDQVRJT05TX01BTkFHRU1FTlQiLCJHRVRfVVNFUlMiLCJSRVNPVVJDRVNfTUFOQUdFTUVOVCIsIkFDQ0VTU19BRE1JTl9QQUdFIiwiVVNFUl9ST0xFU19NQU5BR0VNRU5UIiwiQ0xJRU5UU19NQU5BR0VNRU5UIiwiSEVMUF9BUlRJQ0xFU19NQU5BR0VNRU5UIiwiU1RBUlRfV09SS0ZMT1ciXX0.AxppMpgTm9OD3kVyQ64kFNT-P5i7rRR-vDCDpP44FJ65deRfakrqCxzComzKBWNDmKLVHE7aP2WwTISXzEPJDg'

/organization/{orgCode}/user-routes/{id}

Parameter	Description
orgCode	Code of organization
id	User route id

Example response

HTTP/1.1 200 OK
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: POST, GET, PUT, OPTIONS, DELETE
Access-Control-Max-Age: 3600
Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Authorization
Content-Type: application/json;charset=UTF-8
Content-Length: 408

{
  "Id" : 5910974510923776,
  "Name" : "Directors",
  "Users" : [ {
    "Id" : 5066549580791808,
    "FirstName" : "Mr. someexistinguser",
    "Email" : "someexistinguser@gmail.com",
    "Active" : true,
    "Name" : "Mr. someexistinguser"
  } ],
  "Description" : "Directors approval route",
  "_Key" : "ahRzfmF2b2NhZG8tYmFja2VuZC12MXIyCxIMT3JnYW5pemF0aW9uIgpTT01FT1JHNDgyDAsSCVVzZXJSb3V0ZRiAgICAgIDACgw"
}

Path	Type	Description
Id	Number	User route id
_Key	String	User route key as web safe string
Name	String	User route name
Description	String	User route description
Users	Array	List of users in user route. Order of users in the list will be used in route

Update User route

Update a User route

Example request

PUT /organization/someorg482/user-routes/5910974510923776 HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjU2Mjk0OTk1MzQyMTMxMjAsImV4cCI6MTUyODk2MDk1Niwicm9sZXMiOltdLCJkb21haW5BcHBSb2xlcyI6W10sInBlcm1pc3Npb25zIjpbIlJFVFJZX1dPUktGTE9XIiwiU1VQRVJBRE1JTiIsIkVSUk9SX01BTkFHRU1FTlQiLCJTVUJTQ1JJQkVSU19NQU5BR0VNRU5UIiwiQ1JFQVRFX1VTRVIiLCJFWEVDVVRFX0FDVElPTiIsIkNMSUVOVF9VU0VSU19NQU5BR0VNRU5UIiwiQVBQUk9WRV9DQU5DRUwiLCJSRVFVRVNUX0NBTkNFTCIsIlVTRVJTX01BTkFHRU1FTlQiLCJOT1RJRklDQVRJT05TX01BTkFHRU1FTlQiLCJHRVRfVVNFUlMiLCJSRVNPVVJDRVNfTUFOQUdFTUVOVCIsIkFDQ0VTU19BRE1JTl9QQUdFIiwiVVNFUl9ST0xFU19NQU5BR0VNRU5UIiwiQ0xJRU5UU19NQU5BR0VNRU5UIiwiSEVMUF9BUlRJQ0xFU19NQU5BR0VNRU5UIiwiU1RBUlRfV09SS0ZMT1ciXX0.AxppMpgTm9OD3kVyQ64kFNT-P5i7rRR-vDCDpP44FJ65deRfakrqCxzComzKBWNDmKLVHE7aP2WwTISXzEPJDg
Host: corporateservices.com
Content-Length: 161

{
  "Name" : "Directors",
  "Users" : [ {
    "Id" : 5066549580791808
  } ],
  "Team" : {
    "Code" : "TEAM"
  },
  "Description" : "Directors approval route"
}

$ curl 'https://corporateservices.com:8080/organization/someorg482/user-routes/5910974510923776' -i -X PUT -H 'Content-Type: application/json' -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjU2Mjk0OTk1MzQyMTMxMjAsImV4cCI6MTUyODk2MDk1Niwicm9sZXMiOltdLCJkb21haW5BcHBSb2xlcyI6W10sInBlcm1pc3Npb25zIjpbIlJFVFJZX1dPUktGTE9XIiwiU1VQRVJBRE1JTiIsIkVSUk9SX01BTkFHRU1FTlQiLCJTVUJTQ1JJQkVSU19NQU5BR0VNRU5UIiwiQ1JFQVRFX1VTRVIiLCJFWEVDVVRFX0FDVElPTiIsIkNMSUVOVF9VU0VSU19NQU5BR0VNRU5UIiwiQVBQUk9WRV9DQU5DRUwiLCJSRVFVRVNUX0NBTkNFTCIsIlVTRVJTX01BTkFHRU1FTlQiLCJOT1RJRklDQVRJT05TX01BTkFHRU1FTlQiLCJHRVRfVVNFUlMiLCJSRVNPVVJDRVNfTUFOQUdFTUVOVCIsIkFDQ0VTU19BRE1JTl9QQUdFIiwiVVNFUl9ST0xFU19NQU5BR0VNRU5UIiwiQ0xJRU5UU19NQU5BR0VNRU5UIiwiSEVMUF9BUlRJQ0xFU19NQU5BR0VNRU5UIiwiU1RBUlRfV09SS0ZMT1ciXX0.AxppMpgTm9OD3kVyQ64kFNT-P5i7rRR-vDCDpP44FJ65deRfakrqCxzComzKBWNDmKLVHE7aP2WwTISXzEPJDg' -d '{
  "Name" : "Directors",
  "Users" : [ {
    "Id" : 5066549580791808
  } ],
  "Team" : {
    "Code" : "TEAM"
  },
  "Description" : "Directors approval route"
}'

/organization/{orgCode}/user-routes/{id}

Parameter	Description
orgCode	Code of organization
id	User route id

Path	Type	Description
Name	String	User route name
Description	String	User route description
Users	Array	List of users in user route. Order of users in the list will be used in route. In case of using team based user routes, users should belong to the team.
Users.[0]	Object	User object
Users.[0].Id	Number	User id
Team	Object	Team resource to which user route should be assigned. If setting TEAM_BASED_USER_ROUTES is set to false will be ignored, should be provided otherwise.
Team.Code	String	Team code

Example response

HTTP/1.1 204 No Content
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: POST, GET, PUT, OPTIONS, DELETE
Access-Control-Max-Age: 3600
Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Authorization

Delete User route

Delete a User route

Example request

DELETE /organization/someorg482/user-routes/5910974510923776 HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjU2Mjk0OTk1MzQyMTMxMjAsImV4cCI6MTUyODk2MDk1Niwicm9sZXMiOltdLCJkb21haW5BcHBSb2xlcyI6W10sInBlcm1pc3Npb25zIjpbIlJFVFJZX1dPUktGTE9XIiwiU1VQRVJBRE1JTiIsIkVSUk9SX01BTkFHRU1FTlQiLCJTVUJTQ1JJQkVSU19NQU5BR0VNRU5UIiwiQ1JFQVRFX1VTRVIiLCJFWEVDVVRFX0FDVElPTiIsIkNMSUVOVF9VU0VSU19NQU5BR0VNRU5UIiwiQVBQUk9WRV9DQU5DRUwiLCJSRVFVRVNUX0NBTkNFTCIsIlVTRVJTX01BTkFHRU1FTlQiLCJOT1RJRklDQVRJT05TX01BTkFHRU1FTlQiLCJHRVRfVVNFUlMiLCJSRVNPVVJDRVNfTUFOQUdFTUVOVCIsIkFDQ0VTU19BRE1JTl9QQUdFIiwiVVNFUl9ST0xFU19NQU5BR0VNRU5UIiwiQ0xJRU5UU19NQU5BR0VNRU5UIiwiSEVMUF9BUlRJQ0xFU19NQU5BR0VNRU5UIiwiU1RBUlRfV09SS0ZMT1ciXX0.AxppMpgTm9OD3kVyQ64kFNT-P5i7rRR-vDCDpP44FJ65deRfakrqCxzComzKBWNDmKLVHE7aP2WwTISXzEPJDg
Host: corporateservices.com

$ curl 'https://corporateservices.com:8080/organization/someorg482/user-routes/5910974510923776' -i -X DELETE -H 'Content-Type: application/json' -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjU2Mjk0OTk1MzQyMTMxMjAsImV4cCI6MTUyODk2MDk1Niwicm9sZXMiOltdLCJkb21haW5BcHBSb2xlcyI6W10sInBlcm1pc3Npb25zIjpbIlJFVFJZX1dPUktGTE9XIiwiU1VQRVJBRE1JTiIsIkVSUk9SX01BTkFHRU1FTlQiLCJTVUJTQ1JJQkVSU19NQU5BR0VNRU5UIiwiQ1JFQVRFX1VTRVIiLCJFWEVDVVRFX0FDVElPTiIsIkNMSUVOVF9VU0VSU19NQU5BR0VNRU5UIiwiQVBQUk9WRV9DQU5DRUwiLCJSRVFVRVNUX0NBTkNFTCIsIlVTRVJTX01BTkFHRU1FTlQiLCJOT1RJRklDQVRJT05TX01BTkFHRU1FTlQiLCJHRVRfVVNFUlMiLCJSRVNPVVJDRVNfTUFOQUdFTUVOVCIsIkFDQ0VTU19BRE1JTl9QQUdFIiwiVVNFUl9ST0xFU19NQU5BR0VNRU5UIiwiQ0xJRU5UU19NQU5BR0VNRU5UIiwiSEVMUF9BUlRJQ0xFU19NQU5BR0VNRU5UIiwiU1RBUlRfV09SS0ZMT1ciXX0.AxppMpgTm9OD3kVyQ64kFNT-P5i7rRR-vDCDpP44FJ65deRfakrqCxzComzKBWNDmKLVHE7aP2WwTISXzEPJDg'

/organization/{orgCode}/user-routes/{id}

Parameter	Description
orgCode	Code of organization
id	User route id

Example response

HTTP/1.1 204 No Content
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: POST, GET, PUT, OPTIONS, DELETE
Access-Control-Max-Age: 3600
Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Authorization

Team Users

Get All Team Users

Return all the team users in a organization

Example request

GET /organization/SD/team-users HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjU2Mjk0OTk1MzQyMTMxMjAsImV4cCI6MTUyODk2MDk0OCwicm9sZXMiOltdLCJkb21haW5BcHBSb2xlcyI6W10sInBlcm1pc3Npb25zIjpbIlJFVFJZX1dPUktGTE9XIiwiU1VQRVJBRE1JTiIsIkVSUk9SX01BTkFHRU1FTlQiLCJTVUJTQ1JJQkVSU19NQU5BR0VNRU5UIiwiQ1JFQVRFX1VTRVIiLCJFWEVDVVRFX0FDVElPTiIsIkNMSUVOVF9VU0VSU19NQU5BR0VNRU5UIiwiQVBQUk9WRV9DQU5DRUwiLCJSRVFVRVNUX0NBTkNFTCIsIlVTRVJTX01BTkFHRU1FTlQiLCJOT1RJRklDQVRJT05TX01BTkFHRU1FTlQiLCJHRVRfVVNFUlMiLCJSRVNPVVJDRVNfTUFOQUdFTUVOVCIsIkFDQ0VTU19BRE1JTl9QQUdFIiwiVVNFUl9ST0xFU19NQU5BR0VNRU5UIiwiQ0xJRU5UU19NQU5BR0VNRU5UIiwiSEVMUF9BUlRJQ0xFU19NQU5BR0VNRU5UIiwiU1RBUlRfV09SS0ZMT1ciXX0.sn9tCX8FsZDrWnnlHDxpMUavlT_aycoie3R-j0MMdIySrMdFx6C9RZ5i9r1pPmRtcZd5MRb8e7MjpmFYrhQ4eQ
Host: corporateservices.com

$ curl 'https://corporateservices.com:8080/organization/SD/team-users' -i -H 'Content-Type: application/json' -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjU2Mjk0OTk1MzQyMTMxMjAsImV4cCI6MTUyODk2MDk0OCwicm9sZXMiOltdLCJkb21haW5BcHBSb2xlcyI6W10sInBlcm1pc3Npb25zIjpbIlJFVFJZX1dPUktGTE9XIiwiU1VQRVJBRE1JTiIsIkVSUk9SX01BTkFHRU1FTlQiLCJTVUJTQ1JJQkVSU19NQU5BR0VNRU5UIiwiQ1JFQVRFX1VTRVIiLCJFWEVDVVRFX0FDVElPTiIsIkNMSUVOVF9VU0VSU19NQU5BR0VNRU5UIiwiQVBQUk9WRV9DQU5DRUwiLCJSRVFVRVNUX0NBTkNFTCIsIlVTRVJTX01BTkFHRU1FTlQiLCJOT1RJRklDQVRJT05TX01BTkFHRU1FTlQiLCJHRVRfVVNFUlMiLCJSRVNPVVJDRVNfTUFOQUdFTUVOVCIsIkFDQ0VTU19BRE1JTl9QQUdFIiwiVVNFUl9ST0xFU19NQU5BR0VNRU5UIiwiQ0xJRU5UU19NQU5BR0VNRU5UIiwiSEVMUF9BUlRJQ0xFU19NQU5BR0VNRU5UIiwiU1RBUlRfV09SS0ZMT1ciXX0.sn9tCX8FsZDrWnnlHDxpMUavlT_aycoie3R-j0MMdIySrMdFx6C9RZ5i9r1pPmRtcZd5MRb8e7MjpmFYrhQ4eQ'

/organization/{organizationCode}/team-users

Parameter	Description
organizationCode	Organization code

Example response

HTTP/1.1 200 OK
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: POST, GET, PUT, OPTIONS, DELETE
Access-Control-Max-Age: 3600
Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Authorization
Content-Type: application/json;charset=UTF-8
Content-Length: 4268

[ {
  "Id" : 4661929301770240,
  "User" : {
    "Id" : 5207287069147136,
    "FirstName" : "Frank",
    "LastName" : "Manager",
    "Email" : "AWIExecmanagement@gmail.com",
    "Active" : true,
    "Name" : "Frank Manager"
  },
  "Role" : {
    "Id" : "MANAGER",
    "Type" : "TEAM_ROLE",
    "Permissions" : [ "START_WORKFLOW", "EXECUTE_ACTION", "REQUEST_CANCEL", "RETRY_WORKFLOW" ],
    "Code" : "MANAGER",
    "Name" : "Manager"
  },
  "Team" : {
    "Id" : "TEAMBIG",
    "Name" : "Team Big",
    "Code" : "TeamBig"
  }
}, {
  "Id" : 4802666790125568,
  "User" : {
    "Id" : 5348024557502464,
    "FirstName" : "Betty",
    "LastName" : "Analyst",
    "Email" : "AWIRegCorpSec@gmail.com",
    "Active" : true,
    "Name" : "Betty Analyst"
  },
  "Role" : {
    "Id" : "ANALYST",
    "Type" : "TEAM_ROLE",
    "Permissions" : [ "START_WORKFLOW", "EXECUTE_ACTION", "REQUEST_CANCEL", "RETRY_WORKFLOW", "PAYMENTS_MANAGEMENT" ],
    "Code" : "ANALYST",
    "Name" : "Analyst"
  },
  "Team" : {
    "Id" : "TEAMBIG",
    "Name" : "Team Big",
    "Code" : "TeamBig"
  }
}, {
  "Id" : 5928566696968192,
  "User" : {
    "Id" : 6473924464345088,
    "FirstName" : "Charles",
    "LastName" : "Analyst",
    "Email" : "AWISrCorpSec@gmail.com",
    "Active" : true,
    "Name" : "Charles Analyst"
  },
  "Role" : {
    "Id" : "ANALYST",
    "Type" : "TEAM_ROLE",
    "Permissions" : [ "START_WORKFLOW", "EXECUTE_ACTION", "REQUEST_CANCEL", "RETRY_WORKFLOW", "PAYMENTS_MANAGEMENT" ],
    "Code" : "ANALYST",
    "Name" : "Analyst"
  },
  "Team" : {
    "Id" : "TEAMBIG",
    "Name" : "Team Big",
    "Code" : "TeamBig"
  }
}, {
  "Id" : 6491516650389504,
  "User" : {
    "Id" : 5770237022568448,
    "FirstName" : "Elizabeth",
    "LastName" : "Manager",
    "Email" : "AWIKYC@gmail.com",
    "Active" : true,
    "Name" : "Elizabeth Manager"
  },
  "Role" : {
    "Id" : "MANAGER",
    "Type" : "TEAM_ROLE",
    "Permissions" : [ "START_WORKFLOW", "EXECUTE_ACTION", "REQUEST_CANCEL", "RETRY_WORKFLOW" ],
    "Code" : "MANAGER",
    "Name" : "Manager"
  },
  "Team" : {
    "Id" : "TEAMBIG",
    "Name" : "Team Big",
    "Code" : "TeamBig"
  }
}, {
  "Id" : 5084141766836224,
  "User" : {
    "Id" : 5910974510923776,
    "FirstName" : "Adam",
    "LastName" : "Analyst",
    "Email" : "AWIJRCorpSec@gmail.com",
    "Active" : true,
    "Name" : "Adam Analyst"
  },
  "Role" : {
    "Id" : "ANALYST",
    "Type" : "TEAM_ROLE",
    "Permissions" : [ "START_WORKFLOW", "EXECUTE_ACTION", "REQUEST_CANCEL", "RETRY_WORKFLOW", "PAYMENTS_MANAGEMENT" ],
    "Code" : "ANALYST",
    "Name" : "Analyst"
  },
  "Team" : {
    "Id" : "TEAMSMALL",
    "Name" : "Team Small",
    "Code" : "TeamSmall"
  }
}, {
  "Id" : 5365616743546880,
  "User" : {
    "Id" : 4644337115725824,
    "FirstName" : "David",
    "LastName" : "Manager",
    "Email" : "AWITeamManager@gmail.com",
    "Active" : true,
    "Name" : "David Manager"
  },
  "Role" : {
    "Id" : "MANAGER",
    "Type" : "TEAM_ROLE",
    "Permissions" : [ "START_WORKFLOW", "EXECUTE_ACTION", "REQUEST_CANCEL", "RETRY_WORKFLOW" ],
    "Code" : "MANAGER",
    "Name" : "Manager"
  },
  "Team" : {
    "Id" : "TEAMSMALL",
    "Name" : "Team Small",
    "Code" : "TeamSmall"
  }
}, {
  "Id" : 5787829208612864,
  "User" : {
    "Id" : 6333186975989760,
    "FirstName" : "George",
    "LastName" : "Director",
    "Email" : "mthawani@gmail.com",
    "Active" : true,
    "Name" : "George Director"
  },
  "Role" : {
    "Id" : "DIRECTOR",
    "Type" : "TEAM_ROLE",
    "Permissions" : [ "START_WORKFLOW", "EXECUTE_ACTION", "REQUEST_CANCEL", "RETRY_WORKFLOW" ],
    "Code" : "DIRECTOR",
    "Name" : "Director"
  },
  "Team" : {
    "Id" : "TEAMSMALL",
    "Name" : "Team Small",
    "Code" : "TeamSmall"
  }
}, {
  "Id" : 6210041673678848,
  "User" : {
    "Id" : 5910974510923776,
    "FirstName" : "Adam",
    "LastName" : "Analyst",
    "Email" : "AWIJRCorpSec@gmail.com",
    "Active" : true,
    "Name" : "Adam Analyst"
  },
  "Role" : {
    "Id" : "SUPPORT",
    "Type" : "TEAM_ROLE",
    "Permissions" : [ "START_WORKFLOW", "EXECUTE_ACTION", "REQUEST_CANCEL", "RETRY_WORKFLOW" ],
    "Code" : "SUPPORT",
    "Name" : "Support"
  },
  "Team" : {
    "Id" : "TEAMSMALL",
    "Name" : "Team Small",
    "Code" : "TeamSmall"
  }
} ]

Path	Type	Description
[]	Array	List of Team Users
[].Id	Number	ID of the Team User
[].Role	Object	Name of the resource
[].User	Object	URL of the resource
[].Team	Object	Description

Create team user

Assign a role to an user in team

Example request

POST /organization/SD/team/TEAMSMALL/team-users HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjU2Mjk0OTk1MzQyMTMxMjAsImV4cCI6MTUyODk2MDk1MSwicm9sZXMiOltdLCJkb21haW5BcHBSb2xlcyI6W10sInBlcm1pc3Npb25zIjpbIlJFVFJZX1dPUktGTE9XIiwiU1VQRVJBRE1JTiIsIkVSUk9SX01BTkFHRU1FTlQiLCJTVUJTQ1JJQkVSU19NQU5BR0VNRU5UIiwiQ1JFQVRFX1VTRVIiLCJFWEVDVVRFX0FDVElPTiIsIkNMSUVOVF9VU0VSU19NQU5BR0VNRU5UIiwiQVBQUk9WRV9DQU5DRUwiLCJSRVFVRVNUX0NBTkNFTCIsIlVTRVJTX01BTkFHRU1FTlQiLCJOT1RJRklDQVRJT05TX01BTkFHRU1FTlQiLCJHRVRfVVNFUlMiLCJSRVNPVVJDRVNfTUFOQUdFTUVOVCIsIkFDQ0VTU19BRE1JTl9QQUdFIiwiVVNFUl9ST0xFU19NQU5BR0VNRU5UIiwiQ0xJRU5UU19NQU5BR0VNRU5UIiwiSEVMUF9BUlRJQ0xFU19NQU5BR0VNRU5UIiwiU1RBUlRfV09SS0ZMT1ciXX0.g_9T292HAegq1mZlMWLnbcoXAtGyOCIlOgriiEypsAYNzJ90S-ETxJPJJoN6DPu6rloDFqDdv6NwGWJ2SFpoJg
Host: corporateservices.com
Content-Length: 393

{
  "User" : {
    "Id" : 5910974510923776,
    "FirstName" : "Adam",
    "LastName" : "Analyst",
    "Email" : "AWIJRCorpSec@gmail.com",
    "Password" : "$2a$10$7RS3KlczEHwFS4Bc8ekXRuHW/OMjaGiYkaS1XgHOHGB9Mj2FuYHZq",
    "Active" : true,
    "EmailVerified" : true,
    "Name" : "Adam Analyst",
    "CreatedOn" : "2018-05-15T10:22:30.573+03:00"
  },
  "Role" : {
    "Code" : "MANAGER"
  }
}

$ curl 'https://corporateservices.com:8080/organization/SD/team/TEAMSMALL/team-users' -i -X POST -H 'Content-Type: application/json' -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjU2Mjk0OTk1MzQyMTMxMjAsImV4cCI6MTUyODk2MDk1MSwicm9sZXMiOltdLCJkb21haW5BcHBSb2xlcyI6W10sInBlcm1pc3Npb25zIjpbIlJFVFJZX1dPUktGTE9XIiwiU1VQRVJBRE1JTiIsIkVSUk9SX01BTkFHRU1FTlQiLCJTVUJTQ1JJQkVSU19NQU5BR0VNRU5UIiwiQ1JFQVRFX1VTRVIiLCJFWEVDVVRFX0FDVElPTiIsIkNMSUVOVF9VU0VSU19NQU5BR0VNRU5UIiwiQVBQUk9WRV9DQU5DRUwiLCJSRVFVRVNUX0NBTkNFTCIsIlVTRVJTX01BTkFHRU1FTlQiLCJOT1RJRklDQVRJT05TX01BTkFHRU1FTlQiLCJHRVRfVVNFUlMiLCJSRVNPVVJDRVNfTUFOQUdFTUVOVCIsIkFDQ0VTU19BRE1JTl9QQUdFIiwiVVNFUl9ST0xFU19NQU5BR0VNRU5UIiwiQ0xJRU5UU19NQU5BR0VNRU5UIiwiSEVMUF9BUlRJQ0xFU19NQU5BR0VNRU5UIiwiU1RBUlRfV09SS0ZMT1ciXX0.g_9T292HAegq1mZlMWLnbcoXAtGyOCIlOgriiEypsAYNzJ90S-ETxJPJJoN6DPu6rloDFqDdv6NwGWJ2SFpoJg' -d '{
  "User" : {
    "Id" : 5910974510923776,
    "FirstName" : "Adam",
    "LastName" : "Analyst",
    "Email" : "AWIJRCorpSec@gmail.com",
    "Password" : "$2a$10$7RS3KlczEHwFS4Bc8ekXRuHW/OMjaGiYkaS1XgHOHGB9Mj2FuYHZq",
    "Active" : true,
    "EmailVerified" : true,
    "Name" : "Adam Analyst",
    "CreatedOn" : "2018-05-15T10:22:30.573+03:00"
  },
  "Role" : {
    "Code" : "MANAGER"
  }
}'

/organization/{organizationCode}/team/{teamId}/team-users

Parameter	Description
organizationCode	Organization code
teamId	ID of the team

Path	Type	Description
Role	Object	New role to be assigned
User	Object	User details

Example response

HTTP/1.1 201 Created
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: POST, GET, PUT, OPTIONS, DELETE
Access-Control-Max-Age: 3600
Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Authorization
Content-Type: application/json;charset=UTF-8
Content-Length: 464

{
  "Id" : 5506354231902208,
  "User" : {
    "Id" : 5910974510923776,
    "FirstName" : "Adam",
    "LastName" : "Analyst",
    "Email" : "AWIJRCorpSec@gmail.com",
    "Password" : "$2a$10$7RS3KlczEHwFS4Bc8ekXRuHW/OMjaGiYkaS1XgHOHGB9Mj2FuYHZq",
    "Active" : true,
    "EmailVerified" : true,
    "Name" : "Adam Analyst",
    "CreatedOn" : "2018-05-15T07:22:30.573Z"
  },
  "Role" : {
    "Code" : "MANAGER"
  },
  "CreatedOn" : "2018-05-15T10:22:31.862+03:00"
}

Path	Type	Description
Id	Number	ID of the Team User
Role	Object	Name of the resource
User	Object	URL of the resource
CreatedOn	Object	Created Date

Update team user

Update the role assigned to a user in the team

Example request

PUT /organization/SD/team/TEAMBIG/team-users/4661929301770240 HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjU2Mjk0OTk1MzQyMTMxMjAsImV4cCI6MTUyODk2MDk1MCwicm9sZXMiOltdLCJkb21haW5BcHBSb2xlcyI6W10sInBlcm1pc3Npb25zIjpbIlJFVFJZX1dPUktGTE9XIiwiU1VQRVJBRE1JTiIsIkVSUk9SX01BTkFHRU1FTlQiLCJTVUJTQ1JJQkVSU19NQU5BR0VNRU5UIiwiQ1JFQVRFX1VTRVIiLCJFWEVDVVRFX0FDVElPTiIsIkNMSUVOVF9VU0VSU19NQU5BR0VNRU5UIiwiQVBQUk9WRV9DQU5DRUwiLCJSRVFVRVNUX0NBTkNFTCIsIlVTRVJTX01BTkFHRU1FTlQiLCJOT1RJRklDQVRJT05TX01BTkFHRU1FTlQiLCJHRVRfVVNFUlMiLCJSRVNPVVJDRVNfTUFOQUdFTUVOVCIsIkFDQ0VTU19BRE1JTl9QQUdFIiwiVVNFUl9ST0xFU19NQU5BR0VNRU5UIiwiQ0xJRU5UU19NQU5BR0VNRU5UIiwiSEVMUF9BUlRJQ0xFU19NQU5BR0VNRU5UIiwiU1RBUlRfV09SS0ZMT1ciXX0.gshK8c4-3pm2rwKscbEubbfGQ3NXM_WfJDf7uaTYVMFbYd-ipXIkbMKYI_ji49HRQVENF_2RDZTtwV4mb1FdMA
Host: corporateservices.com
Content-Length: 44

{
  "Role" : {
    "Code" : "DIRECTOR"
  }
}

$ curl 'https://corporateservices.com:8080/organization/SD/team/TEAMBIG/team-users/4661929301770240' -i -X PUT -H 'Content-Type: application/json' -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjU2Mjk0OTk1MzQyMTMxMjAsImV4cCI6MTUyODk2MDk1MCwicm9sZXMiOltdLCJkb21haW5BcHBSb2xlcyI6W10sInBlcm1pc3Npb25zIjpbIlJFVFJZX1dPUktGTE9XIiwiU1VQRVJBRE1JTiIsIkVSUk9SX01BTkFHRU1FTlQiLCJTVUJTQ1JJQkVSU19NQU5BR0VNRU5UIiwiQ1JFQVRFX1VTRVIiLCJFWEVDVVRFX0FDVElPTiIsIkNMSUVOVF9VU0VSU19NQU5BR0VNRU5UIiwiQVBQUk9WRV9DQU5DRUwiLCJSRVFVRVNUX0NBTkNFTCIsIlVTRVJTX01BTkFHRU1FTlQiLCJOT1RJRklDQVRJT05TX01BTkFHRU1FTlQiLCJHRVRfVVNFUlMiLCJSRVNPVVJDRVNfTUFOQUdFTUVOVCIsIkFDQ0VTU19BRE1JTl9QQUdFIiwiVVNFUl9ST0xFU19NQU5BR0VNRU5UIiwiQ0xJRU5UU19NQU5BR0VNRU5UIiwiSEVMUF9BUlRJQ0xFU19NQU5BR0VNRU5UIiwiU1RBUlRfV09SS0ZMT1ciXX0.gshK8c4-3pm2rwKscbEubbfGQ3NXM_WfJDf7uaTYVMFbYd-ipXIkbMKYI_ji49HRQVENF_2RDZTtwV4mb1FdMA' -d '{
  "Role" : {
    "Code" : "DIRECTOR"
  }
}'

/organization/{organizationCode}/team/{teamId}/team-users/{teamUserId}

Parameter	Description
organizationCode	Organization code
teamId	ID of the team
teamUserId	ID of the team user

Path	Type	Description
Role	Object	New role to be assigned

Example response

HTTP/1.1 200 OK
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: POST, GET, PUT, OPTIONS, DELETE
Access-Control-Max-Age: 3600
Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Authorization
Content-Type: application/json;charset=UTF-8
Content-Length: 526

{
  "Id" : 4661929301770240,
  "User" : {
    "Id" : 5207287069147136,
    "FirstName" : "Frank",
    "LastName" : "Manager",
    "Email" : "AWIExecmanagement@gmail.com",
    "Active" : true,
    "Name" : "Frank Manager"
  },
  "Role" : {
    "Id" : "DIRECTOR",
    "Type" : "TEAM_ROLE",
    "Permissions" : [ "START_WORKFLOW", "EXECUTE_ACTION", "REQUEST_CANCEL", "RETRY_WORKFLOW" ],
    "Code" : "DIRECTOR",
    "Name" : "Director"
  },
  "Team" : {
    "Id" : "TEAMBIG",
    "Name" : "Team Big",
    "Code" : "TeamBig"
  }
}

Path	Type	Description
Id	Number	ID of the Team User
Role	Object	Name of the resource
User	Object	URL of the resource
Team	Object	Description

Client

Get all Clients for whom the logged in user can start the given workflow

Return all Clients for whom the logged in user can start the given workflow

Example request

/organization/{organizationCode}/clients/my

Parameter	Description
organizationCode	Organization code

Parameter	Description
key	Workflow key

GET /organization/SD/clients/my?key=ahRzfmF2b2NhZG8tYmFja2VuZC12MXI6CxIMT3JnYW5pemF0aW9uIgNTR1AMCxIIV29ya2Zsb3ciF0NIQU5HRS1BRERSRVNTLVdPUktGTE9XDA HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjU5MTA5NzQ1MTA5MjM3NzYsImV4cCI6MTUyODk2MDk1Mywib3JnQ29kZSI6IlNEIiwicm9sZXMiOlsiYWRtaW5pc3RyYXRvciJdLCJkb21haW5BcHBSb2xlcyI6WyJBTkFMWVNUIiwiU1VQUE9SVCJdLCJwZXJtaXNzaW9ucyI6WyJSRVRSWV9XT1JLRkxPVyIsIlJPTEVfYWRtaW5pc3RyYXRvciIsIkVSUk9SX01BTkFHRU1FTlQiLCJTVUJTQ1JJQkVSU19NQU5BR0VNRU5UIiwiQ1JFQVRFX1VTRVIiLCJFWEVDVVRFX0FDVElPTiIsIkNMSUVOVF9VU0VSU19NQU5BR0VNRU5UIiwiQVBQUk9WRV9DQU5DRUwiLCJSRVFVRVNUX0NBTkNFTCIsIlVTRVJTX01BTkFHRU1FTlQiLCJOT1RJRklDQVRJT05TX01BTkFHRU1FTlQiLCJQQVlNRU5UU19NQU5BR0VNRU5UIiwiR0VUX1VTRVJTIiwiUkVTT1VSQ0VTX01BTkFHRU1FTlQiLCJBQ0NFU1NfQURNSU5fUEFHRSIsIlVTRVJfUk9MRVNfTUFOQUdFTUVOVCIsIkNMSUVOVFNfTUFOQUdFTUVOVCIsIkhFTFBfQVJUSUNMRVNfTUFOQUdFTUVOVCIsIlNUQVJUX1dPUktGTE9XIl19.SY_f0DAcVjI-JzU1nZCnMwcu5u3wZ5qbFVeuesfm3HLTTIec8FqUQ-hBx-DYQ4dx-fuWguu6djmPTGlWwYgQdg
Host: corporateservices.com

$ curl 'https://corporateservices.com:8080/organization/SD/clients/my?key=ahRzfmF2b2NhZG8tYmFja2VuZC12MXI6CxIMT3JnYW5pemF0aW9uIgNTR1AMCxIIV29ya2Zsb3ciF0NIQU5HRS1BRERSRVNTLVdPUktGTE9XDA' -i -H 'Content-Type: application/json' -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjU5MTA5NzQ1MTA5MjM3NzYsImV4cCI6MTUyODk2MDk1Mywib3JnQ29kZSI6IlNEIiwicm9sZXMiOlsiYWRtaW5pc3RyYXRvciJdLCJkb21haW5BcHBSb2xlcyI6WyJBTkFMWVNUIiwiU1VQUE9SVCJdLCJwZXJtaXNzaW9ucyI6WyJSRVRSWV9XT1JLRkxPVyIsIlJPTEVfYWRtaW5pc3RyYXRvciIsIkVSUk9SX01BTkFHRU1FTlQiLCJTVUJTQ1JJQkVSU19NQU5BR0VNRU5UIiwiQ1JFQVRFX1VTRVIiLCJFWEVDVVRFX0FDVElPTiIsIkNMSUVOVF9VU0VSU19NQU5BR0VNRU5UIiwiQVBQUk9WRV9DQU5DRUwiLCJSRVFVRVNUX0NBTkNFTCIsIlVTRVJTX01BTkFHRU1FTlQiLCJOT1RJRklDQVRJT05TX01BTkFHRU1FTlQiLCJQQVlNRU5UU19NQU5BR0VNRU5UIiwiR0VUX1VTRVJTIiwiUkVTT1VSQ0VTX01BTkFHRU1FTlQiLCJBQ0NFU1NfQURNSU5fUEFHRSIsIlVTRVJfUk9MRVNfTUFOQUdFTUVOVCIsIkNMSUVOVFNfTUFOQUdFTUVOVCIsIkhFTFBfQVJUSUNMRVNfTUFOQUdFTUVOVCIsIlNUQVJUX1dPUktGTE9XIl19.SY_f0DAcVjI-JzU1nZCnMwcu5u3wZ5qbFVeuesfm3HLTTIec8FqUQ-hBx-DYQ4dx-fuWguu6djmPTGlWwYgQdg'

Example response

HTTP/1.1 200 OK
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: POST, GET, PUT, OPTIONS, DELETE
Access-Control-Max-Age: 3600
Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Authorization
Content-Type: application/json;charset=UTF-8
Content-Length: 407

[ {
  "CreatedOn" : "2018-05-15T10:22:33.354+03:00",
  "Id" : 5031365208702976,
  "Name" : "New Startup",
  "Code" : "NEW_STARTUP",
  "Email" : "sd_new_startup@gmail.com",
  "Status" : {
    "Id" : "ACTIVE",
    "Code" : "ACTIVE",
    "Description" : "Active customer",
    "Name" : "Active customer"
  },
  "_Key" : "ahRzfmF2b2NhZG8tYmFja2VuZC12MXInCxIMT3JnYW5pemF0aW9uIgJTRAwLEgZDbGllbnQYgICAgICA-AgM"
} ]

Path	Type	Description
[]	Array	An array of applicable clients
[].Id	Number	ID of the client
[].Name	String	Name of the client
[].Code	String	Code
[].Email	String	email
[]._Key	String	Key

Dynamic Entities

Delete a dynamic entity record

Example request

/v1/organization/{organizationCode}/domain-model/{domainModelCode}/domain-entity/{domainEntityCode}/entities/{key}

Parameter	Description
organizationCode	Organization code
domainModelCode	Domain Model code
domainEntityCode	Domain Entity code
key	Key of the dynamic Entity that needs to be deleted

DELETE /v1/organization/SGP/domain-model/SGCS/domain-entity/agent/entities/ahRzfmF2b2NhZG8tYmFja2VuZC12MXIuCxIMT3JnYW5pemF0aW9uIghTVUJTLU9SRwwLEg5TR1AuU0dDUy5BR0VOVBgEDA HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjU2Mjk0OTk1MzQyMTMxMjAsImV4cCI6MTUyODk2MDk0MSwicm9sZXMiOltdLCJkb21haW5BcHBSb2xlcyI6W10sInBlcm1pc3Npb25zIjpbIlJFVFJZX1dPUktGTE9XIiwiU1VQRVJBRE1JTiIsIkVSUk9SX01BTkFHRU1FTlQiLCJTVUJTQ1JJQkVSU19NQU5BR0VNRU5UIiwiQ1JFQVRFX1VTRVIiLCJFWEVDVVRFX0FDVElPTiIsIkNMSUVOVF9VU0VSU19NQU5BR0VNRU5UIiwiQVBQUk9WRV9DQU5DRUwiLCJSRVFVRVNUX0NBTkNFTCIsIlVTRVJTX01BTkFHRU1FTlQiLCJOT1RJRklDQVRJT05TX01BTkFHRU1FTlQiLCJHRVRfVVNFUlMiLCJSRVNPVVJDRVNfTUFOQUdFTUVOVCIsIkFDQ0VTU19BRE1JTl9QQUdFIiwiVVNFUl9ST0xFU19NQU5BR0VNRU5UIiwiQ0xJRU5UU19NQU5BR0VNRU5UIiwiSEVMUF9BUlRJQ0xFU19NQU5BR0VNRU5UIiwiU1RBUlRfV09SS0ZMT1ciXX0.Xqh5tI4zkjZAGMPBCvQjZ2iPvCgee8oabNTt5c1ATWeC-mqt3NOfbn7dIHMoRnp6QFJaHuG_vIePJiZ0xe9RfQ
Host: corporateservices.com

$ curl 'https://corporateservices.com:8080/v1/organization/SGP/domain-model/SGCS/domain-entity/agent/entities/ahRzfmF2b2NhZG8tYmFja2VuZC12MXIuCxIMT3JnYW5pemF0aW9uIghTVUJTLU9SRwwLEg5TR1AuU0dDUy5BR0VOVBgEDA' -i -X DELETE -H 'Content-Type: application/json' -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjU2Mjk0OTk1MzQyMTMxMjAsImV4cCI6MTUyODk2MDk0MSwicm9sZXMiOltdLCJkb21haW5BcHBSb2xlcyI6W10sInBlcm1pc3Npb25zIjpbIlJFVFJZX1dPUktGTE9XIiwiU1VQRVJBRE1JTiIsIkVSUk9SX01BTkFHRU1FTlQiLCJTVUJTQ1JJQkVSU19NQU5BR0VNRU5UIiwiQ1JFQVRFX1VTRVIiLCJFWEVDVVRFX0FDVElPTiIsIkNMSUVOVF9VU0VSU19NQU5BR0VNRU5UIiwiQVBQUk9WRV9DQU5DRUwiLCJSRVFVRVNUX0NBTkNFTCIsIlVTRVJTX01BTkFHRU1FTlQiLCJOT1RJRklDQVRJT05TX01BTkFHRU1FTlQiLCJHRVRfVVNFUlMiLCJSRVNPVVJDRVNfTUFOQUdFTUVOVCIsIkFDQ0VTU19BRE1JTl9QQUdFIiwiVVNFUl9ST0xFU19NQU5BR0VNRU5UIiwiQ0xJRU5UU19NQU5BR0VNRU5UIiwiSEVMUF9BUlRJQ0xFU19NQU5BR0VNRU5UIiwiU1RBUlRfV09SS0ZMT1ciXX0.Xqh5tI4zkjZAGMPBCvQjZ2iPvCgee8oabNTt5c1ATWeC-mqt3NOfbn7dIHMoRnp6QFJaHuG_vIePJiZ0xe9RfQ'

Example response

HTTP/1.1 204 No Content
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: POST, GET, PUT, OPTIONS, DELETE
Access-Control-Max-Age: 3600
Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Authorization

Delete mulitple dynamic entity records

Example request

/v1/organization/{organizationCode}/domain-model/{domainModelCode}/domain-entity/{domainEntityCode}/entities

Parameter	Description
organizationCode	Organization code
domainModelCode	Domain Model code
domainEntityCode	Domain Entity code

Path	Type	Description
[]	Array	Arrays of keys that need to be deleted
[]._Key	String	Key of the dynamic Entity that needs to be deleted

DELETE /v1/organization/SGP/domain-model/SGCS/domain-entity/agent/entities HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjU2Mjk0OTk1MzQyMTMxMjAsImV4cCI6MTUyODk2MDk0MCwicm9sZXMiOltdLCJkb21haW5BcHBSb2xlcyI6W10sInBlcm1pc3Npb25zIjpbIlJFVFJZX1dPUktGTE9XIiwiU1VQRVJBRE1JTiIsIkVSUk9SX01BTkFHRU1FTlQiLCJTVUJTQ1JJQkVSU19NQU5BR0VNRU5UIiwiQ1JFQVRFX1VTRVIiLCJFWEVDVVRFX0FDVElPTiIsIkNMSUVOVF9VU0VSU19NQU5BR0VNRU5UIiwiQVBQUk9WRV9DQU5DRUwiLCJSRVFVRVNUX0NBTkNFTCIsIlVTRVJTX01BTkFHRU1FTlQiLCJOT1RJRklDQVRJT05TX01BTkFHRU1FTlQiLCJHRVRfVVNFUlMiLCJSRVNPVVJDRVNfTUFOQUdFTUVOVCIsIkFDQ0VTU19BRE1JTl9QQUdFIiwiVVNFUl9ST0xFU19NQU5BR0VNRU5UIiwiQ0xJRU5UU19NQU5BR0VNRU5UIiwiSEVMUF9BUlRJQ0xFU19NQU5BR0VNRU5UIiwiU1RBUlRfV09SS0ZMT1ciXX0.QMUfiL_84SzkOq2sgfM36tM1Wxi1m3uDQLAdGKWl7DbeD6aZI0D8LIUeafQFMB0mywXMA5Fvpz760MLrmc54DA
Host: corporateservices.com
Content-Length: 221

[   {       "_Key":"ahRzfmF2b2NhZG8tYmFja2VuZC12MXIuCxIMT3JnYW5pemF0aW9uIghTVUJTLU9SRwwLEg5TR1AuU0dDUy5BR0VOVBgEDA" },  {       "_Key":"ahRzfmF2b2NhZG8tYmFja2VuZC12MXIuCxIMT3JnYW5pemF0aW9uIghTVUJTLU9SRwwLEg5TR1AuU0dDUy5BR0VOVBgFDA" }]

$ curl 'https://corporateservices.com:8080/v1/organization/SGP/domain-model/SGCS/domain-entity/agent/entities' -i -X DELETE -H 'Content-Type: application/json' -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjU2Mjk0OTk1MzQyMTMxMjAsImV4cCI6MTUyODk2MDk0MCwicm9sZXMiOltdLCJkb21haW5BcHBSb2xlcyI6W10sInBlcm1pc3Npb25zIjpbIlJFVFJZX1dPUktGTE9XIiwiU1VQRVJBRE1JTiIsIkVSUk9SX01BTkFHRU1FTlQiLCJTVUJTQ1JJQkVSU19NQU5BR0VNRU5UIiwiQ1JFQVRFX1VTRVIiLCJFWEVDVVRFX0FDVElPTiIsIkNMSUVOVF9VU0VSU19NQU5BR0VNRU5UIiwiQVBQUk9WRV9DQU5DRUwiLCJSRVFVRVNUX0NBTkNFTCIsIlVTRVJTX01BTkFHRU1FTlQiLCJOT1RJRklDQVRJT05TX01BTkFHRU1FTlQiLCJHRVRfVVNFUlMiLCJSRVNPVVJDRVNfTUFOQUdFTUVOVCIsIkFDQ0VTU19BRE1JTl9QQUdFIiwiVVNFUl9ST0xFU19NQU5BR0VNRU5UIiwiQ0xJRU5UU19NQU5BR0VNRU5UIiwiSEVMUF9BUlRJQ0xFU19NQU5BR0VNRU5UIiwiU1RBUlRfV09SS0ZMT1ciXX0.QMUfiL_84SzkOq2sgfM36tM1Wxi1m3uDQLAdGKWl7DbeD6aZI0D8LIUeafQFMB0mywXMA5Fvpz760MLrmc54DA' -d '[    {       "_Key":"ahRzfmF2b2NhZG8tYmFja2VuZC12MXIuCxIMT3JnYW5pemF0aW9uIghTVUJTLU9SRwwLEg5TR1AuU0dDUy5BR0VOVBgEDA" },  {       "_Key":"ahRzfmF2b2NhZG8tYmFja2VuZC12MXIuCxIMT3JnYW5pemF0aW9uIghTVUJTLU9SRwwLEg5TR1AuU0dDUy5BR0VOVBgFDA" }]'

Example response

HTTP/1.1 204 No Content
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: POST, GET, PUT, OPTIONS, DELETE
Access-Control-Max-Age: 3600
Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Authorization

Notifications

Create

Example request

POST /organization/SD/notifications HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjU5MTA5NzQ1MTA5MjM3NzYsImV4cCI6MTUyODk2MDkyNiwib3JnQ29kZSI6IlNEIiwicm9sZXMiOlsiYWRtaW5pc3RyYXRvciJdLCJkb21haW5BcHBSb2xlcyI6WyJBTkFMWVNUIiwiU1VQUE9SVCJdLCJwZXJtaXNzaW9ucyI6WyJSRVRSWV9XT1JLRkxPVyIsIlJPTEVfYWRtaW5pc3RyYXRvciIsIkVSUk9SX01BTkFHRU1FTlQiLCJTVUJTQ1JJQkVSU19NQU5BR0VNRU5UIiwiQ1JFQVRFX1VTRVIiLCJFWEVDVVRFX0FDVElPTiIsIkNMSUVOVF9VU0VSU19NQU5BR0VNRU5UIiwiQVBQUk9WRV9DQU5DRUwiLCJSRVFVRVNUX0NBTkNFTCIsIlVTRVJTX01BTkFHRU1FTlQiLCJOT1RJRklDQVRJT05TX01BTkFHRU1FTlQiLCJQQVlNRU5UU19NQU5BR0VNRU5UIiwiR0VUX1VTRVJTIiwiUkVTT1VSQ0VTX01BTkFHRU1FTlQiLCJBQ0NFU1NfQURNSU5fUEFHRSIsIlVTRVJfUk9MRVNfTUFOQUdFTUVOVCIsIkNMSUVOVFNfTUFOQUdFTUVOVCIsIkhFTFBfQVJUSUNMRVNfTUFOQUdFTUVOVCIsIlNUQVJUX1dPUktGTE9XIl19.QoNq3xhyPGpOdihPOe8LFMNE1QFk3gX-uwYH-q0MoBTkDW4iIzQRA2WbJic8TQqGHW--YLx9RN6LE7kyA6mG2w
Host: corporateservices.com
Content-Length: 213

{
  "ValidFrom" : "2018-05-10T07:30:45.555Z",
  "ValidUntil" : "2018-05-20T07:30:45.555Z",
  "Title" : "System shutdown",
  "Body" : "system shutdown for next 6 hours",
  "Roles" : [ {
    "Id" : "ANALYST"
  } ]
}

$ curl 'https://corporateservices.com:8080/organization/SD/notifications' -i -X POST -H 'Content-Type: application/json' -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjU5MTA5NzQ1MTA5MjM3NzYsImV4cCI6MTUyODk2MDkyNiwib3JnQ29kZSI6IlNEIiwicm9sZXMiOlsiYWRtaW5pc3RyYXRvciJdLCJkb21haW5BcHBSb2xlcyI6WyJBTkFMWVNUIiwiU1VQUE9SVCJdLCJwZXJtaXNzaW9ucyI6WyJSRVRSWV9XT1JLRkxPVyIsIlJPTEVfYWRtaW5pc3RyYXRvciIsIkVSUk9SX01BTkFHRU1FTlQiLCJTVUJTQ1JJQkVSU19NQU5BR0VNRU5UIiwiQ1JFQVRFX1VTRVIiLCJFWEVDVVRFX0FDVElPTiIsIkNMSUVOVF9VU0VSU19NQU5BR0VNRU5UIiwiQVBQUk9WRV9DQU5DRUwiLCJSRVFVRVNUX0NBTkNFTCIsIlVTRVJTX01BTkFHRU1FTlQiLCJOT1RJRklDQVRJT05TX01BTkFHRU1FTlQiLCJQQVlNRU5UU19NQU5BR0VNRU5UIiwiR0VUX1VTRVJTIiwiUkVTT1VSQ0VTX01BTkFHRU1FTlQiLCJBQ0NFU1NfQURNSU5fUEFHRSIsIlVTRVJfUk9MRVNfTUFOQUdFTUVOVCIsIkNMSUVOVFNfTUFOQUdFTUVOVCIsIkhFTFBfQVJUSUNMRVNfTUFOQUdFTUVOVCIsIlNUQVJUX1dPUktGTE9XIl19.QoNq3xhyPGpOdihPOe8LFMNE1QFk3gX-uwYH-q0MoBTkDW4iIzQRA2WbJic8TQqGHW--YLx9RN6LE7kyA6mG2w' -d '{
  "ValidFrom" : "2018-05-10T07:30:45.555Z",
  "ValidUntil" : "2018-05-20T07:30:45.555Z",
  "Title" : "System shutdown",
  "Body" : "system shutdown for next 6 hours",
  "Roles" : [ {
    "Id" : "ANALYST"
  } ]
}'

/organization/{organizationCode}/notifications

Parameter	Description
organizationCode	Organization code

Path	Type	Description
Title	String	Name of the resource
Body	String	URL of the resource
Roles	Array	Array of role IDs
ValidFrom	String	Valid from
ValidUntil	String	Valid until

Example response

HTTP/1.1 201 Created
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: POST, GET, PUT, OPTIONS, DELETE
Access-Control-Max-Age: 3600
Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Authorization
Content-Type: application/json;charset=UTF-8
Content-Length: 648

{
  "Id" : 5506354231902208,
  "ValidFrom" : "2018-05-10T07:30:45.555Z",
  "ValidUntil" : "2018-05-20T07:30:45.555Z",
  "Title" : "System shutdown",
  "Body" : "system shutdown for next 6 hours",
  "Roles" : [ {
    "Id" : "ANALYST",
    "Type" : "TEAM_ROLE",
    "Permissions" : [ "START_WORKFLOW", "EXECUTE_ACTION", "REQUEST_CANCEL", "RETRY_WORKFLOW", "PAYMENTS_MANAGEMENT" ],
    "Code" : "ANALYST",
    "Name" : "Analyst"
  } ],
  "Unread" : false,
  "CreatedBy" : {
    "Id" : 5910974510923776,
    "FirstName" : "Adam",
    "LastName" : "Analyst",
    "Email" : "AWIJRCorpSec@gmail.com",
    "Active" : true,
    "Name" : "Adam Analyst"
  }
}

Path	Type	Description
Id	Number	ID of the resource
Title	String	Title
Body	String	Body
Roles	Array	Array of role IDs
ValidFrom	String	Valid from
ValidUntil	String	Valid until
CreatedBy	Object	Created by
Unread	Boolean	Is the notification viewed by user

Update

Example request

PUT /organization/SD/notifications/5506354231902208 HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjU5MTA5NzQ1MTA5MjM3NzYsImV4cCI6MTUyODk2MDkyNiwib3JnQ29kZSI6IlNEIiwicm9sZXMiOlsiYWRtaW5pc3RyYXRvciJdLCJkb21haW5BcHBSb2xlcyI6WyJBTkFMWVNUIiwiU1VQUE9SVCJdLCJwZXJtaXNzaW9ucyI6WyJSRVRSWV9XT1JLRkxPVyIsIlJPTEVfYWRtaW5pc3RyYXRvciIsIkVSUk9SX01BTkFHRU1FTlQiLCJTVUJTQ1JJQkVSU19NQU5BR0VNRU5UIiwiQ1JFQVRFX1VTRVIiLCJFWEVDVVRFX0FDVElPTiIsIkNMSUVOVF9VU0VSU19NQU5BR0VNRU5UIiwiQVBQUk9WRV9DQU5DRUwiLCJSRVFVRVNUX0NBTkNFTCIsIlVTRVJTX01BTkFHRU1FTlQiLCJOT1RJRklDQVRJT05TX01BTkFHRU1FTlQiLCJQQVlNRU5UU19NQU5BR0VNRU5UIiwiR0VUX1VTRVJTIiwiUkVTT1VSQ0VTX01BTkFHRU1FTlQiLCJBQ0NFU1NfQURNSU5fUEFHRSIsIlVTRVJfUk9MRVNfTUFOQUdFTUVOVCIsIkNMSUVOVFNfTUFOQUdFTUVOVCIsIkhFTFBfQVJUSUNMRVNfTUFOQUdFTUVOVCIsIlNUQVJUX1dPUktGTE9XIl19.QoNq3xhyPGpOdihPOe8LFMNE1QFk3gX-uwYH-q0MoBTkDW4iIzQRA2WbJic8TQqGHW--YLx9RN6LE7kyA6mG2w
Host: corporateservices.com
Content-Length: 191

{
  "ValidFrom" : "2018-05-10T07:30:45.555Z",
  "ValidUntil" : "2018-05-20T07:30:45.555Z",
  "Title" : "Updated title",
  "Body" : "Updated body",
  "Roles" : [ {
    "Id" : "ANALYST"
  } ]
}

$ curl 'https://corporateservices.com:8080/organization/SD/notifications/5506354231902208' -i -X PUT -H 'Content-Type: application/json' -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjU5MTA5NzQ1MTA5MjM3NzYsImV4cCI6MTUyODk2MDkyNiwib3JnQ29kZSI6IlNEIiwicm9sZXMiOlsiYWRtaW5pc3RyYXRvciJdLCJkb21haW5BcHBSb2xlcyI6WyJBTkFMWVNUIiwiU1VQUE9SVCJdLCJwZXJtaXNzaW9ucyI6WyJSRVRSWV9XT1JLRkxPVyIsIlJPTEVfYWRtaW5pc3RyYXRvciIsIkVSUk9SX01BTkFHRU1FTlQiLCJTVUJTQ1JJQkVSU19NQU5BR0VNRU5UIiwiQ1JFQVRFX1VTRVIiLCJFWEVDVVRFX0FDVElPTiIsIkNMSUVOVF9VU0VSU19NQU5BR0VNRU5UIiwiQVBQUk9WRV9DQU5DRUwiLCJSRVFVRVNUX0NBTkNFTCIsIlVTRVJTX01BTkFHRU1FTlQiLCJOT1RJRklDQVRJT05TX01BTkFHRU1FTlQiLCJQQVlNRU5UU19NQU5BR0VNRU5UIiwiR0VUX1VTRVJTIiwiUkVTT1VSQ0VTX01BTkFHRU1FTlQiLCJBQ0NFU1NfQURNSU5fUEFHRSIsIlVTRVJfUk9MRVNfTUFOQUdFTUVOVCIsIkNMSUVOVFNfTUFOQUdFTUVOVCIsIkhFTFBfQVJUSUNMRVNfTUFOQUdFTUVOVCIsIlNUQVJUX1dPUktGTE9XIl19.QoNq3xhyPGpOdihPOe8LFMNE1QFk3gX-uwYH-q0MoBTkDW4iIzQRA2WbJic8TQqGHW--YLx9RN6LE7kyA6mG2w' -d '{
  "ValidFrom" : "2018-05-10T07:30:45.555Z",
  "ValidUntil" : "2018-05-20T07:30:45.555Z",
  "Title" : "Updated title",
  "Body" : "Updated body",
  "Roles" : [ {
    "Id" : "ANALYST"
  } ]
}'

/organization/{organizationCode}/notifications/{id}

Parameter	Description
organizationCode	Organization code
id	ID of the notification

Path	Type	Description
Title	String	Name of the resource
Body	String	URL of the resource
Roles	Array	Array of role IDs
ValidFrom	String	Valid from
ValidUntil	String	Valid until

Example response

HTTP/1.1 200 OK
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: POST, GET, PUT, OPTIONS, DELETE
Access-Control-Max-Age: 3600
Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Authorization
Content-Type: application/json;charset=UTF-8
Content-Length: 626

{
  "Id" : 5506354231902208,
  "ValidFrom" : "2018-05-10T07:30:45.555Z",
  "ValidUntil" : "2018-05-20T07:30:45.555Z",
  "Title" : "Updated title",
  "Body" : "Updated body",
  "Roles" : [ {
    "Id" : "ANALYST",
    "Type" : "TEAM_ROLE",
    "Permissions" : [ "START_WORKFLOW", "EXECUTE_ACTION", "REQUEST_CANCEL", "RETRY_WORKFLOW", "PAYMENTS_MANAGEMENT" ],
    "Code" : "ANALYST",
    "Name" : "Analyst"
  } ],
  "Unread" : false,
  "CreatedBy" : {
    "Id" : 5910974510923776,
    "FirstName" : "Adam",
    "LastName" : "Analyst",
    "Email" : "AWIJRCorpSec@gmail.com",
    "Active" : true,
    "Name" : "Adam Analyst"
  }
}

Path	Type	Description
Id	Number	ID of the resource
Title	String	Title
Body	String	Body
Roles	Array	Array of role IDs
ValidFrom	String	Valid from
ValidUntil	String	Valid until
CreatedBy	Object	Created by
Unread	Boolean	Is the notification viewed by user

Delete

Example request

DELETE /organization/SD/notifications/5506354231902208 HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjU5MTA5NzQ1MTA5MjM3NzYsImV4cCI6MTUyODk2MDkyNiwib3JnQ29kZSI6IlNEIiwicm9sZXMiOlsiYWRtaW5pc3RyYXRvciJdLCJkb21haW5BcHBSb2xlcyI6WyJBTkFMWVNUIiwiU1VQUE9SVCJdLCJwZXJtaXNzaW9ucyI6WyJSRVRSWV9XT1JLRkxPVyIsIlJPTEVfYWRtaW5pc3RyYXRvciIsIkVSUk9SX01BTkFHRU1FTlQiLCJTVUJTQ1JJQkVSU19NQU5BR0VNRU5UIiwiQ1JFQVRFX1VTRVIiLCJFWEVDVVRFX0FDVElPTiIsIkNMSUVOVF9VU0VSU19NQU5BR0VNRU5UIiwiQVBQUk9WRV9DQU5DRUwiLCJSRVFVRVNUX0NBTkNFTCIsIlVTRVJTX01BTkFHRU1FTlQiLCJOT1RJRklDQVRJT05TX01BTkFHRU1FTlQiLCJQQVlNRU5UU19NQU5BR0VNRU5UIiwiR0VUX1VTRVJTIiwiUkVTT1VSQ0VTX01BTkFHRU1FTlQiLCJBQ0NFU1NfQURNSU5fUEFHRSIsIlVTRVJfUk9MRVNfTUFOQUdFTUVOVCIsIkNMSUVOVFNfTUFOQUdFTUVOVCIsIkhFTFBfQVJUSUNMRVNfTUFOQUdFTUVOVCIsIlNUQVJUX1dPUktGTE9XIl19.QoNq3xhyPGpOdihPOe8LFMNE1QFk3gX-uwYH-q0MoBTkDW4iIzQRA2WbJic8TQqGHW--YLx9RN6LE7kyA6mG2w
Host: corporateservices.com

$ curl 'https://corporateservices.com:8080/organization/SD/notifications/5506354231902208' -i -X DELETE -H 'Content-Type: application/json' -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjU5MTA5NzQ1MTA5MjM3NzYsImV4cCI6MTUyODk2MDkyNiwib3JnQ29kZSI6IlNEIiwicm9sZXMiOlsiYWRtaW5pc3RyYXRvciJdLCJkb21haW5BcHBSb2xlcyI6WyJBTkFMWVNUIiwiU1VQUE9SVCJdLCJwZXJtaXNzaW9ucyI6WyJSRVRSWV9XT1JLRkxPVyIsIlJPTEVfYWRtaW5pc3RyYXRvciIsIkVSUk9SX01BTkFHRU1FTlQiLCJTVUJTQ1JJQkVSU19NQU5BR0VNRU5UIiwiQ1JFQVRFX1VTRVIiLCJFWEVDVVRFX0FDVElPTiIsIkNMSUVOVF9VU0VSU19NQU5BR0VNRU5UIiwiQVBQUk9WRV9DQU5DRUwiLCJSRVFVRVNUX0NBTkNFTCIsIlVTRVJTX01BTkFHRU1FTlQiLCJOT1RJRklDQVRJT05TX01BTkFHRU1FTlQiLCJQQVlNRU5UU19NQU5BR0VNRU5UIiwiR0VUX1VTRVJTIiwiUkVTT1VSQ0VTX01BTkFHRU1FTlQiLCJBQ0NFU1NfQURNSU5fUEFHRSIsIlVTRVJfUk9MRVNfTUFOQUdFTUVOVCIsIkNMSUVOVFNfTUFOQUdFTUVOVCIsIkhFTFBfQVJUSUNMRVNfTUFOQUdFTUVOVCIsIlNUQVJUX1dPUktGTE9XIl19.QoNq3xhyPGpOdihPOe8LFMNE1QFk3gX-uwYH-q0MoBTkDW4iIzQRA2WbJic8TQqGHW--YLx9RN6LE7kyA6mG2w'

/organization/{organizationCode}/notifications/{id}

Parameter	Description
organizationCode	Organization code
id	ID of the notification

Example response

HTTP/1.1 204 No Content
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: POST, GET, PUT, OPTIONS, DELETE
Access-Control-Max-Age: 3600
Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Authorization

Get all notifications

Example request

GET /organization/SD/notifications HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjU5MTA5NzQ1MTA5MjM3NzYsImV4cCI6MTUyODk2MDkyNiwib3JnQ29kZSI6IlNEIiwicm9sZXMiOlsiYWRtaW5pc3RyYXRvciJdLCJkb21haW5BcHBSb2xlcyI6WyJBTkFMWVNUIiwiU1VQUE9SVCJdLCJwZXJtaXNzaW9ucyI6WyJSRVRSWV9XT1JLRkxPVyIsIlJPTEVfYWRtaW5pc3RyYXRvciIsIkVSUk9SX01BTkFHRU1FTlQiLCJTVUJTQ1JJQkVSU19NQU5BR0VNRU5UIiwiQ1JFQVRFX1VTRVIiLCJFWEVDVVRFX0FDVElPTiIsIkNMSUVOVF9VU0VSU19NQU5BR0VNRU5UIiwiQVBQUk9WRV9DQU5DRUwiLCJSRVFVRVNUX0NBTkNFTCIsIlVTRVJTX01BTkFHRU1FTlQiLCJOT1RJRklDQVRJT05TX01BTkFHRU1FTlQiLCJQQVlNRU5UU19NQU5BR0VNRU5UIiwiR0VUX1VTRVJTIiwiUkVTT1VSQ0VTX01BTkFHRU1FTlQiLCJBQ0NFU1NfQURNSU5fUEFHRSIsIlVTRVJfUk9MRVNfTUFOQUdFTUVOVCIsIkNMSUVOVFNfTUFOQUdFTUVOVCIsIkhFTFBfQVJUSUNMRVNfTUFOQUdFTUVOVCIsIlNUQVJUX1dPUktGTE9XIl19.QoNq3xhyPGpOdihPOe8LFMNE1QFk3gX-uwYH-q0MoBTkDW4iIzQRA2WbJic8TQqGHW--YLx9RN6LE7kyA6mG2w
Host: corporateservices.com

$ curl 'https://corporateservices.com:8080/organization/SD/notifications' -i -H 'Content-Type: application/json' -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjU5MTA5NzQ1MTA5MjM3NzYsImV4cCI6MTUyODk2MDkyNiwib3JnQ29kZSI6IlNEIiwicm9sZXMiOlsiYWRtaW5pc3RyYXRvciJdLCJkb21haW5BcHBSb2xlcyI6WyJBTkFMWVNUIiwiU1VQUE9SVCJdLCJwZXJtaXNzaW9ucyI6WyJSRVRSWV9XT1JLRkxPVyIsIlJPTEVfYWRtaW5pc3RyYXRvciIsIkVSUk9SX01BTkFHRU1FTlQiLCJTVUJTQ1JJQkVSU19NQU5BR0VNRU5UIiwiQ1JFQVRFX1VTRVIiLCJFWEVDVVRFX0FDVElPTiIsIkNMSUVOVF9VU0VSU19NQU5BR0VNRU5UIiwiQVBQUk9WRV9DQU5DRUwiLCJSRVFVRVNUX0NBTkNFTCIsIlVTRVJTX01BTkFHRU1FTlQiLCJOT1RJRklDQVRJT05TX01BTkFHRU1FTlQiLCJQQVlNRU5UU19NQU5BR0VNRU5UIiwiR0VUX1VTRVJTIiwiUkVTT1VSQ0VTX01BTkFHRU1FTlQiLCJBQ0NFU1NfQURNSU5fUEFHRSIsIlVTRVJfUk9MRVNfTUFOQUdFTUVOVCIsIkNMSUVOVFNfTUFOQUdFTUVOVCIsIkhFTFBfQVJUSUNMRVNfTUFOQUdFTUVOVCIsIlNUQVJUX1dPUktGTE9XIl19.QoNq3xhyPGpOdihPOe8LFMNE1QFk3gX-uwYH-q0MoBTkDW4iIzQRA2WbJic8TQqGHW--YLx9RN6LE7kyA6mG2w'

/organization/{organizationCode}/notifications

Parameter	Description
organizationCode	Organization code

Example response

HTTP/1.1 200 OK
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: POST, GET, PUT, OPTIONS, DELETE
Access-Control-Max-Age: 3600
Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Authorization
Content-Type: application/json;charset=UTF-8
Content-Length: 652

[ {
  "Id" : 5506354231902208,
  "ValidFrom" : "2018-05-10T07:30:45.555Z",
  "ValidUntil" : "2018-05-20T07:30:45.555Z",
  "Title" : "System shutdown",
  "Body" : "system shutdown for next 6 hours",
  "Roles" : [ {
    "Id" : "ANALYST",
    "Type" : "TEAM_ROLE",
    "Permissions" : [ "START_WORKFLOW", "EXECUTE_ACTION", "REQUEST_CANCEL", "RETRY_WORKFLOW", "PAYMENTS_MANAGEMENT" ],
    "Code" : "ANALYST",
    "Name" : "Analyst"
  } ],
  "Unread" : false,
  "CreatedBy" : {
    "Id" : 5910974510923776,
    "FirstName" : "Adam",
    "LastName" : "Analyst",
    "Email" : "AWIJRCorpSec@gmail.com",
    "Active" : true,
    "Name" : "Adam Analyst"
  }
} ]

Path	Type	Description
[]	Array	An array of notifiations
[].Id	Number	ID of the resource
[].Title	String	Title
[].Body	String	Body
[].Roles	Array	Array of roles
[].ValidFrom	String	Valid from
[].ValidUntil	String	Valid until
[].CreatedBy	Object	Created by
[].Unread	Boolean	Is the notification viewed by user

Get my notifications

Example request

GET /organization/SD/notifications/my HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjU5MTA5NzQ1MTA5MjM3NzYsImV4cCI6MTUyODk2MDkyNiwib3JnQ29kZSI6IlNEIiwicm9sZXMiOlsiYWRtaW5pc3RyYXRvciJdLCJkb21haW5BcHBSb2xlcyI6WyJBTkFMWVNUIiwiU1VQUE9SVCJdLCJwZXJtaXNzaW9ucyI6WyJSRVRSWV9XT1JLRkxPVyIsIlJPTEVfYWRtaW5pc3RyYXRvciIsIkVSUk9SX01BTkFHRU1FTlQiLCJTVUJTQ1JJQkVSU19NQU5BR0VNRU5UIiwiQ1JFQVRFX1VTRVIiLCJFWEVDVVRFX0FDVElPTiIsIkNMSUVOVF9VU0VSU19NQU5BR0VNRU5UIiwiQVBQUk9WRV9DQU5DRUwiLCJSRVFVRVNUX0NBTkNFTCIsIlVTRVJTX01BTkFHRU1FTlQiLCJOT1RJRklDQVRJT05TX01BTkFHRU1FTlQiLCJQQVlNRU5UU19NQU5BR0VNRU5UIiwiR0VUX1VTRVJTIiwiUkVTT1VSQ0VTX01BTkFHRU1FTlQiLCJBQ0NFU1NfQURNSU5fUEFHRSIsIlVTRVJfUk9MRVNfTUFOQUdFTUVOVCIsIkNMSUVOVFNfTUFOQUdFTUVOVCIsIkhFTFBfQVJUSUNMRVNfTUFOQUdFTUVOVCIsIlNUQVJUX1dPUktGTE9XIl19.QoNq3xhyPGpOdihPOe8LFMNE1QFk3gX-uwYH-q0MoBTkDW4iIzQRA2WbJic8TQqGHW--YLx9RN6LE7kyA6mG2w
Host: corporateservices.com

$ curl 'https://corporateservices.com:8080/organization/SD/notifications/my' -i -H 'Content-Type: application/json' -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjU5MTA5NzQ1MTA5MjM3NzYsImV4cCI6MTUyODk2MDkyNiwib3JnQ29kZSI6IlNEIiwicm9sZXMiOlsiYWRtaW5pc3RyYXRvciJdLCJkb21haW5BcHBSb2xlcyI6WyJBTkFMWVNUIiwiU1VQUE9SVCJdLCJwZXJtaXNzaW9ucyI6WyJSRVRSWV9XT1JLRkxPVyIsIlJPTEVfYWRtaW5pc3RyYXRvciIsIkVSUk9SX01BTkFHRU1FTlQiLCJTVUJTQ1JJQkVSU19NQU5BR0VNRU5UIiwiQ1JFQVRFX1VTRVIiLCJFWEVDVVRFX0FDVElPTiIsIkNMSUVOVF9VU0VSU19NQU5BR0VNRU5UIiwiQVBQUk9WRV9DQU5DRUwiLCJSRVFVRVNUX0NBTkNFTCIsIlVTRVJTX01BTkFHRU1FTlQiLCJOT1RJRklDQVRJT05TX01BTkFHRU1FTlQiLCJQQVlNRU5UU19NQU5BR0VNRU5UIiwiR0VUX1VTRVJTIiwiUkVTT1VSQ0VTX01BTkFHRU1FTlQiLCJBQ0NFU1NfQURNSU5fUEFHRSIsIlVTRVJfUk9MRVNfTUFOQUdFTUVOVCIsIkNMSUVOVFNfTUFOQUdFTUVOVCIsIkhFTFBfQVJUSUNMRVNfTUFOQUdFTUVOVCIsIlNUQVJUX1dPUktGTE9XIl19.QoNq3xhyPGpOdihPOe8LFMNE1QFk3gX-uwYH-q0MoBTkDW4iIzQRA2WbJic8TQqGHW--YLx9RN6LE7kyA6mG2w'

/organization/{organizationCode}/notifications/my

Parameter	Description
organizationCode	Organization code

Example response

HTTP/1.1 200 OK
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: POST, GET, PUT, OPTIONS, DELETE
Access-Control-Max-Age: 3600
Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Authorization
Content-Type: application/json;charset=UTF-8
Content-Length: 741

{
  "Notifications" : [ {
    "Id" : 5506354231902208,
    "ValidFrom" : "2018-05-10T07:30:45.555Z",
    "ValidUntil" : "2018-05-20T07:30:45.555Z",
    "Title" : "System shutdown",
    "Body" : "system shutdown for next 6 hours",
    "Roles" : [ {
      "Id" : "ANALYST",
      "Type" : "TEAM_ROLE",
      "Permissions" : [ "START_WORKFLOW", "EXECUTE_ACTION", "REQUEST_CANCEL", "RETRY_WORKFLOW", "PAYMENTS_MANAGEMENT" ],
      "Code" : "ANALYST",
      "Name" : "Analyst"
    } ],
    "Unread" : false,
    "CreatedBy" : {
      "Id" : 5910974510923776,
      "FirstName" : "Adam",
      "LastName" : "Analyst",
      "Email" : "AWIJRCorpSec@gmail.com",
      "Active" : true,
      "Name" : "Adam Analyst"
    }
  } ],
  "UnreadCount" : 0
}

Path	Type	Description
Notifications	Array	An array of notifiations
Notifications[].Id	Number	ID of the resource
Notifications[].Title	String	Title
Notifications[].Body	String	Body
Notifications[].Roles	Array	Array of roles
Notifications[].ValidFrom	String	Valid from
Notifications[].ValidUntil	String	Valid until
Notifications[].CreatedBy	Object	Created by
Notifications[].Unread	Boolean	Is the notification viewed by user
UnreadCount	Number	Number of unread notifications

Generate reports

Create

Example request

POST /organization/SD/processInstance/5506354231902208/activity-instances/ahRzfmF2b2NhZG8tYmFja2VuZC12MXI5CxIPUHJvY2Vzc0luc3RhbmNlGICAgICAgOQJDAsSEEFjdGl2aXR5SW5zdGFuY2UYgICAgICAlAgM/document HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjU5MTA5NzQ1MTA5MjM3NzYsImV4cCI6MTUyODk2MDk1NywiY2xpZW50SWQiOjUwMzEzNjUyMDg3MDI5NzYsIm9yZ0NvZGUiOiJTRCIsInJvbGVzIjpbImFkbWluaXN0cmF0b3IiXSwiZG9tYWluQXBwUm9sZXMiOlsiQU5BTFlTVCIsIlNVUFBPUlQiLCJDTElFTlQiXSwicGVybWlzc2lvbnMiOlsiUkVUUllfV09SS0ZMT1ciLCJST0xFX2FkbWluaXN0cmF0b3IiLCJFUlJPUl9NQU5BR0VNRU5UIiwiU1VCU0NSSUJFUlNfTUFOQUdFTUVOVCIsIkNSRUFURV9VU0VSIiwiRVhFQ1VURV9BQ1RJT04iLCJDTElFTlRfVVNFUlNfTUFOQUdFTUVOVCIsIkFQUFJPVkVfQ0FOQ0VMIiwiUkVRVUVTVF9DQU5DRUwiLCJVU0VSU19NQU5BR0VNRU5UIiwiTk9USUZJQ0FUSU9OU19NQU5BR0VNRU5UIiwiUEFZTUVOVFNfTUFOQUdFTUVOVCIsIkdFVF9VU0VSUyIsIlJFU09VUkNFU19NQU5BR0VNRU5UIiwiQUNDRVNTX0FETUlOX1BBR0UiLCJVU0VSX1JPTEVTX01BTkFHRU1FTlQiLCJDTElFTlRTX01BTkFHRU1FTlQiLCJIRUxQX0FSVElDTEVTX01BTkFHRU1FTlQiLCJTVEFSVF9XT1JLRkxPVyJdfQ.58rZ-ppF_MLa6_tLR4jDtIIKjyQ1lBdDOD6RCBCotRAx78GNQfv9ffggAOKve5HXoQA61OqDPL2VIzgOGNbH8A
Host: corporateservices.com

templateCode=CONSTITUTION

$ curl 'https://corporateservices.com:8080/organization/SD/processInstance/5506354231902208/activity-instances/ahRzfmF2b2NhZG8tYmFja2VuZC12MXI5CxIPUHJvY2Vzc0luc3RhbmNlGICAgICAgOQJDAsSEEFjdGl2aXR5SW5zdGFuY2UYgICAgICAlAgM/document' -i -X POST -H 'Content-Type: application/json' -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjU5MTA5NzQ1MTA5MjM3NzYsImV4cCI6MTUyODk2MDk1NywiY2xpZW50SWQiOjUwMzEzNjUyMDg3MDI5NzYsIm9yZ0NvZGUiOiJTRCIsInJvbGVzIjpbImFkbWluaXN0cmF0b3IiXSwiZG9tYWluQXBwUm9sZXMiOlsiQU5BTFlTVCIsIlNVUFBPUlQiLCJDTElFTlQiXSwicGVybWlzc2lvbnMiOlsiUkVUUllfV09SS0ZMT1ciLCJST0xFX2FkbWluaXN0cmF0b3IiLCJFUlJPUl9NQU5BR0VNRU5UIiwiU1VCU0NSSUJFUlNfTUFOQUdFTUVOVCIsIkNSRUFURV9VU0VSIiwiRVhFQ1VURV9BQ1RJT04iLCJDTElFTlRfVVNFUlNfTUFOQUdFTUVOVCIsIkFQUFJPVkVfQ0FOQ0VMIiwiUkVRVUVTVF9DQU5DRUwiLCJVU0VSU19NQU5BR0VNRU5UIiwiTk9USUZJQ0FUSU9OU19NQU5BR0VNRU5UIiwiUEFZTUVOVFNfTUFOQUdFTUVOVCIsIkdFVF9VU0VSUyIsIlJFU09VUkNFU19NQU5BR0VNRU5UIiwiQUNDRVNTX0FETUlOX1BBR0UiLCJVU0VSX1JPTEVTX01BTkFHRU1FTlQiLCJDTElFTlRTX01BTkFHRU1FTlQiLCJIRUxQX0FSVElDTEVTX01BTkFHRU1FTlQiLCJTVEFSVF9XT1JLRkxPVyJdfQ.58rZ-ppF_MLa6_tLR4jDtIIKjyQ1lBdDOD6RCBCotRAx78GNQfv9ffggAOKve5HXoQA61OqDPL2VIzgOGNbH8A' -d 'templateCode=CONSTITUTION'

/organization/{organizationCode}/processInstance/{processInstanceId}/activity-instances/{activityInstanceKey}/document

Parameter	Description
organizationCode	Organization code
processInstanceId	Process instance ID
activityInstanceKey	Activity Instance Key

Parameter	Description
templateCode	Document template code

Example response

HTTP/1.1 201 Created
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: POST, GET, PUT, OPTIONS, DELETE
Access-Control-Max-Age: 3600
Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Authorization
Content-Type: application/json;charset=UTF-8
Content-Length: 212

{
  "FileId" : "exported_file_id",
  "FileName" : "dummy document",
  "MimeType" : "application/pdf",
  "WebViewLink" : "https://drive.google.com/d/test-document-id/preview?drivesdk",
  "IconLink" : "icon link"
}

Path	Type	Description
FileId	String	File id
FileName	String	File name
MimeType	String	MIME Type
WebViewLink	String	Web view link
IconLink	String	Icon link

Get on-demand reports

Example request

GET /organization/SD/activity-instances/ahRzfmF2b2NhZG8tYmFja2VuZC12MXI5CxIPUHJvY2Vzc0luc3RhbmNlGICAgICAgOQJDAsSEEFjdGl2aXR5SW5zdGFuY2UYgICAgICAlAgM/document-template/on-demand HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjU5MTA5NzQ1MTA5MjM3NzYsImV4cCI6MTUyODk2MDg4OSwiY2xpZW50SWQiOjUwMzEzNjUyMDg3MDI5NzYsIm9yZ0NvZGUiOiJTRCIsInJvbGVzIjpbImFkbWluaXN0cmF0b3IiXSwiZG9tYWluQXBwUm9sZXMiOlsiQU5BTFlTVCIsIlNVUFBPUlQiLCJDTElFTlQiXSwicGVybWlzc2lvbnMiOlsiUkVUUllfV09SS0ZMT1ciLCJST0xFX2FkbWluaXN0cmF0b3IiLCJFUlJPUl9NQU5BR0VNRU5UIiwiU1VCU0NSSUJFUlNfTUFOQUdFTUVOVCIsIkNSRUFURV9VU0VSIiwiRVhFQ1VURV9BQ1RJT04iLCJDTElFTlRfVVNFUlNfTUFOQUdFTUVOVCIsIkFQUFJPVkVfQ0FOQ0VMIiwiUkVRVUVTVF9DQU5DRUwiLCJVU0VSU19NQU5BR0VNRU5UIiwiTk9USUZJQ0FUSU9OU19NQU5BR0VNRU5UIiwiUEFZTUVOVFNfTUFOQUdFTUVOVCIsIkdFVF9VU0VSUyIsIlJFU09VUkNFU19NQU5BR0VNRU5UIiwiQUNDRVNTX0FETUlOX1BBR0UiLCJVU0VSX1JPTEVTX01BTkFHRU1FTlQiLCJDTElFTlRTX01BTkFHRU1FTlQiLCJIRUxQX0FSVElDTEVTX01BTkFHRU1FTlQiLCJTVEFSVF9XT1JLRkxPVyJdfQ.Ovpev-CY9J-lWHkT2lHywc0KUzGNHszdE7lpAzGdJ33HDc_e74t06d9gmSUUZzVaqVc-exGyiGoZ7J1IMNkyEg
Host: corporateservices.com

$ curl 'https://corporateservices.com:8080/organization/SD/activity-instances/ahRzfmF2b2NhZG8tYmFja2VuZC12MXI5CxIPUHJvY2Vzc0luc3RhbmNlGICAgICAgOQJDAsSEEFjdGl2aXR5SW5zdGFuY2UYgICAgICAlAgM/document-template/on-demand' -i -H 'Content-Type: application/json' -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjU5MTA5NzQ1MTA5MjM3NzYsImV4cCI6MTUyODk2MDg4OSwiY2xpZW50SWQiOjUwMzEzNjUyMDg3MDI5NzYsIm9yZ0NvZGUiOiJTRCIsInJvbGVzIjpbImFkbWluaXN0cmF0b3IiXSwiZG9tYWluQXBwUm9sZXMiOlsiQU5BTFlTVCIsIlNVUFBPUlQiLCJDTElFTlQiXSwicGVybWlzc2lvbnMiOlsiUkVUUllfV09SS0ZMT1ciLCJST0xFX2FkbWluaXN0cmF0b3IiLCJFUlJPUl9NQU5BR0VNRU5UIiwiU1VCU0NSSUJFUlNfTUFOQUdFTUVOVCIsIkNSRUFURV9VU0VSIiwiRVhFQ1VURV9BQ1RJT04iLCJDTElFTlRfVVNFUlNfTUFOQUdFTUVOVCIsIkFQUFJPVkVfQ0FOQ0VMIiwiUkVRVUVTVF9DQU5DRUwiLCJVU0VSU19NQU5BR0VNRU5UIiwiTk9USUZJQ0FUSU9OU19NQU5BR0VNRU5UIiwiUEFZTUVOVFNfTUFOQUdFTUVOVCIsIkdFVF9VU0VSUyIsIlJFU09VUkNFU19NQU5BR0VNRU5UIiwiQUNDRVNTX0FETUlOX1BBR0UiLCJVU0VSX1JPTEVTX01BTkFHRU1FTlQiLCJDTElFTlRTX01BTkFHRU1FTlQiLCJIRUxQX0FSVElDTEVTX01BTkFHRU1FTlQiLCJTVEFSVF9XT1JLRkxPVyJdfQ.Ovpev-CY9J-lWHkT2lHywc0KUzGNHszdE7lpAzGdJ33HDc_e74t06d9gmSUUZzVaqVc-exGyiGoZ7J1IMNkyEg'

/organization/{organizationCode}/activity-instances/{activityInstanceKey}/document-template/on-demand

Parameter	Description
organizationCode	Organization code
activityInstanceKey	ActivityInstance Key

Example response

HTTP/1.1 200 OK
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: POST, GET, PUT, OPTIONS, DELETE
Access-Control-Max-Age: 3600
Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Authorization
Content-Type: application/json;charset=UTF-8
Content-Length: 234

[ {
  "Id" : "CONSTITUTION",
  "FileId" : "DUMMY-FILE-ID",
  "Name" : "Company Constitution",
  "Code" : "CONSTITUTION",
  "OrganizationSettingNames" : [ ],
  "Description" : "The document defines the constitution for the company"
} ]

Path	Type	Description
[]	Array	An array of on demand reports for the current workflow
[].Name	String	Name of the report
[].Description	String	Description
[].Code	String	Code
[].FileId	String	Drive File Id

Workflow form help articles

Get

Example request

GET /organization/SUB/help-articles/test HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjU2Mjk0OTk1MzQyMTMxMjAsImV4cCI6MTUyODk2MDk1Nywicm9sZXMiOltdLCJkb21haW5BcHBSb2xlcyI6W10sInBlcm1pc3Npb25zIjpbIlJFVFJZX1dPUktGTE9XIiwiU1VQRVJBRE1JTiIsIkVSUk9SX01BTkFHRU1FTlQiLCJTVUJTQ1JJQkVSU19NQU5BR0VNRU5UIiwiQ1JFQVRFX1VTRVIiLCJFWEVDVVRFX0FDVElPTiIsIkNMSUVOVF9VU0VSU19NQU5BR0VNRU5UIiwiQVBQUk9WRV9DQU5DRUwiLCJSRVFVRVNUX0NBTkNFTCIsIlVTRVJTX01BTkFHRU1FTlQiLCJOT1RJRklDQVRJT05TX01BTkFHRU1FTlQiLCJHRVRfVVNFUlMiLCJSRVNPVVJDRVNfTUFOQUdFTUVOVCIsIkFDQ0VTU19BRE1JTl9QQUdFIiwiVVNFUl9ST0xFU19NQU5BR0VNRU5UIiwiQ0xJRU5UU19NQU5BR0VNRU5UIiwiSEVMUF9BUlRJQ0xFU19NQU5BR0VNRU5UIiwiU1RBUlRfV09SS0ZMT1ciXX0.CBOUjYRAE96Jh-BauNMKA4t0aKxyyHo34Lilz2OWgAn2SpL6fncv-Ch7elFFYWw1dX2i7aNmXBSFiBpJGdrujA
Host: corporateservices.com

$ curl 'https://corporateservices.com:8080/organization/SUB/help-articles/test' -i -H 'Content-Type: application/json' -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjU2Mjk0OTk1MzQyMTMxMjAsImV4cCI6MTUyODk2MDk1Nywicm9sZXMiOltdLCJkb21haW5BcHBSb2xlcyI6W10sInBlcm1pc3Npb25zIjpbIlJFVFJZX1dPUktGTE9XIiwiU1VQRVJBRE1JTiIsIkVSUk9SX01BTkFHRU1FTlQiLCJTVUJTQ1JJQkVSU19NQU5BR0VNRU5UIiwiQ1JFQVRFX1VTRVIiLCJFWEVDVVRFX0FDVElPTiIsIkNMSUVOVF9VU0VSU19NQU5BR0VNRU5UIiwiQVBQUk9WRV9DQU5DRUwiLCJSRVFVRVNUX0NBTkNFTCIsIlVTRVJTX01BTkFHRU1FTlQiLCJOT1RJRklDQVRJT05TX01BTkFHRU1FTlQiLCJHRVRfVVNFUlMiLCJSRVNPVVJDRVNfTUFOQUdFTUVOVCIsIkFDQ0VTU19BRE1JTl9QQUdFIiwiVVNFUl9ST0xFU19NQU5BR0VNRU5UIiwiQ0xJRU5UU19NQU5BR0VNRU5UIiwiSEVMUF9BUlRJQ0xFU19NQU5BR0VNRU5UIiwiU1RBUlRfV09SS0ZMT1ciXX0.CBOUjYRAE96Jh-BauNMKA4t0aKxyyHo34Lilz2OWgAn2SpL6fncv-Ch7elFFYWw1dX2i7aNmXBSFiBpJGdrujA'

/organization/{organizationCode}/help-articles/{articleCode}

Parameter	Description
organizationCode	Subscriber organization code
articleCode	Help article code

Example response

HTTP/1.1 200 OK
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: POST, GET, PUT, OPTIONS, DELETE
Access-Control-Max-Age: 3600
Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Authorization
Content-Type: application/json;charset=UTF-8
Content-Length: 170

{
  "Code" : "test",
  "Name" : "Help",
  "Value" : "<b>Hello</b> \"WORLD\" Help",
  "Description" : "Help article for hello world",
  "Style" : "style",
  "Preset" : 1
}

Path	Type	Description
Name	String	Name of the article
Code	String	Code of the article
Value	String	Article content
Description	String	Article description
Style	String	Article style
Preset	String	Article preset

List

Example request

GET /organization/PUB/domain-application/12345/help-articles HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjU2Mjk0OTk1MzQyMTMxMjAsImV4cCI6MTUyODk2MDk1Nywicm9sZXMiOltdLCJkb21haW5BcHBSb2xlcyI6W10sInBlcm1pc3Npb25zIjpbIlJFVFJZX1dPUktGTE9XIiwiU1VQRVJBRE1JTiIsIkVSUk9SX01BTkFHRU1FTlQiLCJTVUJTQ1JJQkVSU19NQU5BR0VNRU5UIiwiQ1JFQVRFX1VTRVIiLCJFWEVDVVRFX0FDVElPTiIsIkNMSUVOVF9VU0VSU19NQU5BR0VNRU5UIiwiQVBQUk9WRV9DQU5DRUwiLCJSRVFVRVNUX0NBTkNFTCIsIlVTRVJTX01BTkFHRU1FTlQiLCJOT1RJRklDQVRJT05TX01BTkFHRU1FTlQiLCJHRVRfVVNFUlMiLCJSRVNPVVJDRVNfTUFOQUdFTUVOVCIsIkFDQ0VTU19BRE1JTl9QQUdFIiwiVVNFUl9ST0xFU19NQU5BR0VNRU5UIiwiQ0xJRU5UU19NQU5BR0VNRU5UIiwiSEVMUF9BUlRJQ0xFU19NQU5BR0VNRU5UIiwiU1RBUlRfV09SS0ZMT1ciXX0.CBOUjYRAE96Jh-BauNMKA4t0aKxyyHo34Lilz2OWgAn2SpL6fncv-Ch7elFFYWw1dX2i7aNmXBSFiBpJGdrujA
Host: corporateservices.com

$ curl 'https://corporateservices.com:8080/organization/PUB/domain-application/12345/help-articles' -i -H 'Content-Type: application/json' -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjU2Mjk0OTk1MzQyMTMxMjAsImV4cCI6MTUyODk2MDk1Nywicm9sZXMiOltdLCJkb21haW5BcHBSb2xlcyI6W10sInBlcm1pc3Npb25zIjpbIlJFVFJZX1dPUktGTE9XIiwiU1VQRVJBRE1JTiIsIkVSUk9SX01BTkFHRU1FTlQiLCJTVUJTQ1JJQkVSU19NQU5BR0VNRU5UIiwiQ1JFQVRFX1VTRVIiLCJFWEVDVVRFX0FDVElPTiIsIkNMSUVOVF9VU0VSU19NQU5BR0VNRU5UIiwiQVBQUk9WRV9DQU5DRUwiLCJSRVFVRVNUX0NBTkNFTCIsIlVTRVJTX01BTkFHRU1FTlQiLCJOT1RJRklDQVRJT05TX01BTkFHRU1FTlQiLCJHRVRfVVNFUlMiLCJSRVNPVVJDRVNfTUFOQUdFTUVOVCIsIkFDQ0VTU19BRE1JTl9QQUdFIiwiVVNFUl9ST0xFU19NQU5BR0VNRU5UIiwiQ0xJRU5UU19NQU5BR0VNRU5UIiwiSEVMUF9BUlRJQ0xFU19NQU5BR0VNRU5UIiwiU1RBUlRfV09SS0ZMT1ciXX0.CBOUjYRAE96Jh-BauNMKA4t0aKxyyHo34Lilz2OWgAn2SpL6fncv-Ch7elFFYWw1dX2i7aNmXBSFiBpJGdrujA'

/organization/{organizationCode}/domain-application/{domainAppId}/help-articles

Parameter	Description
organizationCode	Publisher organization code
domainAppId	Id of domain application

Example response

HTTP/1.1 200 OK
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: POST, GET, PUT, OPTIONS, DELETE
Access-Control-Max-Age: 3600
Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Authorization
Content-Type: application/json;charset=UTF-8
Content-Length: 174

[ {
  "Code" : "test",
  "Name" : "Help",
  "Value" : "<b>Hello</b> \"WORLD\" Help",
  "Description" : "Help article for hello world",
  "Style" : "style",
  "Preset" : 1
} ]

Path	Type	Description
[].Name	String	Name of the article
[].Code	String	Code of the article
[].Value	String	Article content
[].Description	String	Article description
[].Style	String	Article style
[].Preset	String	Article preset

Create

Example request

POST /organization/SUB/domain-application/12345/help-articles HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjU2Mjk0OTk1MzQyMTMxMjAsImV4cCI6MTUyODk2MDk1Nywicm9sZXMiOltdLCJkb21haW5BcHBSb2xlcyI6W10sInBlcm1pc3Npb25zIjpbIlJFVFJZX1dPUktGTE9XIiwiU1VQRVJBRE1JTiIsIkVSUk9SX01BTkFHRU1FTlQiLCJTVUJTQ1JJQkVSU19NQU5BR0VNRU5UIiwiQ1JFQVRFX1VTRVIiLCJFWEVDVVRFX0FDVElPTiIsIkNMSUVOVF9VU0VSU19NQU5BR0VNRU5UIiwiQVBQUk9WRV9DQU5DRUwiLCJSRVFVRVNUX0NBTkNFTCIsIlVTRVJTX01BTkFHRU1FTlQiLCJOT1RJRklDQVRJT05TX01BTkFHRU1FTlQiLCJHRVRfVVNFUlMiLCJSRVNPVVJDRVNfTUFOQUdFTUVOVCIsIkFDQ0VTU19BRE1JTl9QQUdFIiwiVVNFUl9ST0xFU19NQU5BR0VNRU5UIiwiQ0xJRU5UU19NQU5BR0VNRU5UIiwiSEVMUF9BUlRJQ0xFU19NQU5BR0VNRU5UIiwiU1RBUlRfV09SS0ZMT1ciXX0.CBOUjYRAE96Jh-BauNMKA4t0aKxyyHo34Lilz2OWgAn2SpL6fncv-Ch7elFFYWw1dX2i7aNmXBSFiBpJGdrujA
Host: corporateservices.com
Content-Length: 142

{
  "Code" : "help",
  "Name" : "Help",
  "Value" : "Help !!! Help!!!",
  "Description" : "Description",
  "Style" : "style",
  "Preset" : 1
}

$ curl 'https://corporateservices.com:8080/organization/SUB/domain-application/12345/help-articles' -i -X POST -H 'Content-Type: application/json' -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjU2Mjk0OTk1MzQyMTMxMjAsImV4cCI6MTUyODk2MDk1Nywicm9sZXMiOltdLCJkb21haW5BcHBSb2xlcyI6W10sInBlcm1pc3Npb25zIjpbIlJFVFJZX1dPUktGTE9XIiwiU1VQRVJBRE1JTiIsIkVSUk9SX01BTkFHRU1FTlQiLCJTVUJTQ1JJQkVSU19NQU5BR0VNRU5UIiwiQ1JFQVRFX1VTRVIiLCJFWEVDVVRFX0FDVElPTiIsIkNMSUVOVF9VU0VSU19NQU5BR0VNRU5UIiwiQVBQUk9WRV9DQU5DRUwiLCJSRVFVRVNUX0NBTkNFTCIsIlVTRVJTX01BTkFHRU1FTlQiLCJOT1RJRklDQVRJT05TX01BTkFHRU1FTlQiLCJHRVRfVVNFUlMiLCJSRVNPVVJDRVNfTUFOQUdFTUVOVCIsIkFDQ0VTU19BRE1JTl9QQUdFIiwiVVNFUl9ST0xFU19NQU5BR0VNRU5UIiwiQ0xJRU5UU19NQU5BR0VNRU5UIiwiSEVMUF9BUlRJQ0xFU19NQU5BR0VNRU5UIiwiU1RBUlRfV09SS0ZMT1ciXX0.CBOUjYRAE96Jh-BauNMKA4t0aKxyyHo34Lilz2OWgAn2SpL6fncv-Ch7elFFYWw1dX2i7aNmXBSFiBpJGdrujA' -d '{
  "Code" : "help",
  "Name" : "Help",
  "Value" : "Help !!! Help!!!",
  "Description" : "Description",
  "Style" : "style",
  "Preset" : 1
}'

/organization/{organizationCode}/domain-application/{domainAppId}/help-articles

Parameter	Description
organizationCode	Publisher organization code
domainAppId	Id of domain application

Path	Type	Description
Name	String	Name of the article
Code	String	Code of the article
Value	String	Article content
Description	String	Article description
Style	String	Article style
Preset	String	Article preset

Example response

HTTP/1.1 201 Created
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: POST, GET, PUT, OPTIONS, DELETE
Access-Control-Max-Age: 3600
Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Authorization
Content-Type: application/json;charset=UTF-8
Content-Length: 142

{
  "Code" : "help",
  "Name" : "Help",
  "Value" : "Help !!! Help!!!",
  "Description" : "Description",
  "Style" : "style",
  "Preset" : 1
}

Path	Type	Description
Name	String	Name of the article
Code	String	Code of the article
Value	String	Article content
Description	String	Article description
Style	String	Article style
Preset	String	Article preset

Update

Example request

PUT /organization/SUB/domain-application/12345/help-articles/test HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjU2Mjk0OTk1MzQyMTMxMjAsImV4cCI6MTUyODk2MDk1Nywicm9sZXMiOltdLCJkb21haW5BcHBSb2xlcyI6W10sInBlcm1pc3Npb25zIjpbIlJFVFJZX1dPUktGTE9XIiwiU1VQRVJBRE1JTiIsIkVSUk9SX01BTkFHRU1FTlQiLCJTVUJTQ1JJQkVSU19NQU5BR0VNRU5UIiwiQ1JFQVRFX1VTRVIiLCJFWEVDVVRFX0FDVElPTiIsIkNMSUVOVF9VU0VSU19NQU5BR0VNRU5UIiwiQVBQUk9WRV9DQU5DRUwiLCJSRVFVRVNUX0NBTkNFTCIsIlVTRVJTX01BTkFHRU1FTlQiLCJOT1RJRklDQVRJT05TX01BTkFHRU1FTlQiLCJHRVRfVVNFUlMiLCJSRVNPVVJDRVNfTUFOQUdFTUVOVCIsIkFDQ0VTU19BRE1JTl9QQUdFIiwiVVNFUl9ST0xFU19NQU5BR0VNRU5UIiwiQ0xJRU5UU19NQU5BR0VNRU5UIiwiSEVMUF9BUlRJQ0xFU19NQU5BR0VNRU5UIiwiU1RBUlRfV09SS0ZMT1ciXX0.CBOUjYRAE96Jh-BauNMKA4t0aKxyyHo34Lilz2OWgAn2SpL6fncv-Ch7elFFYWw1dX2i7aNmXBSFiBpJGdrujA
Host: corporateservices.com
Content-Length: 139

{
  "Name" : "Help updated",
  "Value" : "Help !!! Help!!! Help!!!",
  "Description" : "Description",
  "Style" : "style",
  "Preset" : 1
}

$ curl 'https://corporateservices.com:8080/organization/SUB/domain-application/12345/help-articles/test' -i -X PUT -H 'Content-Type: application/json' -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjU2Mjk0OTk1MzQyMTMxMjAsImV4cCI6MTUyODk2MDk1Nywicm9sZXMiOltdLCJkb21haW5BcHBSb2xlcyI6W10sInBlcm1pc3Npb25zIjpbIlJFVFJZX1dPUktGTE9XIiwiU1VQRVJBRE1JTiIsIkVSUk9SX01BTkFHRU1FTlQiLCJTVUJTQ1JJQkVSU19NQU5BR0VNRU5UIiwiQ1JFQVRFX1VTRVIiLCJFWEVDVVRFX0FDVElPTiIsIkNMSUVOVF9VU0VSU19NQU5BR0VNRU5UIiwiQVBQUk9WRV9DQU5DRUwiLCJSRVFVRVNUX0NBTkNFTCIsIlVTRVJTX01BTkFHRU1FTlQiLCJOT1RJRklDQVRJT05TX01BTkFHRU1FTlQiLCJHRVRfVVNFUlMiLCJSRVNPVVJDRVNfTUFOQUdFTUVOVCIsIkFDQ0VTU19BRE1JTl9QQUdFIiwiVVNFUl9ST0xFU19NQU5BR0VNRU5UIiwiQ0xJRU5UU19NQU5BR0VNRU5UIiwiSEVMUF9BUlRJQ0xFU19NQU5BR0VNRU5UIiwiU1RBUlRfV09SS0ZMT1ciXX0.CBOUjYRAE96Jh-BauNMKA4t0aKxyyHo34Lilz2OWgAn2SpL6fncv-Ch7elFFYWw1dX2i7aNmXBSFiBpJGdrujA' -d '{
  "Name" : "Help updated",
  "Value" : "Help !!! Help!!! Help!!!",
  "Description" : "Description",
  "Style" : "style",
  "Preset" : 1
}'

/organization/{organizationCode}/domain-application/{domainAppId}/help-articles/{articleCode}

Parameter	Description
organizationCode	Publisher organization code
domainAppId	Id of domain application
articleCode	Help article code

Path	Type	Description
Name	String	Name of the article
Value	String	Article content
Description	String	Article description
Style	String	Article style
Preset	String	Article preset

Example response

HTTP/1.1 200 OK
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: POST, GET, PUT, OPTIONS, DELETE
Access-Control-Max-Age: 3600
Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Authorization
Content-Type: application/json;charset=UTF-8
Content-Length: 158

{
  "Code" : "test",
  "Name" : "Help updated",
  "Value" : "Help !!! Help!!! Help!!!",
  "Description" : "Description",
  "Style" : "style",
  "Preset" : 1
}

Path	Type	Description
Name	String	Name of the article
Code	String	Code of the article
Value	String	Article content
Description	String	Article description
Style	String	Article style
Preset	String	Article preset

Delete

Example request

DELETE /organization/SUB/domain-application/12345/help-articles/help HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjU2Mjk0OTk1MzQyMTMxMjAsImV4cCI6MTUyODk2MDk1Nywicm9sZXMiOltdLCJkb21haW5BcHBSb2xlcyI6W10sInBlcm1pc3Npb25zIjpbIlJFVFJZX1dPUktGTE9XIiwiU1VQRVJBRE1JTiIsIkVSUk9SX01BTkFHRU1FTlQiLCJTVUJTQ1JJQkVSU19NQU5BR0VNRU5UIiwiQ1JFQVRFX1VTRVIiLCJFWEVDVVRFX0FDVElPTiIsIkNMSUVOVF9VU0VSU19NQU5BR0VNRU5UIiwiQVBQUk9WRV9DQU5DRUwiLCJSRVFVRVNUX0NBTkNFTCIsIlVTRVJTX01BTkFHRU1FTlQiLCJOT1RJRklDQVRJT05TX01BTkFHRU1FTlQiLCJHRVRfVVNFUlMiLCJSRVNPVVJDRVNfTUFOQUdFTUVOVCIsIkFDQ0VTU19BRE1JTl9QQUdFIiwiVVNFUl9ST0xFU19NQU5BR0VNRU5UIiwiQ0xJRU5UU19NQU5BR0VNRU5UIiwiSEVMUF9BUlRJQ0xFU19NQU5BR0VNRU5UIiwiU1RBUlRfV09SS0ZMT1ciXX0.CBOUjYRAE96Jh-BauNMKA4t0aKxyyHo34Lilz2OWgAn2SpL6fncv-Ch7elFFYWw1dX2i7aNmXBSFiBpJGdrujA
Host: corporateservices.com

$ curl 'https://corporateservices.com:8080/organization/SUB/domain-application/12345/help-articles/help' -i -X DELETE -H 'Content-Type: application/json' -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjU2Mjk0OTk1MzQyMTMxMjAsImV4cCI6MTUyODk2MDk1Nywicm9sZXMiOltdLCJkb21haW5BcHBSb2xlcyI6W10sInBlcm1pc3Npb25zIjpbIlJFVFJZX1dPUktGTE9XIiwiU1VQRVJBRE1JTiIsIkVSUk9SX01BTkFHRU1FTlQiLCJTVUJTQ1JJQkVSU19NQU5BR0VNRU5UIiwiQ1JFQVRFX1VTRVIiLCJFWEVDVVRFX0FDVElPTiIsIkNMSUVOVF9VU0VSU19NQU5BR0VNRU5UIiwiQVBQUk9WRV9DQU5DRUwiLCJSRVFVRVNUX0NBTkNFTCIsIlVTRVJTX01BTkFHRU1FTlQiLCJOT1RJRklDQVRJT05TX01BTkFHRU1FTlQiLCJHRVRfVVNFUlMiLCJSRVNPVVJDRVNfTUFOQUdFTUVOVCIsIkFDQ0VTU19BRE1JTl9QQUdFIiwiVVNFUl9ST0xFU19NQU5BR0VNRU5UIiwiQ0xJRU5UU19NQU5BR0VNRU5UIiwiSEVMUF9BUlRJQ0xFU19NQU5BR0VNRU5UIiwiU1RBUlRfV09SS0ZMT1ciXX0.CBOUjYRAE96Jh-BauNMKA4t0aKxyyHo34Lilz2OWgAn2SpL6fncv-Ch7elFFYWw1dX2i7aNmXBSFiBpJGdrujA'

/organization/{organizationCode}/domain-application/{domainAppId}/help-articles/{articleCode}

Parameter	Description
organizationCode	Publisher organization code
domainAppId	Id of domain application
articleCode	Help article code

Example response

HTTP/1.1 200 OK
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: POST, GET, PUT, OPTIONS, DELETE
Access-Control-Max-Age: 3600
Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Authorization

Subscribers for publisher

List

Example request

GET /organization/testOrg78/subscribers HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjU2Mjk0OTk1MzQyMTMxMjAsImV4cCI6MTUyODk2MDg4NCwib3JnQ29kZSI6InRlc3RPcmc3OCIsInJvbGVzIjpbXSwiZG9tYWluQXBwUm9sZXMiOltdLCJwZXJtaXNzaW9ucyI6W119.jxgSyc5407D3wHWOBxwG5fZUGpz1T-TqlqLE00h1Lrj1Y9rRGBTuiV5cb1FyFwHSC2tKUVYXUbmbRKID_uFsqw
Host: corporateservices.com

$ curl 'https://corporateservices.com:8080/organization/testOrg78/subscribers' -i -H 'Content-Type: application/json' -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjU2Mjk0OTk1MzQyMTMxMjAsImV4cCI6MTUyODk2MDg4NCwib3JnQ29kZSI6InRlc3RPcmc3OCIsInJvbGVzIjpbXSwiZG9tYWluQXBwUm9sZXMiOltdLCJwZXJtaXNzaW9ucyI6W119.jxgSyc5407D3wHWOBxwG5fZUGpz1T-TqlqLE00h1Lrj1Y9rRGBTuiV5cb1FyFwHSC2tKUVYXUbmbRKID_uFsqw'

/organization/{organizationCode}/subscribers

Parameter	Description
organizationCode	Publisher organization code

Example response

HTTP/1.1 200 OK
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: POST, GET, PUT, OPTIONS, DELETE
Access-Control-Max-Age: 3600
Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Authorization
Content-Type: application/json;charset=UTF-8
Content-Length: 692

[ {
  "Id" : "12345678-4567-7891-7895-789445611238",
  "Name" : "New subscriber",
  "Code" : "12345678-4567-7891-7895-789445611238",
  "Type" : "SUBSCRIBER",
  "TimeZone" : "America/Los_Angeles",
  "FormalName" : "New org subs",
  "WebsiteUrl" : "https://org.com",
  "Description" : "New org description",
  "PrimaryContactName" : "Org Director",
  "Title" : "SUPEROrg",
  "Phone" : "+987565465163854",
  "Email" : "org@gmail.com",
  "InternalNotes" : "Some notes",
  "IsCurrentUserAdmin" : false,
  "Subscriptions" : [ {
    "StartDate" : "2018-05-14T10:21:24.970+03:00",
    "EndDate" : "2018-05-15T00:00:00.000+03:00",
    "PublicSiteExpiryDate" : "2018-05-15T00:00:00.000+03:00"
  } ]
} ]

Path	Type	Description
[]	String	List of subscribers
[].Id	String	Subscriber organization id
[].Code	String	Subscriber organization code
[].Name	String	Subscriber organization name
[].TimeZone	String	Subscriber organization time zone
[].Type	String	Organization type (SUBSCRIBER always)
[].FormalName	String	Organization formal name
[].WebsiteUrl	String	Organization website URL
[].Description	String	Organization description
[].PrimaryContactName	String	Organization primary contact name
[].Title	String	Organization title
[].Phone	String	Organization phone
[].Email	String	Organization email
[].IsCurrentUserAdmin	Boolean	If current user is admin for this organization
[].InternalNotes	String	Organization notes
[].Subscriptions	Array	List of subscriptions (all expired, active and future)

Create

Example request

POST /organization/testOrg78/subscribers HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjU2Mjk0OTk1MzQyMTMxMjAsImV4cCI6MTUyODk2MDg4NCwib3JnQ29kZSI6InRlc3RPcmc3OCIsInJvbGVzIjpbXSwiZG9tYWluQXBwUm9sZXMiOltdLCJwZXJtaXNzaW9ucyI6W119.jxgSyc5407D3wHWOBxwG5fZUGpz1T-TqlqLE00h1Lrj1Y9rRGBTuiV5cb1FyFwHSC2tKUVYXUbmbRKID_uFsqw
Host: corporateservices.com
Content-Length: 438

{
  "Name" : "New subscriber",
  "Code" : "12345678-4567-7891-7895-789445611238",
  "TimeZone" : "America/Los_Angeles",
  "User" : {
    "Email" : "user@mail.com"
  },
  "FormalName" : "New org subs",
  "WebsiteUrl" : "https://org.com",
  "Description" : "New org description",
  "PrimaryContactName" : "Org Director",
  "Title" : "SUPEROrg",
  "Phone" : "+987565465163854",
  "Email" : "org@gmail.com",
  "InternalNotes" : "Some notes"
}

$ curl 'https://corporateservices.com:8080/organization/testOrg78/subscribers' -i -X POST -H 'Content-Type: application/json' -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjU2Mjk0OTk1MzQyMTMxMjAsImV4cCI6MTUyODk2MDg4NCwib3JnQ29kZSI6InRlc3RPcmc3OCIsInJvbGVzIjpbXSwiZG9tYWluQXBwUm9sZXMiOltdLCJwZXJtaXNzaW9ucyI6W119.jxgSyc5407D3wHWOBxwG5fZUGpz1T-TqlqLE00h1Lrj1Y9rRGBTuiV5cb1FyFwHSC2tKUVYXUbmbRKID_uFsqw' -d '{
  "Name" : "New subscriber",
  "Code" : "12345678-4567-7891-7895-789445611238",
  "TimeZone" : "America/Los_Angeles",
  "User" : {
    "Email" : "user@mail.com"
  },
  "FormalName" : "New org subs",
  "WebsiteUrl" : "https://org.com",
  "Description" : "New org description",
  "PrimaryContactName" : "Org Director",
  "Title" : "SUPEROrg",
  "Phone" : "+987565465163854",
  "Email" : "org@gmail.com",
  "InternalNotes" : "Some notes"
}'

/organization/{organizationCode}/subscribers

Parameter	Description
organizationCode	Publisher organization code

Path	Type	Description
Code	String	Subscriber organization code
Name	String	Subscriber organization name
TimeZone	String	Subscriber organization time zone
User	Object	Subscriber organization admin user
FormalName	String	Organization formal name
WebsiteUrl	String	Organization website URL
Description	String	Organization description
PrimaryContactName	String	Organization primary contact name
Title	String	Organization title
Phone	String	Organization phone
Email	String	Organization email
InternalNotes	String	Organization notes

Example response

HTTP/1.1 201 Created
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: POST, GET, PUT, OPTIONS, DELETE
Access-Control-Max-Age: 3600
Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Authorization
Content-Type: application/json;charset=UTF-8
Content-Length: 617

{
  "Id" : "12345678-4567-7891-7895-789445611238",
  "Name" : "New subscriber",
  "Code" : "12345678-4567-7891-7895-789445611238",
  "Type" : "SUBSCRIBER",
  "TimeZone" : "America/Los_Angeles",
  "User" : {
    "Id" : 5066549580791808,
    "FirstName" : "Mr. user",
    "Email" : "user@mail.com",
    "Active" : true,
    "Name" : "Mr. user"
  },
  "FormalName" : "New org subs",
  "WebsiteUrl" : "https://org.com",
  "Description" : "New org description",
  "PrimaryContactName" : "Org Director",
  "Title" : "SUPEROrg",
  "Phone" : "+987565465163854",
  "Email" : "org@gmail.com",
  "InternalNotes" : "Some notes"
}

Path	Type	Description
Id	String	Subscriber organization id
Code	String	Subscriber organization code
Name	String	Subscriber organization name
TimeZone	String	Subscriber organization time zone
User	Object	Subscriber organization admin user
Type	String	Organization type (SUBSCRIBER always)
FormalName	String	Organization formal name
WebsiteUrl	String	Organization website URL
Description	String	Organization description
PrimaryContactName	String	Organization primary contact name
Title	String	Organization title
Phone	String	Organization phone
Email	String	Organization email
InternalNotes	String	Organization notes

Update

Example request

POST /organization/testOrg78/subscribers/12345678-4567-7891-7895-789445611238 HTTP/1.1
Content-Type: multipart/form-data; boundary=6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjU2Mjk0OTk1MzQyMTMxMjAsImV4cCI6MTUyODk2MDg4NCwib3JnQ29kZSI6InRlc3RPcmc3OCIsInJvbGVzIjpbXSwiZG9tYWluQXBwUm9sZXMiOltdLCJwZXJtaXNzaW9ucyI6W119.jxgSyc5407D3wHWOBxwG5fZUGpz1T-TqlqLE00h1Lrj1Y9rRGBTuiV5cb1FyFwHSC2tKUVYXUbmbRKID_uFsqw
Host: corporateservices.com

--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Content-Disposition: form-data; name=Name

Subscriber organization name
--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Content-Disposition: form-data; name=TimeZone

America/Los_Angeles
--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Content-Disposition: form-data; name=isCurrentUserAdmin

true
--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Content-Disposition: form-data; name=FormalName

Organization formal name
--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Content-Disposition: form-data; name=WebsiteUrl

Organization website URL
--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Content-Disposition: form-data; name=Description

Organization description
--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Content-Disposition: form-data; name=PrimaryContactName

Organization primary contact name
--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Content-Disposition: form-data; name=Title

Organization title
--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Content-Disposition: form-data; name=Phone

Organization phone
--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Content-Disposition: form-data; name=Email

Organization email
--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Content-Disposition: form-data; name=InternalNotes

Organization notes
--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Content-Disposition: form-data; name=Logo

�PNG


IHDR


7n�$IDATx�b`
��W���IEND�B`�
--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm--

$ curl 'https://corporateservices.com:8080/organization/testOrg78/subscribers/12345678-4567-7891-7895-789445611238' -i -X POST -H 'Content-Type: multipart/form-data' -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjU2Mjk0OTk1MzQyMTMxMjAsImV4cCI6MTUyODk2MDg4NCwib3JnQ29kZSI6InRlc3RPcmc3OCIsInJvbGVzIjpbXSwiZG9tYWluQXBwUm9sZXMiOltdLCJwZXJtaXNzaW9ucyI6W119.jxgSyc5407D3wHWOBxwG5fZUGpz1T-TqlqLE00h1Lrj1Y9rRGBTuiV5cb1FyFwHSC2tKUVYXUbmbRKID_uFsqw' -F 'Logo=�PNG


IHDR


7n�$IDATx�b`
��W���IEND�B`�' -F 'Name=Subscriber organization name' -F 'TimeZone=America/Los_Angeles' -F 'isCurrentUserAdmin=true' -F 'FormalName=Organization formal name' -F 'WebsiteUrl=Organization website URL' -F 'Description=Organization description' -F 'PrimaryContactName=Organization primary contact name' -F 'Title=Organization title' -F 'Phone=Organization phone' -F 'Email=Organization email' -F 'InternalNotes=Organization notes'

/organization/{organizationCode}/subscribers/{subscriberOrgCode}

Parameter	Description
organizationCode	Publisher organization code
subscriberOrgCode	Subscriber organization code

Parameter	Description
Name	Subscriber organization name
TimeZone	Subscriber organization time zone
isCurrentUserAdmin	If current user should be set or removed as admin for organization
FormalName	Organization formal name
WebsiteUrl	Organization website URL
Description	Organization description
PrimaryContactName	Organization primary contact name
Title	Organization title
Phone	Organization phone
Email	Organization email
InternalNotes	Organization notes

Example response

HTTP/1.1 201 Created
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: POST, GET, PUT, OPTIONS, DELETE
Access-Control-Max-Age: 3600
Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Authorization
Content-Type: application/json;charset=UTF-8
Content-Length: 581

{
  "Id" : "12345678-4567-7891-7895-789445611238",
  "Name" : "Subscriber organization name",
  "Code" : "12345678-4567-7891-7895-789445611238",
  "Type" : "SUBSCRIBER",
  "TimeZone" : "America/Los_Angeles",
  "FormalName" : "Organization formal name",
  "WebsiteUrl" : "Organization website URL",
  "Description" : "Organization description",
  "PrimaryContactName" : "Organization primary contact name",
  "Title" : "Organization title",
  "Phone" : "Organization phone",
  "Email" : "Organization email",
  "InternalNotes" : "Organization notes",
  "IsCurrentUserAdmin" : true
}

Path	Type	Description
Id	String	Subscriber organization id
Code	String	Subscriber organization code
Name	String	Subscriber organization name
TimeZone	String	Subscriber organization time zone
Type	String	Organization type (SUBSCRIBER always)
FormalName	String	Organization formal name
WebsiteUrl	String	Organization website URL
Description	String	Organization description
PrimaryContactName	String	Organization primary contact name
Title	String	Organization title
Phone	String	Organization phone
Email	String	Organization email
IsCurrentUserAdmin	Boolean	If current user is admin for this organization
InternalNotes	String	Organization notes

Add new subscription

Example request

POST /organization/testOrg78/subscribers/12345678-4567-7891-7895-789445611238/subscriptions HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjU2Mjk0OTk1MzQyMTMxMjAsImV4cCI6MTUyODk2MDg4NCwib3JnQ29kZSI6InRlc3RPcmc3OCIsInJvbGVzIjpbXSwiZG9tYWluQXBwUm9sZXMiOltdLCJwZXJtaXNzaW9ucyI6W119.jxgSyc5407D3wHWOBxwG5fZUGpz1T-TqlqLE00h1Lrj1Y9rRGBTuiV5cb1FyFwHSC2tKUVYXUbmbRKID_uFsqw
Host: corporateservices.com
Content-Length: 797

{
  "Subscriber" : {
    "Name" : "New subscriber",
    "Code" : "12345678-4567-7891-7895-789445611238",
    "TimeZone" : "America/Los_Angeles",
    "User" : {
      "Email" : "user@mail.com"
    },
    "FormalName" : "New org subs",
    "WebsiteUrl" : "https://org.com",
    "Description" : "New org description",
    "PrimaryContactName" : "Org Director",
    "Title" : "SUPEROrg",
    "Phone" : "+987565465163854",
    "Email" : "org@gmail.com",
    "InternalNotes" : "Some notes"
  },
  "StartDate" : "2023-05-15T10:21:25.098+03:00",
  "EndDate" : "2028-05-15T10:21:25.098+03:00",
  "LicensingModelKey" : "ahRzfmF2b2NhZG8tYmFja2VuZC12MXI2CxIMT3JnYW5pemF0aW9uIglURVNUT1JHNzgMCxIOTGljZW5zaW5nTW9kZWwYgICAgICAoAgM",
  "Level" : "GOLD",
  "PublicSiteExpiryDate" : "2028-08-15T10:21:25.098+03:00"
}

$ curl 'https://corporateservices.com:8080/organization/testOrg78/subscribers/12345678-4567-7891-7895-789445611238/subscriptions' -i -X POST -H 'Content-Type: application/json' -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjU2Mjk0OTk1MzQyMTMxMjAsImV4cCI6MTUyODk2MDg4NCwib3JnQ29kZSI6InRlc3RPcmc3OCIsInJvbGVzIjpbXSwiZG9tYWluQXBwUm9sZXMiOltdLCJwZXJtaXNzaW9ucyI6W119.jxgSyc5407D3wHWOBxwG5fZUGpz1T-TqlqLE00h1Lrj1Y9rRGBTuiV5cb1FyFwHSC2tKUVYXUbmbRKID_uFsqw' -d '{
  "Subscriber" : {
    "Name" : "New subscriber",
    "Code" : "12345678-4567-7891-7895-789445611238",
    "TimeZone" : "America/Los_Angeles",
    "User" : {
      "Email" : "user@mail.com"
    },
    "FormalName" : "New org subs",
    "WebsiteUrl" : "https://org.com",
    "Description" : "New org description",
    "PrimaryContactName" : "Org Director",
    "Title" : "SUPEROrg",
    "Phone" : "+987565465163854",
    "Email" : "org@gmail.com",
    "InternalNotes" : "Some notes"
  },
  "StartDate" : "2023-05-15T10:21:25.098+03:00",
  "EndDate" : "2028-05-15T10:21:25.098+03:00",
  "LicensingModelKey" : "ahRzfmF2b2NhZG8tYmFja2VuZC12MXI2CxIMT3JnYW5pemF0aW9uIglURVNUT1JHNzgMCxIOTGljZW5zaW5nTW9kZWwYgICAgICAoAgM",
  "Level" : "GOLD",
  "PublicSiteExpiryDate" : "2028-08-15T10:21:25.098+03:00"
}'

/organization/{organizationCode}/subscribers/{subscriberOrgCode}/subscriptions

Parameter	Description
organizationCode	Publisher organization code
subscriberOrgCode	Subscriber organization code

Path	Type	Description
Subscriber	Object	Subscriber object
Subscriber.Code	String	Subscriber code
StartDate	String	Subscriber code
EndDate	String	Subscriber code
PublicSiteExpiryDate	String	Subscription public site expiry date
Level	String	Subscriber level
LicensingModelKey	String	Key string of licensing model

Example response

HTTP/1.1 201 Created
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: POST, GET, PUT, OPTIONS, DELETE
Access-Control-Max-Age: 3600
Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Authorization
Content-Type: application/json;charset=UTF-8
Content-Length: 529

{
  "CreatedOn" : "2018-05-15T10:21:25.116+03:00",
  "Id" : 4925812092436480,
  "Subscriber" : {
    "Code" : "12345678-4567-7891-7895-789445611238"
  },
  "DomainApplication" : {
    "Id" : 6473924464345088
  },
  "Status" : "ACTIVE",
  "StartDate" : "2023-05-15T07:21:25.098Z",
  "EndDate" : "2028-05-15T07:21:25.098Z",
  "LicensingModelKey" : "ahRzfmF2b2NhZG8tYmFja2VuZC12MXI2CxIMT3JnYW5pemF0aW9uIglURVNUT1JHNzgMCxIOTGljZW5zaW5nTW9kZWwYgICAgICAoAgM",
  "Level" : "GOLD",
  "PublicSiteExpiryDate" : "2028-08-15T07:21:25.098Z"
}

Path	Type	Description
Id	Number	Subscription id
Subscriber	Object	Subscriber object
Subscriber.Code	String	Subscriber code
StartDate	String	Subscription start date
EndDate	String	Subscription end date
PublicSiteExpiryDate	String	Subscription public site expiry date
Level	String	Subscriber level
CreatedOn	String	Date time when subscribed
DomainApplication	Object	Domain application object
DomainApplication.Id	Object	Domain application id
Status	Object	Subscription status
LicensingModelKey	Object	Licensing model key

Subscription levels for publisher

List

Example request

GET /organization/testOrg78/subscription-levels HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjU2Mjk0OTk1MzQyMTMxMjAsImV4cCI6MTUyODk2MDkyOCwicm9sZXMiOltdLCJkb21haW5BcHBSb2xlcyI6W10sInBlcm1pc3Npb25zIjpbIlJFVFJZX1dPUktGTE9XIiwiU1VQRVJBRE1JTiIsIkVSUk9SX01BTkFHRU1FTlQiLCJTVUJTQ1JJQkVSU19NQU5BR0VNRU5UIiwiQ1JFQVRFX1VTRVIiLCJFWEVDVVRFX0FDVElPTiIsIkNMSUVOVF9VU0VSU19NQU5BR0VNRU5UIiwiQVBQUk9WRV9DQU5DRUwiLCJSRVFVRVNUX0NBTkNFTCIsIlVTRVJTX01BTkFHRU1FTlQiLCJOT1RJRklDQVRJT05TX01BTkFHRU1FTlQiLCJHRVRfVVNFUlMiLCJSRVNPVVJDRVNfTUFOQUdFTUVOVCIsIkFDQ0VTU19BRE1JTl9QQUdFIiwiVVNFUl9ST0xFU19NQU5BR0VNRU5UIiwiQ0xJRU5UU19NQU5BR0VNRU5UIiwiSEVMUF9BUlRJQ0xFU19NQU5BR0VNRU5UIiwiU1RBUlRfV09SS0ZMT1ciXX0.IJu5l_pldkOXM0bBkwkUHREOQKJXBwagCE9oCW_GU9UYlntFuV6hOKsvCzdHfUbtbXYjusMiooeGcg_UFu15kw
Host: corporateservices.com

$ curl 'https://corporateservices.com:8080/organization/testOrg78/subscription-levels' -i -H 'Content-Type: application/json' -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjU2Mjk0OTk1MzQyMTMxMjAsImV4cCI6MTUyODk2MDkyOCwicm9sZXMiOltdLCJkb21haW5BcHBSb2xlcyI6W10sInBlcm1pc3Npb25zIjpbIlJFVFJZX1dPUktGTE9XIiwiU1VQRVJBRE1JTiIsIkVSUk9SX01BTkFHRU1FTlQiLCJTVUJTQ1JJQkVSU19NQU5BR0VNRU5UIiwiQ1JFQVRFX1VTRVIiLCJFWEVDVVRFX0FDVElPTiIsIkNMSUVOVF9VU0VSU19NQU5BR0VNRU5UIiwiQVBQUk9WRV9DQU5DRUwiLCJSRVFVRVNUX0NBTkNFTCIsIlVTRVJTX01BTkFHRU1FTlQiLCJOT1RJRklDQVRJT05TX01BTkFHRU1FTlQiLCJHRVRfVVNFUlMiLCJSRVNPVVJDRVNfTUFOQUdFTUVOVCIsIkFDQ0VTU19BRE1JTl9QQUdFIiwiVVNFUl9ST0xFU19NQU5BR0VNRU5UIiwiQ0xJRU5UU19NQU5BR0VNRU5UIiwiSEVMUF9BUlRJQ0xFU19NQU5BR0VNRU5UIiwiU1RBUlRfV09SS0ZMT1ciXX0.IJu5l_pldkOXM0bBkwkUHREOQKJXBwagCE9oCW_GU9UYlntFuV6hOKsvCzdHfUbtbXYjusMiooeGcg_UFu15kw'

/organization/{organizationCode}/subscription-levels

Parameter	Description
organizationCode	Publisher organization code

Example response

HTTP/1.1 200 OK
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: POST, GET, PUT, OPTIONS, DELETE
Access-Control-Max-Age: 3600
Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Authorization
Content-Type: application/json;charset=UTF-8
Content-Length: 614

[ {
  "Code" : "Gold",
  "Value" : 400,
  "Description" : "Gold level",
  "Prices" : [ {
    "FromDate" : "2018-05-13T10:22:08.558+03:00",
    "Price" : 500.0,
    "CreatedBy" : "Super Admin"
  } ]
}, {
  "Code" : "Platinum",
  "Value" : 600,
  "Description" : "Platinum level",
  "Prices" : [ {
    "FromDate" : "2018-05-13T10:22:08.559+03:00",
    "Price" : 100500.0,
    "CreatedBy" : "Super Admin"
  } ]
}, {
  "Code" : "Silver",
  "Value" : 200,
  "Description" : "Silver level",
  "Prices" : [ {
    "FromDate" : "2018-05-13T10:22:08.558+03:00",
    "Price" : 100.0,
    "CreatedBy" : "Super Admin"
  } ]
} ]

Path	Type	Description
[]	String	List of subscription levels
[].Code	String	Subscription level code
[].Description	String	Subscription level description
[].Prices	Array	Price history

Change price

Example request

POST /organization/testOrg78/subscription-levels/Gold/prices HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjU2Mjk0OTk1MzQyMTMxMjAsImV4cCI6MTUyODk2MDkyOCwicm9sZXMiOltdLCJkb21haW5BcHBSb2xlcyI6W10sInBlcm1pc3Npb25zIjpbIlJFVFJZX1dPUktGTE9XIiwiU1VQRVJBRE1JTiIsIkVSUk9SX01BTkFHRU1FTlQiLCJTVUJTQ1JJQkVSU19NQU5BR0VNRU5UIiwiQ1JFQVRFX1VTRVIiLCJFWEVDVVRFX0FDVElPTiIsIkNMSUVOVF9VU0VSU19NQU5BR0VNRU5UIiwiQVBQUk9WRV9DQU5DRUwiLCJSRVFVRVNUX0NBTkNFTCIsIlVTRVJTX01BTkFHRU1FTlQiLCJOT1RJRklDQVRJT05TX01BTkFHRU1FTlQiLCJHRVRfVVNFUlMiLCJSRVNPVVJDRVNfTUFOQUdFTUVOVCIsIkFDQ0VTU19BRE1JTl9QQUdFIiwiVVNFUl9ST0xFU19NQU5BR0VNRU5UIiwiQ0xJRU5UU19NQU5BR0VNRU5UIiwiSEVMUF9BUlRJQ0xFU19NQU5BR0VNRU5UIiwiU1RBUlRfV09SS0ZMT1ciXX0.IJu5l_pldkOXM0bBkwkUHREOQKJXBwagCE9oCW_GU9UYlntFuV6hOKsvCzdHfUbtbXYjusMiooeGcg_UFu15kw
Host: corporateservices.com
Content-Length: 52

{"Price": 123465.12, "Comment": "Gold is expensive"}

$ curl 'https://corporateservices.com:8080/organization/testOrg78/subscription-levels/Gold/prices' -i -X POST -H 'Content-Type: application/json' -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjU2Mjk0OTk1MzQyMTMxMjAsImV4cCI6MTUyODk2MDkyOCwicm9sZXMiOltdLCJkb21haW5BcHBSb2xlcyI6W10sInBlcm1pc3Npb25zIjpbIlJFVFJZX1dPUktGTE9XIiwiU1VQRVJBRE1JTiIsIkVSUk9SX01BTkFHRU1FTlQiLCJTVUJTQ1JJQkVSU19NQU5BR0VNRU5UIiwiQ1JFQVRFX1VTRVIiLCJFWEVDVVRFX0FDVElPTiIsIkNMSUVOVF9VU0VSU19NQU5BR0VNRU5UIiwiQVBQUk9WRV9DQU5DRUwiLCJSRVFVRVNUX0NBTkNFTCIsIlVTRVJTX01BTkFHRU1FTlQiLCJOT1RJRklDQVRJT05TX01BTkFHRU1FTlQiLCJHRVRfVVNFUlMiLCJSRVNPVVJDRVNfTUFOQUdFTUVOVCIsIkFDQ0VTU19BRE1JTl9QQUdFIiwiVVNFUl9ST0xFU19NQU5BR0VNRU5UIiwiQ0xJRU5UU19NQU5BR0VNRU5UIiwiSEVMUF9BUlRJQ0xFU19NQU5BR0VNRU5UIiwiU1RBUlRfV09SS0ZMT1ciXX0.IJu5l_pldkOXM0bBkwkUHREOQKJXBwagCE9oCW_GU9UYlntFuV6hOKsvCzdHfUbtbXYjusMiooeGcg_UFu15kw' -d '{"Price": 123465.12, "Comment": "Gold is expensive"}'

/organization/{organizationCode}/subscription-levels/{levelCode}/prices

Parameter	Description
organizationCode	Publisher organization code
levelCode	Subscription level code organization code

Example response

HTTP/1.1 200 OK
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: POST, GET, PUT, OPTIONS, DELETE
Access-Control-Max-Age: 3600
Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Authorization
Content-Type: application/json;charset=UTF-8
Content-Length: 396

{
  "Code" : "Gold",
  "Value" : 400,
  "Description" : "Gold level",
  "Prices" : [ {
    "FromDate" : "2018-05-13T10:22:08.558+03:00",
    "ToDate" : "2018-05-15T10:22:08.581+03:00",
    "Price" : 500.0,
    "CreatedBy" : "Super Admin"
  }, {
    "FromDate" : "2018-05-15T10:22:08.581+03:00",
    "Price" : 123465.12,
    "Comment" : "Gold is expensive",
    "CreatedBy" : "Super Admin"
  } ]
}

Path	Type	Description
Code	String	Subscription level code
Description	String	Subscription level description
Value	Array	Level value(for internal use0
Prices	Array	Price history

Supported workflows by subscriber

List

Example request

GET /organization/SD/supported-workflows HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjU2Mjk0OTk1MzQyMTMxMjAsImV4cCI6MTUyODk2MDk0Nywicm9sZXMiOltdLCJkb21haW5BcHBSb2xlcyI6W10sInBlcm1pc3Npb25zIjpbIlJFVFJZX1dPUktGTE9XIiwiU1VQRVJBRE1JTiIsIkVSUk9SX01BTkFHRU1FTlQiLCJTVUJTQ1JJQkVSU19NQU5BR0VNRU5UIiwiQ1JFQVRFX1VTRVIiLCJFWEVDVVRFX0FDVElPTiIsIkNMSUVOVF9VU0VSU19NQU5BR0VNRU5UIiwiQVBQUk9WRV9DQU5DRUwiLCJSRVFVRVNUX0NBTkNFTCIsIlVTRVJTX01BTkFHRU1FTlQiLCJOT1RJRklDQVRJT05TX01BTkFHRU1FTlQiLCJHRVRfVVNFUlMiLCJSRVNPVVJDRVNfTUFOQUdFTUVOVCIsIkFDQ0VTU19BRE1JTl9QQUdFIiwiVVNFUl9ST0xFU19NQU5BR0VNRU5UIiwiQ0xJRU5UU19NQU5BR0VNRU5UIiwiSEVMUF9BUlRJQ0xFU19NQU5BR0VNRU5UIiwiU1RBUlRfV09SS0ZMT1ciXX0.gvLmk2jvi3ayVg8k_i6e5QF6QLeb5pgHxRYYVeWy4zyIMPUW5VM5kxXT8kLLP7PWa-jh_ehH2S5N3vXbigK0dQ
Host: corporateservices.com

$ curl 'https://corporateservices.com:8080/organization/SD/supported-workflows' -i -H 'Content-Type: application/json' -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjU2Mjk0OTk1MzQyMTMxMjAsImV4cCI6MTUyODk2MDk0Nywicm9sZXMiOltdLCJkb21haW5BcHBSb2xlcyI6W10sInBlcm1pc3Npb25zIjpbIlJFVFJZX1dPUktGTE9XIiwiU1VQRVJBRE1JTiIsIkVSUk9SX01BTkFHRU1FTlQiLCJTVUJTQ1JJQkVSU19NQU5BR0VNRU5UIiwiQ1JFQVRFX1VTRVIiLCJFWEVDVVRFX0FDVElPTiIsIkNMSUVOVF9VU0VSU19NQU5BR0VNRU5UIiwiQVBQUk9WRV9DQU5DRUwiLCJSRVFVRVNUX0NBTkNFTCIsIlVTRVJTX01BTkFHRU1FTlQiLCJOT1RJRklDQVRJT05TX01BTkFHRU1FTlQiLCJHRVRfVVNFUlMiLCJSRVNPVVJDRVNfTUFOQUdFTUVOVCIsIkFDQ0VTU19BRE1JTl9QQUdFIiwiVVNFUl9ST0xFU19NQU5BR0VNRU5UIiwiQ0xJRU5UU19NQU5BR0VNRU5UIiwiSEVMUF9BUlRJQ0xFU19NQU5BR0VNRU5UIiwiU1RBUlRfV09SS0ZMT1ciXX0.gvLmk2jvi3ayVg8k_i6e5QF6QLeb5pgHxRYYVeWy4zyIMPUW5VM5kxXT8kLLP7PWa-jh_ehH2S5N3vXbigK0dQ'

/organization/{subsOrgCode}/supported-workflows

Parameter	Description
subsOrgCode	Subscriber organization code

Example response

HTTP/1.1 200 OK
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: POST, GET, PUT, OPTIONS, DELETE
Access-Control-Max-Age: 3600
Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Authorization
Content-Type: application/json;charset=UTF-8
Content-Length: 583

[ {
  "_Key" : "ahRzfmF2b2NhZG8tYmFja2VuZC12MXJGCxIMT3JnYW5pemF0aW9uIgNTR1AMCxIIV29ya2Zsb3ciI0NIQU5HRS1DT01QQU5ZLUlORk9STUFUSU9OLVdPUktGTE9XDA",
  "Name" : "Change Company Information",
  "Description" : "This is the Change Company Information form.",
  "Supported" : false
}, {
  "_Key" : "ahRzfmF2b2NhZG8tYmFja2VuZC12MXJQCxIMT3JnYW5pemF0aW9uIgNTR1AMCxIIV29ya2Zsb3ciLU5FVy1DT01QQU5ZLUlOQ09SUE9SQVRJT04tU0hPUlQtVkVSMi1XT1JLRkxPVww",
  "Name" : "Incorporate a New Company Quickly",
  "Description" : "Use this Workflow to Incorporate a New Company quickly.",
  "Supported" : false
} ]

Path	Type	Description
[]	Array	List of all subscribed workflows for subscriber
[0]._Key	String	Key of workflow
[0].Name	String	Workflow name
[0].Description	String	Workflow description
[0].Supported	Boolean	If this subscriber is going to support this workflow

Add workflow to supported

Example request

PUT /organization/SD/supported-workflows/ahRzfmF2b2NhZG8tYmFja2VuZC12MXJGCxIMT3JnYW5pemF0aW9uIgNTR1AMCxIIV29ya2Zsb3ciI0NIQU5HRS1DT01QQU5ZLUlORk9STUFUSU9OLVdPUktGTE9XDA HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjU2Mjk0OTk1MzQyMTMxMjAsImV4cCI6MTUyODk2MDk0Nywicm9sZXMiOltdLCJkb21haW5BcHBSb2xlcyI6W10sInBlcm1pc3Npb25zIjpbIlJFVFJZX1dPUktGTE9XIiwiU1VQRVJBRE1JTiIsIkVSUk9SX01BTkFHRU1FTlQiLCJTVUJTQ1JJQkVSU19NQU5BR0VNRU5UIiwiQ1JFQVRFX1VTRVIiLCJFWEVDVVRFX0FDVElPTiIsIkNMSUVOVF9VU0VSU19NQU5BR0VNRU5UIiwiQVBQUk9WRV9DQU5DRUwiLCJSRVFVRVNUX0NBTkNFTCIsIlVTRVJTX01BTkFHRU1FTlQiLCJOT1RJRklDQVRJT05TX01BTkFHRU1FTlQiLCJHRVRfVVNFUlMiLCJSRVNPVVJDRVNfTUFOQUdFTUVOVCIsIkFDQ0VTU19BRE1JTl9QQUdFIiwiVVNFUl9ST0xFU19NQU5BR0VNRU5UIiwiQ0xJRU5UU19NQU5BR0VNRU5UIiwiSEVMUF9BUlRJQ0xFU19NQU5BR0VNRU5UIiwiU1RBUlRfV09SS0ZMT1ciXX0.gvLmk2jvi3ayVg8k_i6e5QF6QLeb5pgHxRYYVeWy4zyIMPUW5VM5kxXT8kLLP7PWa-jh_ehH2S5N3vXbigK0dQ
Host: corporateservices.com

$ curl 'https://corporateservices.com:8080/organization/SD/supported-workflows/ahRzfmF2b2NhZG8tYmFja2VuZC12MXJGCxIMT3JnYW5pemF0aW9uIgNTR1AMCxIIV29ya2Zsb3ciI0NIQU5HRS1DT01QQU5ZLUlORk9STUFUSU9OLVdPUktGTE9XDA' -i -X PUT -H 'Content-Type: application/json' -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjU2Mjk0OTk1MzQyMTMxMjAsImV4cCI6MTUyODk2MDk0Nywicm9sZXMiOltdLCJkb21haW5BcHBSb2xlcyI6W10sInBlcm1pc3Npb25zIjpbIlJFVFJZX1dPUktGTE9XIiwiU1VQRVJBRE1JTiIsIkVSUk9SX01BTkFHRU1FTlQiLCJTVUJTQ1JJQkVSU19NQU5BR0VNRU5UIiwiQ1JFQVRFX1VTRVIiLCJFWEVDVVRFX0FDVElPTiIsIkNMSUVOVF9VU0VSU19NQU5BR0VNRU5UIiwiQVBQUk9WRV9DQU5DRUwiLCJSRVFVRVNUX0NBTkNFTCIsIlVTRVJTX01BTkFHRU1FTlQiLCJOT1RJRklDQVRJT05TX01BTkFHRU1FTlQiLCJHRVRfVVNFUlMiLCJSRVNPVVJDRVNfTUFOQUdFTUVOVCIsIkFDQ0VTU19BRE1JTl9QQUdFIiwiVVNFUl9ST0xFU19NQU5BR0VNRU5UIiwiQ0xJRU5UU19NQU5BR0VNRU5UIiwiSEVMUF9BUlRJQ0xFU19NQU5BR0VNRU5UIiwiU1RBUlRfV09SS0ZMT1ciXX0.gvLmk2jvi3ayVg8k_i6e5QF6QLeb5pgHxRYYVeWy4zyIMPUW5VM5kxXT8kLLP7PWa-jh_ehH2S5N3vXbigK0dQ'

/organization/{subsOrgCode}/supported-workflows/{workflowId}

Parameter	Description
subsOrgCode	Subscriber organization code
workflowId	Id of workflow that should be added to supported

Example response

HTTP/1.1 200 OK
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: POST, GET, PUT, OPTIONS, DELETE
Access-Control-Max-Age: 3600
Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Authorization
Content-Type: application/json;charset=UTF-8
Content-Length: 582

[ {
  "_Key" : "ahRzfmF2b2NhZG8tYmFja2VuZC12MXJGCxIMT3JnYW5pemF0aW9uIgNTR1AMCxIIV29ya2Zsb3ciI0NIQU5HRS1DT01QQU5ZLUlORk9STUFUSU9OLVdPUktGTE9XDA",
  "Name" : "Change Company Information",
  "Description" : "This is the Change Company Information form.",
  "Supported" : true
}, {
  "_Key" : "ahRzfmF2b2NhZG8tYmFja2VuZC12MXJQCxIMT3JnYW5pemF0aW9uIgNTR1AMCxIIV29ya2Zsb3ciLU5FVy1DT01QQU5ZLUlOQ09SUE9SQVRJT04tU0hPUlQtVkVSMi1XT1JLRkxPVww",
  "Name" : "Incorporate a New Company Quickly",
  "Description" : "Use this Workflow to Incorporate a New Company quickly.",
  "Supported" : false
} ]

Path	Type	Description
[]	Array	List of all subscribed workflows for subscriber
[0]._Key	String	Key of workflow
[0].Name	String	Workflow name
[0].Description	String	Workflow description
[0].Supported	Boolean	If this subscriber is going to support this workflow

Delete workflow from supported

Example request

DELETE /organization/SD/supported-workflows/ahRzfmF2b2NhZG8tYmFja2VuZC12MXJGCxIMT3JnYW5pemF0aW9uIgNTR1AMCxIIV29ya2Zsb3ciI0NIQU5HRS1DT01QQU5ZLUlORk9STUFUSU9OLVdPUktGTE9XDA HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjU2Mjk0OTk1MzQyMTMxMjAsImV4cCI6MTUyODk2MDk0Nywicm9sZXMiOltdLCJkb21haW5BcHBSb2xlcyI6W10sInBlcm1pc3Npb25zIjpbIlJFVFJZX1dPUktGTE9XIiwiU1VQRVJBRE1JTiIsIkVSUk9SX01BTkFHRU1FTlQiLCJTVUJTQ1JJQkVSU19NQU5BR0VNRU5UIiwiQ1JFQVRFX1VTRVIiLCJFWEVDVVRFX0FDVElPTiIsIkNMSUVOVF9VU0VSU19NQU5BR0VNRU5UIiwiQVBQUk9WRV9DQU5DRUwiLCJSRVFVRVNUX0NBTkNFTCIsIlVTRVJTX01BTkFHRU1FTlQiLCJOT1RJRklDQVRJT05TX01BTkFHRU1FTlQiLCJHRVRfVVNFUlMiLCJSRVNPVVJDRVNfTUFOQUdFTUVOVCIsIkFDQ0VTU19BRE1JTl9QQUdFIiwiVVNFUl9ST0xFU19NQU5BR0VNRU5UIiwiQ0xJRU5UU19NQU5BR0VNRU5UIiwiSEVMUF9BUlRJQ0xFU19NQU5BR0VNRU5UIiwiU1RBUlRfV09SS0ZMT1ciXX0.gvLmk2jvi3ayVg8k_i6e5QF6QLeb5pgHxRYYVeWy4zyIMPUW5VM5kxXT8kLLP7PWa-jh_ehH2S5N3vXbigK0dQ
Host: corporateservices.com

$ curl 'https://corporateservices.com:8080/organization/SD/supported-workflows/ahRzfmF2b2NhZG8tYmFja2VuZC12MXJGCxIMT3JnYW5pemF0aW9uIgNTR1AMCxIIV29ya2Zsb3ciI0NIQU5HRS1DT01QQU5ZLUlORk9STUFUSU9OLVdPUktGTE9XDA' -i -X DELETE -H 'Content-Type: application/json' -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjU2Mjk0OTk1MzQyMTMxMjAsImV4cCI6MTUyODk2MDk0Nywicm9sZXMiOltdLCJkb21haW5BcHBSb2xlcyI6W10sInBlcm1pc3Npb25zIjpbIlJFVFJZX1dPUktGTE9XIiwiU1VQRVJBRE1JTiIsIkVSUk9SX01BTkFHRU1FTlQiLCJTVUJTQ1JJQkVSU19NQU5BR0VNRU5UIiwiQ1JFQVRFX1VTRVIiLCJFWEVDVVRFX0FDVElPTiIsIkNMSUVOVF9VU0VSU19NQU5BR0VNRU5UIiwiQVBQUk9WRV9DQU5DRUwiLCJSRVFVRVNUX0NBTkNFTCIsIlVTRVJTX01BTkFHRU1FTlQiLCJOT1RJRklDQVRJT05TX01BTkFHRU1FTlQiLCJHRVRfVVNFUlMiLCJSRVNPVVJDRVNfTUFOQUdFTUVOVCIsIkFDQ0VTU19BRE1JTl9QQUdFIiwiVVNFUl9ST0xFU19NQU5BR0VNRU5UIiwiQ0xJRU5UU19NQU5BR0VNRU5UIiwiSEVMUF9BUlRJQ0xFU19NQU5BR0VNRU5UIiwiU1RBUlRfV09SS0ZMT1ciXX0.gvLmk2jvi3ayVg8k_i6e5QF6QLeb5pgHxRYYVeWy4zyIMPUW5VM5kxXT8kLLP7PWa-jh_ehH2S5N3vXbigK0dQ'

/organization/{subsOrgCode}/supported-workflows/{workflowId}

Parameter	Description
subsOrgCode	Subscriber organization code
workflowId	Id of workflow that should be added to supported

Example response

HTTP/1.1 200 OK
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: POST, GET, PUT, OPTIONS, DELETE
Access-Control-Max-Age: 3600
Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Authorization
Content-Type: application/json;charset=UTF-8
Content-Length: 583

[ {
  "_Key" : "ahRzfmF2b2NhZG8tYmFja2VuZC12MXJGCxIMT3JnYW5pemF0aW9uIgNTR1AMCxIIV29ya2Zsb3ciI0NIQU5HRS1DT01QQU5ZLUlORk9STUFUSU9OLVdPUktGTE9XDA",
  "Name" : "Change Company Information",
  "Description" : "This is the Change Company Information form.",
  "Supported" : false
}, {
  "_Key" : "ahRzfmF2b2NhZG8tYmFja2VuZC12MXJQCxIMT3JnYW5pemF0aW9uIgNTR1AMCxIIV29ya2Zsb3ciLU5FVy1DT01QQU5ZLUlOQ09SUE9SQVRJT04tU0hPUlQtVkVSMi1XT1JLRkxPVww",
  "Name" : "Incorporate a New Company Quickly",
  "Description" : "Use this Workflow to Incorporate a New Company quickly.",
  "Supported" : false
} ]

Path	Type	Description
[]	Array	List of all subscribed workflows for subscriber
[0]._Key	String	Key of workflow
[0].Name	String	Workflow name
[0].Description	String	Workflow description
[0].Supported	Boolean	If this subscriber is going to support this workflow

Master data search

List searchable entity definitions

Example request

GET /organization/SD/domain-entities/searchable HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjU2Mjk0OTk1MzQyMTMxMjAsImV4cCI6MTUyODk2MDkyOCwicm9sZXMiOltdLCJkb21haW5BcHBSb2xlcyI6W10sInBlcm1pc3Npb25zIjpbIlJFVFJZX1dPUktGTE9XIiwiU1VQRVJBRE1JTiIsIkVSUk9SX01BTkFHRU1FTlQiLCJTVUJTQ1JJQkVSU19NQU5BR0VNRU5UIiwiQ1JFQVRFX1VTRVIiLCJFWEVDVVRFX0FDVElPTiIsIkNMSUVOVF9VU0VSU19NQU5BR0VNRU5UIiwiQVBQUk9WRV9DQU5DRUwiLCJSRVFVRVNUX0NBTkNFTCIsIlVTRVJTX01BTkFHRU1FTlQiLCJOT1RJRklDQVRJT05TX01BTkFHRU1FTlQiLCJHRVRfVVNFUlMiLCJSRVNPVVJDRVNfTUFOQUdFTUVOVCIsIkFDQ0VTU19BRE1JTl9QQUdFIiwiVVNFUl9ST0xFU19NQU5BR0VNRU5UIiwiQ0xJRU5UU19NQU5BR0VNRU5UIiwiSEVMUF9BUlRJQ0xFU19NQU5BR0VNRU5UIiwiU1RBUlRfV09SS0ZMT1ciXX0.IJu5l_pldkOXM0bBkwkUHREOQKJXBwagCE9oCW_GU9UYlntFuV6hOKsvCzdHfUbtbXYjusMiooeGcg_UFu15kw
Host: corporateservices.com

$ curl 'https://corporateservices.com:8080/organization/SD/domain-entities/searchable' -i -H 'Content-Type: application/json' -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjU2Mjk0OTk1MzQyMTMxMjAsImV4cCI6MTUyODk2MDkyOCwicm9sZXMiOltdLCJkb21haW5BcHBSb2xlcyI6W10sInBlcm1pc3Npb25zIjpbIlJFVFJZX1dPUktGTE9XIiwiU1VQRVJBRE1JTiIsIkVSUk9SX01BTkFHRU1FTlQiLCJTVUJTQ1JJQkVSU19NQU5BR0VNRU5UIiwiQ1JFQVRFX1VTRVIiLCJFWEVDVVRFX0FDVElPTiIsIkNMSUVOVF9VU0VSU19NQU5BR0VNRU5UIiwiQVBQUk9WRV9DQU5DRUwiLCJSRVFVRVNUX0NBTkNFTCIsIlVTRVJTX01BTkFHRU1FTlQiLCJOT1RJRklDQVRJT05TX01BTkFHRU1FTlQiLCJHRVRfVVNFUlMiLCJSRVNPVVJDRVNfTUFOQUdFTUVOVCIsIkFDQ0VTU19BRE1JTl9QQUdFIiwiVVNFUl9ST0xFU19NQU5BR0VNRU5UIiwiQ0xJRU5UU19NQU5BR0VNRU5UIiwiSEVMUF9BUlRJQ0xFU19NQU5BR0VNRU5UIiwiU1RBUlRfV09SS0ZMT1ciXX0.IJu5l_pldkOXM0bBkwkUHREOQKJXBwagCE9oCW_GU9UYlntFuV6hOKsvCzdHfUbtbXYjusMiooeGcg_UFu15kw'

/organization/{subsOrgCode}/domain-entities/searchable

Parameter	Description
subsOrgCode	Subscriber organization code

Example response

HTTP/1.1 200 OK
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: POST, GET, PUT, OPTIONS, DELETE
Access-Control-Max-Age: 3600
Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Authorization
Content-Type: application/json;charset=UTF-8
Content-Length: 17240

[ {
  "Id" : "COMPANY",
  "Code" : "Company",
  "Properties" : [ {
    "Code" : "ACRARegNum",
    "Editable" : true,
    "Indexed" : true,
    "Required" : false,
    "Searchable" : false,
    "VisibleInSearch" : false,
    "MaxLength" : 20,
    "MinLength" : 3,
    "MinValue" : "",
    "MaxValue" : "",
    "Type" : "STRING",
    "Name" : "ACRA_Registration Number"
  }, {
    "Code" : "ActivityCode1",
    "ReferenceEntity" : {
      "Id" : "DICTSSICCODE",
      "Code" : "DictSSICCode",
      "Properties" : [ ],
      "Type" : "DICTIONARY",
      "Name" : "DictSSICCode",
      "Searchable" : false
    },
    "Editable" : true,
    "Indexed" : false,
    "Required" : false,
    "Searchable" : false,
    "VisibleInSearch" : false,
    "Type" : "DICTIONARY",
    "Name" : "Activity Code 1"
  }, {
    "Code" : "ActivityCode2",
    "ReferenceEntity" : {
      "Id" : "DICTSSICCODE",
      "Code" : "DictSSICCode",
      "Properties" : [ ],
      "Type" : "DICTIONARY",
      "Name" : "DictSSICCode",
      "Searchable" : false
    },
    "Editable" : true,
    "Indexed" : false,
    "Required" : false,
    "Searchable" : false,
    "VisibleInSearch" : false,
    "Type" : "DICTIONARY",
    "Name" : "Activity Code 2"
  }, {
    "Code" : "ActivityDesc1",
    "Editable" : true,
    "Indexed" : false,
    "Required" : false,
    "Searchable" : false,
    "VisibleInSearch" : false,
    "MaxLength" : 70,
    "MinLength" : 3,
    "MinValue" : "",
    "MaxValue" : "",
    "Type" : "STRING",
    "Name" : "Activity Desc 1"
  }, {
    "Code" : "ActivityDesc2",
    "Editable" : true,
    "Indexed" : false,
    "Required" : false,
    "Searchable" : false,
    "VisibleInSearch" : false,
    "MaxLength" : 70,
    "MinLength" : 3,
    "MinValue" : "",
    "MaxValue" : "",
    "Type" : "STRING",
    "Name" : "Activity Desc 2"
  }, {
    "Code" : "AnnualRevenue",
    "Editable" : true,
    "Indexed" : false,
    "Required" : false,
    "Searchable" : false,
    "VisibleInSearch" : false,
    "Type" : "MONEY",
    "Name" : "Annual Revenue"
  }, {
    "Code" : "ApplDate",
    "Editable" : true,
    "Indexed" : false,
    "Required" : false,
    "Searchable" : false,
    "VisibleInSearch" : false,
    "Type" : "DATETIME",
    "Name" : "ACRA_Application Date"
  }, {
    "Code" : "ApplNum",
    "Editable" : true,
    "Indexed" : true,
    "Required" : false,
    "Searchable" : false,
    "VisibleInSearch" : false,
    "MaxLength" : 20,
    "MinLength" : 3,
    "Type" : "STRING",
    "Name" : "ACRA_Application Number"
  }, {
    "Code" : "CDDComplianceStatus",
    "ReferenceEntity" : {
      "Id" : "DICTCDDCOMPLIANCESTATUS",
      "Code" : "DictCDDComplianceStatus",
      "Properties" : [ ],
      "Type" : "DICTIONARY",
      "Name" : "DictCDDComplianceStatus",
      "Searchable" : false
    },
    "Editable" : true,
    "Indexed" : false,
    "Required" : false,
    "Searchable" : false,
    "VisibleInSearch" : false,
    "Type" : "DICTIONARY",
    "Name" : "CDD Compliance Status"
  }, {
    "Code" : "CompanyClientId",
    "ReferenceEntity" : {
      "Id" : "CLIENT_ENTITY",
      "Code" : "Client_Entity",
      "Properties" : [ ],
      "Type" : "CLIENT_ENTITY",
      "Name" : "Client Entity",
      "Searchable" : false
    },
    "Editable" : true,
    "Indexed" : true,
    "Required" : false,
    "Searchable" : false,
    "VisibleInSearch" : false,
    "Type" : "ENTITY",
    "Name" : "Company Client Id"
  }, {
    "Code" : "CompanyDocument",
    "ReferenceEntity" : {
      "Id" : "COMPANYDOCUMENT",
      "Code" : "CompanyDocument",
      "Properties" : [ ],
      "Type" : "BUSINESS",
      "Name" : "CompanyDocument",
      "Searchable" : false
    },
    "Editable" : true,
    "Indexed" : false,
    "Required" : false,
    "Searchable" : false,
    "VisibleInSearch" : false,
    "Type" : "LIST",
    "Name" : "CompanyDocument"
  }, {
    "Code" : "CompanyFKAName",
    "Editable" : false,
    "Indexed" : false,
    "Required" : false,
    "Searchable" : false,
    "VisibleInSearch" : false,
    "MaxLength" : 100,
    "MinLength" : 3,
    "MinValue" : "",
    "MaxValue" : "",
    "Type" : "STRING",
    "Name" : "Company FKA Name"
  }, {
    "Code" : "CompanyName",
    "Editable" : true,
    "Indexed" : true,
    "Required" : false,
    "Searchable" : true,
    "VisibleInSearch" : true,
    "MaxLength" : 100,
    "MinLength" : 3,
    "MinValue" : "",
    "MaxValue" : "",
    "Type" : "STRING",
    "Name" : "Company Name"
  }, {
    "Code" : "CompanySuffix",
    "ReferenceEntity" : {
      "Id" : "DICTCOMPANYSUFFIX",
      "Code" : "DictCompanySuffix",
      "Properties" : [ ],
      "Type" : "DICTIONARY",
      "Name" : "DictCompanySuffix",
      "Searchable" : false
    },
    "Editable" : true,
    "Indexed" : false,
    "Required" : false,
    "Searchable" : false,
    "VisibleInSearch" : false,
    "Type" : "DICTIONARY",
    "Name" : "Company Suffix"
  }, {
    "Code" : "CompanyType",
    "ReferenceEntity" : {
      "Id" : "DICTCOMPANYTYPE",
      "Code" : "DictCompanyType",
      "Properties" : [ ],
      "Type" : "DICTIONARY",
      "Name" : "DictCompanyType",
      "Searchable" : false
    },
    "Editable" : true,
    "Indexed" : false,
    "Required" : false,
    "Searchable" : true,
    "VisibleInSearch" : true,
    "Type" : "DICTIONARY",
    "Name" : "Company Type"
  }, {
    "Code" : "ConstitutionDoc",
    "ReferenceEntity" : {
      "Id" : "BUSINESSDOCUMENT",
      "Code" : "BusinessDocument",
      "Properties" : [ ],
      "Type" : "BUSINESS",
      "Name" : "Business Document",
      "Searchable" : false
    },
    "Editable" : true,
    "Indexed" : false,
    "Required" : false,
    "Searchable" : false,
    "VisibleInSearch" : false,
    "Type" : "DOCUMENTENTITY",
    "Name" : "Constitutin document"
  }, {
    "Code" : "CustomMAADocID",
    "Editable" : true,
    "Indexed" : false,
    "Required" : false,
    "Searchable" : false,
    "VisibleInSearch" : false,
    "MaxLength" : 100,
    "MinLength" : 3,
    "MinValue" : "",
    "MaxValue" : "",
    "Type" : "STRING",
    "Name" : "Custom MAA Doc ID"
  }, {
    "Code" : "FYEDayOfMonth",
    "Editable" : true,
    "Indexed" : false,
    "Required" : false,
    "Searchable" : false,
    "VisibleInSearch" : false,
    "MaxLength" : 2,
    "MinLength" : 1,
    "MinValue" : "1",
    "MaxValue" : "31",
    "Type" : "NUMBER",
    "Name" : "FYE Day of Month"
  }, {
    "Code" : "FYEMonth",
    "Editable" : true,
    "Indexed" : false,
    "Required" : false,
    "Searchable" : false,
    "VisibleInSearch" : false,
    "MaxLength" : 2,
    "MinLength" : 1,
    "MinValue" : "1",
    "MaxValue" : "12",
    "Type" : "NUMBER",
    "Name" : "FYE Month"
  }, {
    "Code" : "hasCustomMAA",
    "Editable" : true,
    "Indexed" : false,
    "Required" : false,
    "Searchable" : false,
    "VisibleInSearch" : false,
    "Type" : "BOOLEAN",
    "Name" : "Has Custom MAA"
  }, {
    "Code" : "ModelMAAVerNum",
    "ReferenceEntity" : {
      "Id" : "DICTMODELMAAVERSION",
      "Code" : "DictModelMAAVersion",
      "Properties" : [ ],
      "Type" : "DICTIONARY",
      "Name" : "DictModelMAAVersion",
      "Searchable" : false
    },
    "Editable" : true,
    "Indexed" : false,
    "Required" : false,
    "Searchable" : false,
    "VisibleInSearch" : false,
    "Type" : "DICTIONARY",
    "Name" : "Model MAA Version"
  }, {
    "Code" : "NextFYEdate",
    "Editable" : true,
    "Indexed" : false,
    "Required" : false,
    "Searchable" : false,
    "VisibleInSearch" : false,
    "Type" : "DATETIME",
    "Name" : "Next FYE Date"
  }, {
    "Code" : "PaymentComplianceStatus",
    "ReferenceEntity" : {
      "Id" : "DICTPAYMENTCOMPLIANCESTATUS",
      "Code" : "DictPaymentComplianceStatus",
      "Properties" : [ ],
      "Type" : "DICTIONARY",
      "Name" : "DictPaymentComplianceStatus",
      "Searchable" : false
    },
    "Editable" : true,
    "Indexed" : false,
    "Required" : false,
    "Searchable" : false,
    "VisibleInSearch" : false,
    "Type" : "DICTIONARY",
    "Name" : "Payment Compliance Status"
  }, {
    "Code" : "RegAddr",
    "ReferenceEntity" : {
      "Id" : "ADDRESS",
      "Code" : "Address",
      "Properties" : [ ],
      "Type" : "BUSINESS",
      "Name" : "Address",
      "Searchable" : false
    },
    "Editable" : true,
    "Indexed" : false,
    "Required" : false,
    "Searchable" : false,
    "VisibleInSearch" : false,
    "Type" : "ENTITY",
    "Name" : "Registered Address"
  }, {
    "Code" : "RegDate",
    "Editable" : true,
    "Indexed" : false,
    "Required" : false,
    "Searchable" : false,
    "VisibleInSearch" : false,
    "Type" : "DATETIME",
    "Name" : "ACRA_Registration Date"
  }, {
    "Code" : "ResidentialAddressProof",
    "ReferenceEntity" : {
      "Id" : "BUSINESSDOCUMENT",
      "Code" : "BusinessDocument",
      "Properties" : [ ],
      "Type" : "BUSINESS",
      "Name" : "Business Document",
      "Searchable" : false
    },
    "Editable" : true,
    "Indexed" : false,
    "Required" : false,
    "Searchable" : false,
    "VisibleInSearch" : false,
    "Type" : "DOCUMENTENTITY",
    "Name" : "Proof of Residential Address"
  }, {
    "Code" : "ShareCapital",
    "ReferenceEntity" : {
      "Id" : "SHARECAPITAL",
      "Code" : "ShareCapital",
      "Properties" : [ ],
      "Type" : "BUSINESS",
      "Name" : "ShareCapital",
      "Searchable" : false
    },
    "Editable" : true,
    "Indexed" : false,
    "Required" : false,
    "Searchable" : false,
    "VisibleInSearch" : false,
    "Type" : "LIST",
    "Name" : "ShareCapital"
  }, {
    "Code" : "StatutoryComplianceStatus",
    "ReferenceEntity" : {
      "Id" : "DICTSTATUTORYCOMPLIANCESTATUS",
      "Code" : "DictStatutoryComplianceStatus",
      "Properties" : [ ],
      "Type" : "DICTIONARY",
      "Name" : "DictStatutoryComplianceStatus",
      "Searchable" : false
    },
    "Editable" : true,
    "Indexed" : false,
    "Required" : false,
    "Searchable" : false,
    "VisibleInSearch" : false,
    "Type" : "DICTIONARY",
    "Name" : "Statutory Compliance Status"
  } ],
  "Type" : "BUSINESS",
  "Name" : "Company",
  "Searchable" : true
}, {
  "Id" : "PERSON",
  "Code" : "Person",
  "Properties" : [ {
    "Code" : "DOB",
    "Editable" : true,
    "Indexed" : false,
    "Required" : false,
    "Searchable" : false,
    "VisibleInSearch" : false,
    "Type" : "DATETIME",
    "Name" : "Date of Birth"
  }, {
    "Code" : "EmailID",
    "Editable" : true,
    "Indexed" : true,
    "Required" : false,
    "Searchable" : true,
    "VisibleInSearch" : false,
    "Type" : "STRING",
    "Name" : "Email ID"
  }, {
    "Code" : "HomeAddress",
    "ReferenceEntity" : {
      "Id" : "ADDRESS",
      "Code" : "Address",
      "Properties" : [ ],
      "Type" : "BUSINESS",
      "Name" : "Address",
      "Searchable" : false
    },
    "Editable" : true,
    "Indexed" : false,
    "Required" : false,
    "Searchable" : false,
    "VisibleInSearch" : false,
    "Type" : "ENTITY",
    "Name" : "Home Address"
  }, {
    "Code" : "HomePhone",
    "Editable" : true,
    "Indexed" : false,
    "Required" : false,
    "Searchable" : false,
    "VisibleInSearch" : false,
    "Type" : "STRING",
    "Name" : "Home Phone"
  }, {
    "Code" : "IDExpiryDate",
    "Editable" : true,
    "Indexed" : false,
    "Required" : false,
    "Searchable" : false,
    "VisibleInSearch" : false,
    "Type" : "DATETIME",
    "Name" : "ID Expiry Date"
  }, {
    "Code" : "IDNum",
    "Editable" : true,
    "Indexed" : true,
    "Required" : false,
    "Searchable" : true,
    "VisibleInSearch" : false,
    "Type" : "STRING",
    "Name" : "ID Number"
  }, {
    "Code" : "IDType",
    "ReferenceEntity" : {
      "Id" : "DICTIDTYPE",
      "Code" : "DictIDType",
      "Properties" : [ ],
      "Type" : "DICTIONARY",
      "Name" : "DictIDType",
      "Searchable" : false
    },
    "Editable" : true,
    "Indexed" : true,
    "Required" : false,
    "Searchable" : true,
    "VisibleInSearch" : false,
    "Type" : "DICTIONARY",
    "Name" : "ID Type"
  }, {
    "Code" : "MailingAddress",
    "ReferenceEntity" : {
      "Id" : "ADDRESS",
      "Code" : "Address",
      "Properties" : [ ],
      "Type" : "BUSINESS",
      "Name" : "Address",
      "Searchable" : false
    },
    "Editable" : true,
    "Indexed" : false,
    "Required" : false,
    "Searchable" : false,
    "VisibleInSearch" : false,
    "Type" : "ENTITY",
    "Name" : "Mailing Address"
  }, {
    "Code" : "MobilePhone",
    "Editable" : true,
    "Indexed" : false,
    "Required" : false,
    "Searchable" : false,
    "VisibleInSearch" : false,
    "Type" : "STRING",
    "Name" : "Mobile Phone"
  }, {
    "Code" : "Nationality",
    "ReferenceEntity" : {
      "Id" : "DICTNATIONALITY",
      "Code" : "DictNationality",
      "Properties" : [ ],
      "Type" : "DICTIONARY",
      "Name" : "DictNationality",
      "Searchable" : false
    },
    "Editable" : true,
    "Indexed" : false,
    "Required" : false,
    "Searchable" : false,
    "VisibleInSearch" : false,
    "Type" : "DICTIONARY",
    "Name" : "Nationality"
  }, {
    "Code" : "NRICType",
    "ReferenceEntity" : {
      "Id" : "DICTNRICTYPE",
      "Code" : "DictNRICType",
      "Properties" : [ ],
      "Type" : "DICTIONARY",
      "Name" : "DictNRICType",
      "Searchable" : false
    },
    "Editable" : true,
    "Indexed" : true,
    "Required" : false,
    "Searchable" : true,
    "VisibleInSearch" : false,
    "Type" : "DICTIONARY",
    "Name" : "NRIC Type"
  }, {
    "Code" : "OfficePhone",
    "Editable" : true,
    "Indexed" : false,
    "Required" : false,
    "Searchable" : false,
    "VisibleInSearch" : false,
    "Type" : "STRING",
    "Name" : "Office Phone"
  }, {
    "Code" : "OrgLegalType",
    "ReferenceEntity" : {
      "Id" : "DICTORGLEGALTYPE",
      "Code" : "DictOrgLegalType",
      "Properties" : [ ],
      "Type" : "DICTIONARY",
      "Name" : "DictOrgLegalType",
      "Searchable" : false
    },
    "Editable" : true,
    "Indexed" : false,
    "Required" : false,
    "Searchable" : false,
    "VisibleInSearch" : false,
    "Type" : "DICTIONARY",
    "Name" : "OrgLegalType"
  }, {
    "Code" : "OrgName",
    "Editable" : true,
    "Indexed" : true,
    "Required" : false,
    "Searchable" : false,
    "VisibleInSearch" : false,
    "Type" : "STRING",
    "Name" : "OrgName"
  }, {
    "Code" : "OrgRegAddress",
    "ReferenceEntity" : {
      "Id" : "ADDRESS",
      "Code" : "Address",
      "Properties" : [ ],
      "Type" : "BUSINESS",
      "Name" : "Address",
      "Searchable" : false
    },
    "Editable" : true,
    "Indexed" : false,
    "Required" : false,
    "Searchable" : false,
    "VisibleInSearch" : false,
    "Type" : "ENTITY",
    "Name" : "OrgRegAddress"
  }, {
    "Code" : "OrgRegJurisdiction",
    "ReferenceEntity" : {
      "Id" : "DICTCOUNTRY",
      "Code" : "DictCountry",
      "Properties" : [ ],
      "Type" : "DICTIONARY",
      "Name" : "DictCountry",
      "Searchable" : false
    },
    "Editable" : true,
    "Indexed" : false,
    "Required" : false,
    "Searchable" : false,
    "VisibleInSearch" : false,
    "Type" : "DICTIONARY",
    "Name" : "OrgRegJurisdiction"
  }, {
    "Code" : "OrgRegNum",
    "Editable" : true,
    "Indexed" : true,
    "Required" : false,
    "Searchable" : true,
    "VisibleInSearch" : false,
    "Type" : "STRING",
    "Name" : "OrgRegNum"
  }, {
    "Code" : "PersonName",
    "Editable" : true,
    "Indexed" : true,
    "Required" : false,
    "Searchable" : false,
    "VisibleInSearch" : false,
    "Type" : "STRING",
    "Name" : "Person Name"
  }, {
    "Code" : "PersonType",
    "ReferenceEntity" : {
      "Id" : "DICTPERSONTYPE",
      "Code" : "DictPersonType",
      "Properties" : [ ],
      "Type" : "DICTIONARY",
      "Name" : "DictPersonType",
      "Searchable" : false
    },
    "Editable" : true,
    "Indexed" : true,
    "Required" : true,
    "Searchable" : false,
    "VisibleInSearch" : false,
    "Type" : "DICTIONARY",
    "Name" : "PersonType"
  }, {
    "Code" : "PersonUserId",
    "ReferenceEntity" : {
      "Id" : "USER_ENTITY",
      "Code" : "User_Entity",
      "Properties" : [ ],
      "Type" : "USER_ENTITY",
      "Name" : "User_Entity",
      "Searchable" : false
    },
    "Editable" : true,
    "Indexed" : false,
    "Required" : false,
    "Searchable" : true,
    "VisibleInSearch" : false,
    "Type" : "ENTITY",
    "Name" : "PersonUserId"
  }, {
    "Code" : "RiskCategory",
    "ReferenceEntity" : {
      "Id" : "DICTRISKCATEGORY",
      "Code" : "DictRiskCategory",
      "Properties" : [ ],
      "Type" : "DICTIONARY",
      "Name" : "DictRiskCategory",
      "Searchable" : false
    },
    "Editable" : true,
    "Indexed" : false,
    "Required" : false,
    "Searchable" : false,
    "VisibleInSearch" : false,
    "Type" : "DICTIONARY",
    "Name" : "Risk Category"
  }, {
    "Code" : "RiskCategoryAssignmentDate",
    "Editable" : true,
    "Indexed" : false,
    "Required" : false,
    "Searchable" : false,
    "VisibleInSearch" : false,
    "Type" : "DATETIME",
    "Name" : "Risk Category Assignment Date"
  } ],
  "Type" : "BUSINESS",
  "Name" : "Person",
  "Searchable" : true
} ]

Path	Type	Description
[].Id	String	File id
[].Code	String	File id
[].Name	String	File name
[].Type	String	MIME Type
[].Searchable	Boolean	MIME Type
[].Properties	Array	List of properties definitions

Search for entity

Example request

POST /organization/SD/domain-entities/Company HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjU5MTA5NzQ1MTA5MjM3NzYsImV4cCI6MTUyODk2MDkyOCwiY2xpZW50SWQiOjUwMzEzNjUyMDg3MDI5NzYsIm9yZ0NvZGUiOiJTRCIsInJvbGVzIjpbImFkbWluaXN0cmF0b3IiXSwiZG9tYWluQXBwUm9sZXMiOlsiQU5BTFlTVCIsIlNVUFBPUlQiLCJDTElFTlQiXSwicGVybWlzc2lvbnMiOlsiUkVUUllfV09SS0ZMT1ciLCJST0xFX2FkbWluaXN0cmF0b3IiLCJFUlJPUl9NQU5BR0VNRU5UIiwiU1VCU0NSSUJFUlNfTUFOQUdFTUVOVCIsIkNSRUFURV9VU0VSIiwiRVhFQ1VURV9BQ1RJT04iLCJDTElFTlRfVVNFUlNfTUFOQUdFTUVOVCIsIkFQUFJPVkVfQ0FOQ0VMIiwiUkVRVUVTVF9DQU5DRUwiLCJVU0VSU19NQU5BR0VNRU5UIiwiTk9USUZJQ0FUSU9OU19NQU5BR0VNRU5UIiwiUEFZTUVOVFNfTUFOQUdFTUVOVCIsIkdFVF9VU0VSUyIsIlJFU09VUkNFU19NQU5BR0VNRU5UIiwiQUNDRVNTX0FETUlOX1BBR0UiLCJVU0VSX1JPTEVTX01BTkFHRU1FTlQiLCJDTElFTlRTX01BTkFHRU1FTlQiLCJIRUxQX0FSVElDTEVTX01BTkFHRU1FTlQiLCJTVEFSVF9XT1JLRkxPVyJdfQ.89hVwUC7bon95R56rYLfbOwd8-mMUgaDicuh4piyhitFiv84G4ZYzZkWMXmFxCkiWw9cJZvRYjIe6oOakchqMA
Host: corporateservices.com

query=avocado2

$ curl 'https://corporateservices.com:8080/organization/SD/domain-entities/Company' -i -X POST -H 'Content-Type: application/json' -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjU5MTA5NzQ1MTA5MjM3NzYsImV4cCI6MTUyODk2MDkyOCwiY2xpZW50SWQiOjUwMzEzNjUyMDg3MDI5NzYsIm9yZ0NvZGUiOiJTRCIsInJvbGVzIjpbImFkbWluaXN0cmF0b3IiXSwiZG9tYWluQXBwUm9sZXMiOlsiQU5BTFlTVCIsIlNVUFBPUlQiLCJDTElFTlQiXSwicGVybWlzc2lvbnMiOlsiUkVUUllfV09SS0ZMT1ciLCJST0xFX2FkbWluaXN0cmF0b3IiLCJFUlJPUl9NQU5BR0VNRU5UIiwiU1VCU0NSSUJFUlNfTUFOQUdFTUVOVCIsIkNSRUFURV9VU0VSIiwiRVhFQ1VURV9BQ1RJT04iLCJDTElFTlRfVVNFUlNfTUFOQUdFTUVOVCIsIkFQUFJPVkVfQ0FOQ0VMIiwiUkVRVUVTVF9DQU5DRUwiLCJVU0VSU19NQU5BR0VNRU5UIiwiTk9USUZJQ0FUSU9OU19NQU5BR0VNRU5UIiwiUEFZTUVOVFNfTUFOQUdFTUVOVCIsIkdFVF9VU0VSUyIsIlJFU09VUkNFU19NQU5BR0VNRU5UIiwiQUNDRVNTX0FETUlOX1BBR0UiLCJVU0VSX1JPTEVTX01BTkFHRU1FTlQiLCJDTElFTlRTX01BTkFHRU1FTlQiLCJIRUxQX0FSVElDTEVTX01BTkFHRU1FTlQiLCJTVEFSVF9XT1JLRkxPVyJdfQ.89hVwUC7bon95R56rYLfbOwd8-mMUgaDicuh4piyhitFiv84G4ZYzZkWMXmFxCkiWw9cJZvRYjIe6oOakchqMA' -d 'query=avocado2'

/organization/{subsOrgCode}/domain-entities/{domainEntityCode}

Parameter	Description
subsOrgCode	Subscriber organization code
domainEntityCode	Code of domain entity to search for

Parameter	Description
query	Search query (just string value)

Example response

HTTP/1.1 200 OK
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: POST, GET, PUT, OPTIONS, DELETE
Access-Control-Max-Age: 3600
Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Authorization
Content-Type: application/json;charset=UTF-8
Content-Length: 452

[ {
  "CompanyName" : "avocado2",
  "CompanyType" : {
    "SortOrder" : 1,
    "_Key" : "ahRzfmF2b2NhZG8tYmFja2VuZC12MXJOCxIMT3JnYW5pemF0aW9uIgNTR1AMCxILRG9tYWluTW9kZWwiCFNHUC5TR0NTDAsSGFNHUC5TR0NTLkRJQ1RDT01QQU5ZVFlQRSICTFAM",
    "Code" : "LP",
    "Name" : "Limited Partnership"
  },
  "_Key" : "ahRzfmF2b2NhZG8tYmFja2VuZC12MXI9CxIMT3JnYW5pemF0aW9uIgJTRAwLEgZDbGllbnQYgICAgICA-AgMCxIQU0dQLlNHQ1MuQ09NUEFOWRgDDA",
  "DisplayProperty" : "avocado2"
} ]

Path	Type	Description
[].DisplayProperty	String	Display property of entity. Can be absent if not specified in domain entity definition.
[]._Key	String	Entity key
[].CompanyType	Object	Other entity fields (different for different entities)
[].CompanyName	String	Other entity fields (different for different entities)

Get entity data

Example request

GET /organization/SD/domain-entities/ahRzfmF2b2NhZG8tYmFja2VuZC12MXI9CxIMT3JnYW5pemF0aW9uIgJTRAwLEgZDbGllbnQYgICAgICA-AgMCxIQU0dQLlNHQ1MuQ09NUEFOWRgDDA HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjU5MTA5NzQ1MTA5MjM3NzYsImV4cCI6MTUyODk2MDkyOCwiY2xpZW50SWQiOjUwMzEzNjUyMDg3MDI5NzYsIm9yZ0NvZGUiOiJTRCIsInJvbGVzIjpbImFkbWluaXN0cmF0b3IiXSwiZG9tYWluQXBwUm9sZXMiOlsiQU5BTFlTVCIsIlNVUFBPUlQiLCJDTElFTlQiXSwicGVybWlzc2lvbnMiOlsiUkVUUllfV09SS0ZMT1ciLCJST0xFX2FkbWluaXN0cmF0b3IiLCJFUlJPUl9NQU5BR0VNRU5UIiwiU1VCU0NSSUJFUlNfTUFOQUdFTUVOVCIsIkNSRUFURV9VU0VSIiwiRVhFQ1VURV9BQ1RJT04iLCJDTElFTlRfVVNFUlNfTUFOQUdFTUVOVCIsIkFQUFJPVkVfQ0FOQ0VMIiwiUkVRVUVTVF9DQU5DRUwiLCJVU0VSU19NQU5BR0VNRU5UIiwiTk9USUZJQ0FUSU9OU19NQU5BR0VNRU5UIiwiUEFZTUVOVFNfTUFOQUdFTUVOVCIsIkdFVF9VU0VSUyIsIlJFU09VUkNFU19NQU5BR0VNRU5UIiwiQUNDRVNTX0FETUlOX1BBR0UiLCJVU0VSX1JPTEVTX01BTkFHRU1FTlQiLCJDTElFTlRTX01BTkFHRU1FTlQiLCJIRUxQX0FSVElDTEVTX01BTkFHRU1FTlQiLCJTVEFSVF9XT1JLRkxPVyJdfQ.89hVwUC7bon95R56rYLfbOwd8-mMUgaDicuh4piyhitFiv84G4ZYzZkWMXmFxCkiWw9cJZvRYjIe6oOakchqMA
Host: corporateservices.com

$ curl 'https://corporateservices.com:8080/organization/SD/domain-entities/ahRzfmF2b2NhZG8tYmFja2VuZC12MXI9CxIMT3JnYW5pemF0aW9uIgJTRAwLEgZDbGllbnQYgICAgICA-AgMCxIQU0dQLlNHQ1MuQ09NUEFOWRgDDA' -i -H 'Content-Type: application/json' -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjU5MTA5NzQ1MTA5MjM3NzYsImV4cCI6MTUyODk2MDkyOCwiY2xpZW50SWQiOjUwMzEzNjUyMDg3MDI5NzYsIm9yZ0NvZGUiOiJTRCIsInJvbGVzIjpbImFkbWluaXN0cmF0b3IiXSwiZG9tYWluQXBwUm9sZXMiOlsiQU5BTFlTVCIsIlNVUFBPUlQiLCJDTElFTlQiXSwicGVybWlzc2lvbnMiOlsiUkVUUllfV09SS0ZMT1ciLCJST0xFX2FkbWluaXN0cmF0b3IiLCJFUlJPUl9NQU5BR0VNRU5UIiwiU1VCU0NSSUJFUlNfTUFOQUdFTUVOVCIsIkNSRUFURV9VU0VSIiwiRVhFQ1VURV9BQ1RJT04iLCJDTElFTlRfVVNFUlNfTUFOQUdFTUVOVCIsIkFQUFJPVkVfQ0FOQ0VMIiwiUkVRVUVTVF9DQU5DRUwiLCJVU0VSU19NQU5BR0VNRU5UIiwiTk9USUZJQ0FUSU9OU19NQU5BR0VNRU5UIiwiUEFZTUVOVFNfTUFOQUdFTUVOVCIsIkdFVF9VU0VSUyIsIlJFU09VUkNFU19NQU5BR0VNRU5UIiwiQUNDRVNTX0FETUlOX1BBR0UiLCJVU0VSX1JPTEVTX01BTkFHRU1FTlQiLCJDTElFTlRTX01BTkFHRU1FTlQiLCJIRUxQX0FSVElDTEVTX01BTkFHRU1FTlQiLCJTVEFSVF9XT1JLRkxPVyJdfQ.89hVwUC7bon95R56rYLfbOwd8-mMUgaDicuh4piyhitFiv84G4ZYzZkWMXmFxCkiWw9cJZvRYjIe6oOakchqMA'

/organization/{subsOrgCode}/domain-entities/{entityKey}

Parameter	Description
subsOrgCode	Subscriber organization code
entityKey	Key for entity to get

Example response

HTTP/1.1 200 OK
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: POST, GET, PUT, OPTIONS, DELETE
Access-Control-Max-Age: 3600
Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Authorization
Content-Type: application/json;charset=UTF-8
Content-Length: 2385

{
  "Company" : {
    "ResidentialAddressProof" : null,
    "FYEMonth" : null,
    "CompanyDocument" : [ ],
    "ActivityDesc1" : "act descr1",
    "ApplNum" : null,
    "ActivityDesc2" : null,
    "_Kind" : "SGP.SGCS.COMPANY",
    "ApplDate" : null,
    "CDDComplianceStatus" : null,
    "CompanyName" : "avocado2",
    "ACRARegNum" : "acra_00017",
    "CustomMAADocID" : null,
    "CompanyFKAName" : null,
    "StatutoryComplianceStatus" : null,
    "CompanySuffix" : {
      "SortOrder" : 1,
      "_Key" : "ahRzfmF2b2NhZG8tYmFja2VuZC12MXJRCxIMT3JnYW5pemF0aW9uIgNTR1AMCxILRG9tYWluTW9kZWwiCFNHUC5TR0NTDAsSGlNHUC5TR0NTLkRJQ1RDT01QQU5ZU1VGRklYIgNQTEMM",
      "Code" : "PLC",
      "Name" : "Private Limited Company"
    },
    "PaymentComplianceStatus" : null,
    "ModelMAAVerNum" : null,
    "NextFYEdate" : null,
    "ShareCapital" : [ {
      "_Key" : "ahRzfmF2b2NhZG8tYmFja2VuZC12MXJYCxIMT3JnYW5pemF0aW9uIgJTRAwLEgZDbGllbnQYgICAgICA-AgMCxIQU0dQLlNHQ1MuQ09NUEFOWRgDDAsSFVNHUC5TR0NTLlNIQVJFQ0FQSVRBTBgFDA"
    } ],
    "CompanyClientId" : null,
    "RegDate" : null,
    "RegAddr" : {
      "_Key" : "ahRzfmF2b2NhZG8tYmFja2VuZC12MXJTCxIMT3JnYW5pemF0aW9uIgJTRAwLEgZDbGllbnQYgICAgICA-AgMCxIQU0dQLlNHQ1MuQ09NUEFOWRgDDAsSEFNHUC5TR0NTLkFERFJFU1MYBAw"
    },
    "CompanyType" : {
      "SortOrder" : 1,
      "_Key" : "ahRzfmF2b2NhZG8tYmFja2VuZC12MXJOCxIMT3JnYW5pemF0aW9uIgNTR1AMCxILRG9tYWluTW9kZWwiCFNHUC5TR0NTDAsSGFNHUC5TR0NTLkRJQ1RDT01QQU5ZVFlQRSICTFAM",
      "Code" : "LP",
      "Name" : "Limited Partnership"
    },
    "_Key" : "ahRzfmF2b2NhZG8tYmFja2VuZC12MXI9CxIMT3JnYW5pemF0aW9uIgJTRAwLEgZDbGllbnQYgICAgICA-AgMCxIQU0dQLlNHQ1MuQ09NUEFOWRgDDA",
    "ConstitutionDoc" : null,
    "hasCustomMAA" : true,
    "ActivityCode2" : {
      "SortOrder" : 1,
      "_Key" : "ahRzfmF2b2NhZG8tYmFja2VuZC12MXJOCxIMT3JnYW5pemF0aW9uIgNTR1AMCxILRG9tYWluTW9kZWwiCFNHUC5TR0NTDAsSFVNHUC5TR0NTLkRJQ1RTU0lDQ09ERSIFNjIwMTMM",
      "Code" : "62013",
      "Name" : "Development of Software for Interactive Digital Media"
    },
    "ActivityCode1" : {
      "SortOrder" : 1,
      "_Key" : "ahRzfmF2b2NhZG8tYmFja2VuZC12MXJOCxIMT3JnYW5pemF0aW9uIgNTR1AMCxILRG9tYWluTW9kZWwiCFNHUC5TR0NTDAsSFVNHUC5TR0NTLkRJQ1RTU0lDQ09ERSIFNjIwMTkM",
      "Code" : "62019",
      "Name" : "Development of Other Software and Programming Activities NEC"
    },
    "FYEDayOfMonth" : null,
    "AnnualRevenue" : null
  }
}

Path	Type	Description
Company	Object	Root entity data (Name of field is name of entity)

Get entity form definition

Example request

GET /organization/SD/domain-entities/ahRzfmF2b2NhZG8tYmFja2VuZC12MXI9CxIMT3JnYW5pemF0aW9uIgJTRAwLEgZDbGllbnQYgICAgICA-AgMCxIQU0dQLlNHQ1MuQ09NUEFOWRgDDA/form HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjU5MTA5NzQ1MTA5MjM3NzYsImV4cCI6MTUyODk2MDkyOCwiY2xpZW50SWQiOjUwMzEzNjUyMDg3MDI5NzYsIm9yZ0NvZGUiOiJTRCIsInJvbGVzIjpbImFkbWluaXN0cmF0b3IiXSwiZG9tYWluQXBwUm9sZXMiOlsiQU5BTFlTVCIsIlNVUFBPUlQiLCJDTElFTlQiXSwicGVybWlzc2lvbnMiOlsiUkVUUllfV09SS0ZMT1ciLCJST0xFX2FkbWluaXN0cmF0b3IiLCJFUlJPUl9NQU5BR0VNRU5UIiwiU1VCU0NSSUJFUlNfTUFOQUdFTUVOVCIsIkNSRUFURV9VU0VSIiwiRVhFQ1VURV9BQ1RJT04iLCJDTElFTlRfVVNFUlNfTUFOQUdFTUVOVCIsIkFQUFJPVkVfQ0FOQ0VMIiwiUkVRVUVTVF9DQU5DRUwiLCJVU0VSU19NQU5BR0VNRU5UIiwiTk9USUZJQ0FUSU9OU19NQU5BR0VNRU5UIiwiUEFZTUVOVFNfTUFOQUdFTUVOVCIsIkdFVF9VU0VSUyIsIlJFU09VUkNFU19NQU5BR0VNRU5UIiwiQUNDRVNTX0FETUlOX1BBR0UiLCJVU0VSX1JPTEVTX01BTkFHRU1FTlQiLCJDTElFTlRTX01BTkFHRU1FTlQiLCJIRUxQX0FSVElDTEVTX01BTkFHRU1FTlQiLCJTVEFSVF9XT1JLRkxPVyJdfQ.89hVwUC7bon95R56rYLfbOwd8-mMUgaDicuh4piyhitFiv84G4ZYzZkWMXmFxCkiWw9cJZvRYjIe6oOakchqMA
Host: corporateservices.com

$ curl 'https://corporateservices.com:8080/organization/SD/domain-entities/ahRzfmF2b2NhZG8tYmFja2VuZC12MXI9CxIMT3JnYW5pemF0aW9uIgJTRAwLEgZDbGllbnQYgICAgICA-AgMCxIQU0dQLlNHQ1MuQ09NUEFOWRgDDA/form' -i -H 'Content-Type: application/json' -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjU5MTA5NzQ1MTA5MjM3NzYsImV4cCI6MTUyODk2MDkyOCwiY2xpZW50SWQiOjUwMzEzNjUyMDg3MDI5NzYsIm9yZ0NvZGUiOiJTRCIsInJvbGVzIjpbImFkbWluaXN0cmF0b3IiXSwiZG9tYWluQXBwUm9sZXMiOlsiQU5BTFlTVCIsIlNVUFBPUlQiLCJDTElFTlQiXSwicGVybWlzc2lvbnMiOlsiUkVUUllfV09SS0ZMT1ciLCJST0xFX2FkbWluaXN0cmF0b3IiLCJFUlJPUl9NQU5BR0VNRU5UIiwiU1VCU0NSSUJFUlNfTUFOQUdFTUVOVCIsIkNSRUFURV9VU0VSIiwiRVhFQ1VURV9BQ1RJT04iLCJDTElFTlRfVVNFUlNfTUFOQUdFTUVOVCIsIkFQUFJPVkVfQ0FOQ0VMIiwiUkVRVUVTVF9DQU5DRUwiLCJVU0VSU19NQU5BR0VNRU5UIiwiTk9USUZJQ0FUSU9OU19NQU5BR0VNRU5UIiwiUEFZTUVOVFNfTUFOQUdFTUVOVCIsIkdFVF9VU0VSUyIsIlJFU09VUkNFU19NQU5BR0VNRU5UIiwiQUNDRVNTX0FETUlOX1BBR0UiLCJVU0VSX1JPTEVTX01BTkFHRU1FTlQiLCJDTElFTlRTX01BTkFHRU1FTlQiLCJIRUxQX0FSVElDTEVTX01BTkFHRU1FTlQiLCJTVEFSVF9XT1JLRkxPVyJdfQ.89hVwUC7bon95R56rYLfbOwd8-mMUgaDicuh4piyhitFiv84G4ZYzZkWMXmFxCkiWw9cJZvRYjIe6oOakchqMA'

/organization/{subsOrgCode}/domain-entities/{entityKey}/form

Parameter	Description
subsOrgCode	Subscriber organization code
entityKey	Key for entity to get

Example response

HTTP/1.1 404 Not Found
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: POST, GET, PUT, OPTIONS, DELETE
Access-Control-Max-Age: 3600
Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Authorization
Content-Type: application/json;charset=UTF-8
Content-Length: 107

{
  "ErrorCode" : "DEVFE001",
  "Message" : "Domain entity view form not found for domain entity COMPANY"
}

Recently viewed tasks

List recently viewed tasks

Example request

GET /organization/SD/recent-tasks HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjU2Mjk0OTk1MzQyMTMxMjAsImV4cCI6MTUyODk2MDk2MSwicm9sZXMiOltdLCJkb21haW5BcHBSb2xlcyI6W10sInBlcm1pc3Npb25zIjpbIlJFVFJZX1dPUktGTE9XIiwiU1VQRVJBRE1JTiIsIkVSUk9SX01BTkFHRU1FTlQiLCJTVUJTQ1JJQkVSU19NQU5BR0VNRU5UIiwiQ1JFQVRFX1VTRVIiLCJFWEVDVVRFX0FDVElPTiIsIkNMSUVOVF9VU0VSU19NQU5BR0VNRU5UIiwiQVBQUk9WRV9DQU5DRUwiLCJSRVFVRVNUX0NBTkNFTCIsIlVTRVJTX01BTkFHRU1FTlQiLCJOT1RJRklDQVRJT05TX01BTkFHRU1FTlQiLCJHRVRfVVNFUlMiLCJSRVNPVVJDRVNfTUFOQUdFTUVOVCIsIkFDQ0VTU19BRE1JTl9QQUdFIiwiVVNFUl9ST0xFU19NQU5BR0VNRU5UIiwiQ0xJRU5UU19NQU5BR0VNRU5UIiwiSEVMUF9BUlRJQ0xFU19NQU5BR0VNRU5UIiwiU1RBUlRfV09SS0ZMT1ciXX0.K691mRxWvd1p5AOffihRn69Hl8L5wspzwYUDYyQ8pSqhAXdJxTzkEvGEgEZMYVC4PUhak_1G_gLV1uyEkx0AJA
Host: corporateservices.com

$ curl 'https://corporateservices.com:8080/organization/SD/recent-tasks' -i -H 'Content-Type: application/json' -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjU2Mjk0OTk1MzQyMTMxMjAsImV4cCI6MTUyODk2MDk2MSwicm9sZXMiOltdLCJkb21haW5BcHBSb2xlcyI6W10sInBlcm1pc3Npb25zIjpbIlJFVFJZX1dPUktGTE9XIiwiU1VQRVJBRE1JTiIsIkVSUk9SX01BTkFHRU1FTlQiLCJTVUJTQ1JJQkVSU19NQU5BR0VNRU5UIiwiQ1JFQVRFX1VTRVIiLCJFWEVDVVRFX0FDVElPTiIsIkNMSUVOVF9VU0VSU19NQU5BR0VNRU5UIiwiQVBQUk9WRV9DQU5DRUwiLCJSRVFVRVNUX0NBTkNFTCIsIlVTRVJTX01BTkFHRU1FTlQiLCJOT1RJRklDQVRJT05TX01BTkFHRU1FTlQiLCJHRVRfVVNFUlMiLCJSRVNPVVJDRVNfTUFOQUdFTUVOVCIsIkFDQ0VTU19BRE1JTl9QQUdFIiwiVVNFUl9ST0xFU19NQU5BR0VNRU5UIiwiQ0xJRU5UU19NQU5BR0VNRU5UIiwiSEVMUF9BUlRJQ0xFU19NQU5BR0VNRU5UIiwiU1RBUlRfV09SS0ZMT1ciXX0.K691mRxWvd1p5AOffihRn69Hl8L5wspzwYUDYyQ8pSqhAXdJxTzkEvGEgEZMYVC4PUhak_1G_gLV1uyEkx0AJA'

/organization/{organizationCode}/recent-tasks

Parameter	Description
organizationCode	Organization code

Example response

HTTP/1.1 200 OK
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: POST, GET, PUT, OPTIONS, DELETE
Access-Control-Max-Age: 3600
Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Authorization
Content-Type: application/json;charset=UTF-8
Content-Length: 381

[ {
  "Id" : 5066549580791808,
  "ActivityInstanceKey" : "ahRzfmF2b2NhZG8tYmFja2VuZC12MXIrCxIPUHJvY2Vzc0luc3RhbmNlGAEMCxIQQWN0aXZpdHlJbnN0YW5jZRgBDA",
  "ClientName" : "Client",
  "ProcessName" : "Process name",
  "ActivityName" : "ActivityName",
  "WorkflowFormKey" : "ahRzfmF2b2NhZG8tYmFja2VuZC12MXISCxIMV29ya2Zsb3dGb3JtGAEM",
  "ProcessInstanceId" : 1,
  "type" : "ASSIGNED"
} ]

Path	Type	Description
[]	Object	List of task views
[0].Id	Object	TaskView id
[0].ActivityInstanceKey	Number	Key of current activity instance
[0].ProcessInstanceId	Number	Id of process instance
[0].WorkflowFormKey	Object	Key of workflow form used in process
[0].ClientName	String	Name of client(Governing body)
[0].ProcessName	Object	Process name (Workflow name)
[0].ActivityName	Object	Activity name (Step name)
[0].AssignedTo	Object	Current assigned user (if applicable)
[0].MeetingTitle	Object	Meeting title
[0].MeetingDate	Object	Date of meeting
[0].Title	String	Meeting or Agenda item title

Add recently viewed task

Example request

POST /organization/SD/recent-tasks/ahRzfmF2b2NhZG8tYmFja2VuZC12MXIVCxIPUHJvY2Vzc0luc3RhbmNlGAEM HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjU2Mjk0OTk1MzQyMTMxMjAsImV4cCI6MTUyODk2MDk2MSwicm9sZXMiOltdLCJkb21haW5BcHBSb2xlcyI6W10sInBlcm1pc3Npb25zIjpbIlJFVFJZX1dPUktGTE9XIiwiU1VQRVJBRE1JTiIsIkVSUk9SX01BTkFHRU1FTlQiLCJTVUJTQ1JJQkVSU19NQU5BR0VNRU5UIiwiQ1JFQVRFX1VTRVIiLCJFWEVDVVRFX0FDVElPTiIsIkNMSUVOVF9VU0VSU19NQU5BR0VNRU5UIiwiQVBQUk9WRV9DQU5DRUwiLCJSRVFVRVNUX0NBTkNFTCIsIlVTRVJTX01BTkFHRU1FTlQiLCJOT1RJRklDQVRJT05TX01BTkFHRU1FTlQiLCJHRVRfVVNFUlMiLCJSRVNPVVJDRVNfTUFOQUdFTUVOVCIsIkFDQ0VTU19BRE1JTl9QQUdFIiwiVVNFUl9ST0xFU19NQU5BR0VNRU5UIiwiQ0xJRU5UU19NQU5BR0VNRU5UIiwiSEVMUF9BUlRJQ0xFU19NQU5BR0VNRU5UIiwiU1RBUlRfV09SS0ZMT1ciXX0.K691mRxWvd1p5AOffihRn69Hl8L5wspzwYUDYyQ8pSqhAXdJxTzkEvGEgEZMYVC4PUhak_1G_gLV1uyEkx0AJA
Host: corporateservices.com

$ curl 'https://corporateservices.com:8080/organization/SD/recent-tasks/ahRzfmF2b2NhZG8tYmFja2VuZC12MXIVCxIPUHJvY2Vzc0luc3RhbmNlGAEM' -i -X POST -H 'Content-Type: application/json' -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjU2Mjk0OTk1MzQyMTMxMjAsImV4cCI6MTUyODk2MDk2MSwicm9sZXMiOltdLCJkb21haW5BcHBSb2xlcyI6W10sInBlcm1pc3Npb25zIjpbIlJFVFJZX1dPUktGTE9XIiwiU1VQRVJBRE1JTiIsIkVSUk9SX01BTkFHRU1FTlQiLCJTVUJTQ1JJQkVSU19NQU5BR0VNRU5UIiwiQ1JFQVRFX1VTRVIiLCJFWEVDVVRFX0FDVElPTiIsIkNMSUVOVF9VU0VSU19NQU5BR0VNRU5UIiwiQVBQUk9WRV9DQU5DRUwiLCJSRVFVRVNUX0NBTkNFTCIsIlVTRVJTX01BTkFHRU1FTlQiLCJOT1RJRklDQVRJT05TX01BTkFHRU1FTlQiLCJHRVRfVVNFUlMiLCJSRVNPVVJDRVNfTUFOQUdFTUVOVCIsIkFDQ0VTU19BRE1JTl9QQUdFIiwiVVNFUl9ST0xFU19NQU5BR0VNRU5UIiwiQ0xJRU5UU19NQU5BR0VNRU5UIiwiSEVMUF9BUlRJQ0xFU19NQU5BR0VNRU5UIiwiU1RBUlRfV09SS0ZMT1ciXX0.K691mRxWvd1p5AOffihRn69Hl8L5wspzwYUDYyQ8pSqhAXdJxTzkEvGEgEZMYVC4PUhak_1G_gLV1uyEkx0AJA'

/organization/{organizationCode}/recent-tasks/{processInstanceKey}

Parameter	Description
organizationCode	Organization code
processInstanceKey	Key of viewed process instance

Example response

HTTP/1.1 200 OK
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: POST, GET, PUT, OPTIONS, DELETE
Access-Control-Max-Age: 3600
Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Authorization

Active and completed tasks of all subscribers for publisher

List active tasks

Example request

GET /organization/testOrg78/subscribers-tasks/active?subscribers=Subscriber-1&subscribers=Subscriber-2 HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjU2Mjk0OTk1MzQyMTMxMjAsImV4cCI6MTUyODk2MDk2Niwicm9sZXMiOltdLCJkb21haW5BcHBSb2xlcyI6W10sInBlcm1pc3Npb25zIjpbIlJFVFJZX1dPUktGTE9XIiwiU1VQRVJBRE1JTiIsIkVSUk9SX01BTkFHRU1FTlQiLCJTVUJTQ1JJQkVSU19NQU5BR0VNRU5UIiwiQ1JFQVRFX1VTRVIiLCJFWEVDVVRFX0FDVElPTiIsIkNMSUVOVF9VU0VSU19NQU5BR0VNRU5UIiwiQVBQUk9WRV9DQU5DRUwiLCJSRVFVRVNUX0NBTkNFTCIsIlVTRVJTX01BTkFHRU1FTlQiLCJOT1RJRklDQVRJT05TX01BTkFHRU1FTlQiLCJHRVRfVVNFUlMiLCJSRVNPVVJDRVNfTUFOQUdFTUVOVCIsIkFDQ0VTU19BRE1JTl9QQUdFIiwiVVNFUl9ST0xFU19NQU5BR0VNRU5UIiwiQ0xJRU5UU19NQU5BR0VNRU5UIiwiSEVMUF9BUlRJQ0xFU19NQU5BR0VNRU5UIiwiU1RBUlRfV09SS0ZMT1ciXX0.F80K0-XsRtbgfvE07lWTBrWP9cZldWSR_qd9lWY2z_xc5x2cCIKLqeB2u2ZUEHj0cuyyuzK2IPOdyvw6mjByIg
Host: corporateservices.com

$ curl 'https://corporateservices.com:8080/organization/testOrg78/subscribers-tasks/active?subscribers=Subscriber-1&subscribers=Subscriber-2' -i -H 'Content-Type: application/json' -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjU2Mjk0OTk1MzQyMTMxMjAsImV4cCI6MTUyODk2MDk2Niwicm9sZXMiOltdLCJkb21haW5BcHBSb2xlcyI6W10sInBlcm1pc3Npb25zIjpbIlJFVFJZX1dPUktGTE9XIiwiU1VQRVJBRE1JTiIsIkVSUk9SX01BTkFHRU1FTlQiLCJTVUJTQ1JJQkVSU19NQU5BR0VNRU5UIiwiQ1JFQVRFX1VTRVIiLCJFWEVDVVRFX0FDVElPTiIsIkNMSUVOVF9VU0VSU19NQU5BR0VNRU5UIiwiQVBQUk9WRV9DQU5DRUwiLCJSRVFVRVNUX0NBTkNFTCIsIlVTRVJTX01BTkFHRU1FTlQiLCJOT1RJRklDQVRJT05TX01BTkFHRU1FTlQiLCJHRVRfVVNFUlMiLCJSRVNPVVJDRVNfTUFOQUdFTUVOVCIsIkFDQ0VTU19BRE1JTl9QQUdFIiwiVVNFUl9ST0xFU19NQU5BR0VNRU5UIiwiQ0xJRU5UU19NQU5BR0VNRU5UIiwiSEVMUF9BUlRJQ0xFU19NQU5BR0VNRU5UIiwiU1RBUlRfV09SS0ZMT1ciXX0.F80K0-XsRtbgfvE07lWTBrWP9cZldWSR_qd9lWY2z_xc5x2cCIKLqeB2u2ZUEHj0cuyyuzK2IPOdyvw6mjByIg'

/organization/{orgCode}/subscribers-tasks/active

Parameter	Description
orgCode	Publisher organization code

Parameter	Description
subscribers	Filter by subscribers. Optional parameter(all subscribers if none provided)

Example response

HTTP/1.1 200 OK
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: POST, GET, PUT, OPTIONS, DELETE
Access-Control-Max-Age: 3600
Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Authorization
Content-Type: application/json;charset=UTF-8
Content-Length: 391

[ {
  "ClientName" : "Client name",
  "RootEntityProperty" : "Company name",
  "InitiatedBy" : "User 2",
  "InitiatedOn" : "2018-05-14T10:21:21.592+03:00",
  "ActivityName" : "Initial",
  "ActivityInstanceCreatedOn" : "2018-05-15T10:21:21.569+03:00",
  "Priority" : "High priority",
  "AssignedTo" : "User 1",
  "Title" : "Title",
  "SubscriberName" : "Subscriber",
  "type" : "ASSIGNED"
} ]

Path	Type	Description
[0].Title	String	Task title
[0].ActivityName	String	Name of current activity
[0].AssignedTo	String	Curren tassignee name
[0].ClientName	String	Client name
[0].Priority	String	Task priority
[0].RootEntityProperty	String	Root entity property
[0].SubscriberName	String	Name of subscriber organization
[0].InitiatedBy	String	User that started request
[0].InitiatedOn	String	Date when request was started
[0].ActivityInstanceCreatedOn	String	Date when current step was started
[0].Title	String	Task title

List completed tasks

Example request

GET /organization/testOrg78/subscribers-tasks/completed?subscribers=Subscriber-1&subscribers=Subscriber-2&rootEntity=Company+1&workflowKey=ahRzfmF2b2NhZG8tYmFja2VuZC12MXIaCxIIV29ya2Zsb3ciDE5ldy1XT1JLRkxPVww&startedAtFrom=2018-05-13&startedAtTo=2018-05-14&completedAtFrom=2018-05-14&completedAtTo=2018-05-15 HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjU2Mjk0OTk1MzQyMTMxMjAsImV4cCI6MTUyODk2MDk2Niwicm9sZXMiOltdLCJkb21haW5BcHBSb2xlcyI6W10sInBlcm1pc3Npb25zIjpbIlJFVFJZX1dPUktGTE9XIiwiU1VQRVJBRE1JTiIsIkVSUk9SX01BTkFHRU1FTlQiLCJTVUJTQ1JJQkVSU19NQU5BR0VNRU5UIiwiQ1JFQVRFX1VTRVIiLCJFWEVDVVRFX0FDVElPTiIsIkNMSUVOVF9VU0VSU19NQU5BR0VNRU5UIiwiQVBQUk9WRV9DQU5DRUwiLCJSRVFVRVNUX0NBTkNFTCIsIlVTRVJTX01BTkFHRU1FTlQiLCJOT1RJRklDQVRJT05TX01BTkFHRU1FTlQiLCJHRVRfVVNFUlMiLCJSRVNPVVJDRVNfTUFOQUdFTUVOVCIsIkFDQ0VTU19BRE1JTl9QQUdFIiwiVVNFUl9ST0xFU19NQU5BR0VNRU5UIiwiQ0xJRU5UU19NQU5BR0VNRU5UIiwiSEVMUF9BUlRJQ0xFU19NQU5BR0VNRU5UIiwiU1RBUlRfV09SS0ZMT1ciXX0.F80K0-XsRtbgfvE07lWTBrWP9cZldWSR_qd9lWY2z_xc5x2cCIKLqeB2u2ZUEHj0cuyyuzK2IPOdyvw6mjByIg
Host: corporateservices.com

$ curl 'https://corporateservices.com:8080/organization/testOrg78/subscribers-tasks/completed?subscribers=Subscriber-1&subscribers=Subscriber-2&rootEntity=Company+1&workflowKey=ahRzfmF2b2NhZG8tYmFja2VuZC12MXIaCxIIV29ya2Zsb3ciDE5ldy1XT1JLRkxPVww&startedAtFrom=2018-05-13&startedAtTo=2018-05-14&completedAtFrom=2018-05-14&completedAtTo=2018-05-15' -i -H 'Content-Type: application/json' -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjU2Mjk0OTk1MzQyMTMxMjAsImV4cCI6MTUyODk2MDk2Niwicm9sZXMiOltdLCJkb21haW5BcHBSb2xlcyI6W10sInBlcm1pc3Npb25zIjpbIlJFVFJZX1dPUktGTE9XIiwiU1VQRVJBRE1JTiIsIkVSUk9SX01BTkFHRU1FTlQiLCJTVUJTQ1JJQkVSU19NQU5BR0VNRU5UIiwiQ1JFQVRFX1VTRVIiLCJFWEVDVVRFX0FDVElPTiIsIkNMSUVOVF9VU0VSU19NQU5BR0VNRU5UIiwiQVBQUk9WRV9DQU5DRUwiLCJSRVFVRVNUX0NBTkNFTCIsIlVTRVJTX01BTkFHRU1FTlQiLCJOT1RJRklDQVRJT05TX01BTkFHRU1FTlQiLCJHRVRfVVNFUlMiLCJSRVNPVVJDRVNfTUFOQUdFTUVOVCIsIkFDQ0VTU19BRE1JTl9QQUdFIiwiVVNFUl9ST0xFU19NQU5BR0VNRU5UIiwiQ0xJRU5UU19NQU5BR0VNRU5UIiwiSEVMUF9BUlRJQ0xFU19NQU5BR0VNRU5UIiwiU1RBUlRfV09SS0ZMT1ciXX0.F80K0-XsRtbgfvE07lWTBrWP9cZldWSR_qd9lWY2z_xc5x2cCIKLqeB2u2ZUEHj0cuyyuzK2IPOdyvw6mjByIg'

/organization/{orgCode}/subscribers-tasks/completed

Parameter	Description
orgCode	Publisher organization code

Parameter	Description
subscribers	Filter by subscribers. Optional parameter(all subscribers if none provided)
rootEntity	Filter by root entity. Optional parameter
workflowKey	Filter by workflow. Optional parameter(all workflows if none provided)
startedAtFrom	Filter by started date. Optional parameter
startedAtTo	Filter by started date. Optional parameter
completedAtFrom	Filter by completed date. Optional parameter
completedAtTo	Filter by completed date. Optional parameter

Example response

HTTP/1.1 200 OK
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: POST, GET, PUT, OPTIONS, DELETE
Access-Control-Max-Age: 3600
Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Authorization
Content-Type: application/json;charset=UTF-8
Content-Length: 363

[ {
  "ClientName" : "Client name",
  "WorkflowName" : "Some workflow",
  "RootEntityDisplayProperty" : "Some company",
  "StartedAt" : "2018-05-14T10:21:21.594+03:00",
  "CompletedAt" : "2018-05-15T10:21:21.594+03:00",
  "InitiatedBy" : "Some user",
  "Status" : "COMPLETED",
  "ProcessInstanceKey" : "Process isntance key",
  "SubscriberName" : "Subscriber"
} ]

Path	Type	Description
[0].ClientName	String	Client name
[0].WorkflowName	String	Workflow name
[0].StartedAt	String	Date when request was started
[0].CompletedAt	String	Date when request was completed
[0].InitiatedBy	String	User that started request
[0].Status	String	Current request status
[0].ProcessInstanceKey	String	Key of process instance
[0].RootEntityDisplayProperty	String	Name of root entity
[0].SubscriberName	String	Name of subscriber organization

User profile

Get user profile

Example request

GET /organization/SUBS/users/5066549580791808/profile HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjUwNjY1NDk1ODA3OTE4MDgsImV4cCI6MTUyODk2MDk0NCwib3JnQ29kZSI6IlNVQlMiLCJyb2xlcyI6WyJhZG1pbmlzdHJhdG9yIl0sImRvbWFpbkFwcFJvbGVzIjpbXSwicGVybWlzc2lvbnMiOlsiUkVUUllfV09SS0ZMT1ciLCJST0xFX2FkbWluaXN0cmF0b3IiLCJFUlJPUl9NQU5BR0VNRU5UIiwiU1VCU0NSSUJFUlNfTUFOQUdFTUVOVCIsIkNSRUFURV9VU0VSIiwiRVhFQ1VURV9BQ1RJT04iLCJDTElFTlRfVVNFUlNfTUFOQUdFTUVOVCIsIkFQUFJPVkVfQ0FOQ0VMIiwiUkVRVUVTVF9DQU5DRUwiLCJVU0VSU19NQU5BR0VNRU5UIiwiTk9USUZJQ0FUSU9OU19NQU5BR0VNRU5UIiwiR0VUX1VTRVJTIiwiUkVTT1VSQ0VTX01BTkFHRU1FTlQiLCJBQ0NFU1NfQURNSU5fUEFHRSIsIlVTRVJfUk9MRVNfTUFOQUdFTUVOVCIsIkNMSUVOVFNfTUFOQUdFTUVOVCIsIkhFTFBfQVJUSUNMRVNfTUFOQUdFTUVOVCIsIlNUQVJUX1dPUktGTE9XIl19.EzDqqMIyXWPxbK0JjzF5Lem9bELe420kLqu64-APZfcHH4de57HIZjTi8Zt6pvYPkrwT2N4dqJXjdhXD84J4nQ
Host: corporateservices.com

$ curl 'https://corporateservices.com:8080/organization/SUBS/users/5066549580791808/profile' -i -H 'Content-Type: application/json' -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjUwNjY1NDk1ODA3OTE4MDgsImV4cCI6MTUyODk2MDk0NCwib3JnQ29kZSI6IlNVQlMiLCJyb2xlcyI6WyJhZG1pbmlzdHJhdG9yIl0sImRvbWFpbkFwcFJvbGVzIjpbXSwicGVybWlzc2lvbnMiOlsiUkVUUllfV09SS0ZMT1ciLCJST0xFX2FkbWluaXN0cmF0b3IiLCJFUlJPUl9NQU5BR0VNRU5UIiwiU1VCU0NSSUJFUlNfTUFOQUdFTUVOVCIsIkNSRUFURV9VU0VSIiwiRVhFQ1VURV9BQ1RJT04iLCJDTElFTlRfVVNFUlNfTUFOQUdFTUVOVCIsIkFQUFJPVkVfQ0FOQ0VMIiwiUkVRVUVTVF9DQU5DRUwiLCJVU0VSU19NQU5BR0VNRU5UIiwiTk9USUZJQ0FUSU9OU19NQU5BR0VNRU5UIiwiR0VUX1VTRVJTIiwiUkVTT1VSQ0VTX01BTkFHRU1FTlQiLCJBQ0NFU1NfQURNSU5fUEFHRSIsIlVTRVJfUk9MRVNfTUFOQUdFTUVOVCIsIkNMSUVOVFNfTUFOQUdFTUVOVCIsIkhFTFBfQVJUSUNMRVNfTUFOQUdFTUVOVCIsIlNUQVJUX1dPUktGTE9XIl19.EzDqqMIyXWPxbK0JjzF5Lem9bELe420kLqu64-APZfcHH4de57HIZjTi8Zt6pvYPkrwT2N4dqJXjdhXD84J4nQ'

/organization/{organizationCode}/users/{userId}/profile

Parameter	Description
organizationCode	Organization code
userId	User id

Example response

HTTP/1.1 200 OK
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: POST, GET, PUT, OPTIONS, DELETE
Access-Control-Max-Age: 3600
Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Authorization
Content-Type: application/json;charset=UTF-8
Content-Length: 417

{
  "User" : {
    "Id" : 5066549580791808,
    "FirstName" : "User",
    "LastName" : "name",
    "Email" : "user@mail.com",
    "Active" : true,
    "Title" : "User title",
    "UserPictureUrl" : "/users/5066549580791808/image",
    "Address" : "User address",
    "Phone" : "User phone",
    "Skype" : "User skype id",
    "Preferences" : {
      "NotifyTaskAssignment" : true
    },
    "Name" : "User name"
  }
}

Path	Type	Description
User	Object	User object
User.Name	String	User name
User.Email	String	User email
User.Title	String	User title
User.Address	String	User address
User.Phone	String	User phone
User.Skype	String	User skype id
User.Preferences.NotifyTaskAssignment	Boolean	Users notification preference

Update user profile

Example request

POST /organization/SUBS/users/5066549580791808/profile HTTP/1.1
Content-Type: multipart/form-data; boundary=6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjUwNjY1NDk1ODA3OTE4MDgsImV4cCI6MTUyODk2MDk0NCwib3JnQ29kZSI6IlNVQlMiLCJyb2xlcyI6WyJhZG1pbmlzdHJhdG9yIl0sImRvbWFpbkFwcFJvbGVzIjpbXSwicGVybWlzc2lvbnMiOlsiUkVUUllfV09SS0ZMT1ciLCJST0xFX2FkbWluaXN0cmF0b3IiLCJFUlJPUl9NQU5BR0VNRU5UIiwiU1VCU0NSSUJFUlNfTUFOQUdFTUVOVCIsIkNSRUFURV9VU0VSIiwiRVhFQ1VURV9BQ1RJT04iLCJDTElFTlRfVVNFUlNfTUFOQUdFTUVOVCIsIkFQUFJPVkVfQ0FOQ0VMIiwiUkVRVUVTVF9DQU5DRUwiLCJVU0VSU19NQU5BR0VNRU5UIiwiTk9USUZJQ0FUSU9OU19NQU5BR0VNRU5UIiwiR0VUX1VTRVJTIiwiUkVTT1VSQ0VTX01BTkFHRU1FTlQiLCJBQ0NFU1NfQURNSU5fUEFHRSIsIlVTRVJfUk9MRVNfTUFOQUdFTUVOVCIsIkNMSUVOVFNfTUFOQUdFTUVOVCIsIkhFTFBfQVJUSUNMRVNfTUFOQUdFTUVOVCIsIlNUQVJUX1dPUktGTE9XIl19.EzDqqMIyXWPxbK0JjzF5Lem9bELe420kLqu64-APZfcHH4de57HIZjTi8Zt6pvYPkrwT2N4dqJXjdhXD84J4nQ
Host: corporateservices.com

--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Content-Disposition: form-data; name=user.name

User name
--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Content-Disposition: form-data; name=user.title

User title
--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Content-Disposition: form-data; name=user.active

true
--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Content-Disposition: form-data; name=user.address

User address
--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Content-Disposition: form-data; name=user.phone

User phone
--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Content-Disposition: form-data; name=user.skype

User skype id
--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Content-Disposition: form-data; name=user.preferences.notifyTaskAssignment

true
--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Content-Disposition: form-data; name=image

�PNG


IHDR


7n�$IDATx�b`
��W���IEND�B`�
--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm--

$ curl 'https://corporateservices.com:8080/organization/SUBS/users/5066549580791808/profile' -i -X POST -H 'Content-Type: multipart/form-data' -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjUwNjY1NDk1ODA3OTE4MDgsImV4cCI6MTUyODk2MDk0NCwib3JnQ29kZSI6IlNVQlMiLCJyb2xlcyI6WyJhZG1pbmlzdHJhdG9yIl0sImRvbWFpbkFwcFJvbGVzIjpbXSwicGVybWlzc2lvbnMiOlsiUkVUUllfV09SS0ZMT1ciLCJST0xFX2FkbWluaXN0cmF0b3IiLCJFUlJPUl9NQU5BR0VNRU5UIiwiU1VCU0NSSUJFUlNfTUFOQUdFTUVOVCIsIkNSRUFURV9VU0VSIiwiRVhFQ1VURV9BQ1RJT04iLCJDTElFTlRfVVNFUlNfTUFOQUdFTUVOVCIsIkFQUFJPVkVfQ0FOQ0VMIiwiUkVRVUVTVF9DQU5DRUwiLCJVU0VSU19NQU5BR0VNRU5UIiwiTk9USUZJQ0FUSU9OU19NQU5BR0VNRU5UIiwiR0VUX1VTRVJTIiwiUkVTT1VSQ0VTX01BTkFHRU1FTlQiLCJBQ0NFU1NfQURNSU5fUEFHRSIsIlVTRVJfUk9MRVNfTUFOQUdFTUVOVCIsIkNMSUVOVFNfTUFOQUdFTUVOVCIsIkhFTFBfQVJUSUNMRVNfTUFOQUdFTUVOVCIsIlNUQVJUX1dPUktGTE9XIl19.EzDqqMIyXWPxbK0JjzF5Lem9bELe420kLqu64-APZfcHH4de57HIZjTi8Zt6pvYPkrwT2N4dqJXjdhXD84J4nQ' -F 'image=�PNG


IHDR


7n�$IDATx�b`
��W���IEND�B`�' -F 'user.name=User name' -F 'user.title=User title' -F 'user.active=true' -F 'user.address=User address' -F 'user.phone=User phone' -F 'user.skype=User skype id' -F 'user.preferences.notifyTaskAssignment=true'

/organization/{organizationCode}/users/{userId}/profile

Parameter	Description
organizationCode	Organization code
userId	User id

Parameter	Description
user.name	User name
user.active	If user should be active
user.title	User title
user.address	User address
user.phone	User phone
user.skype	User skype id
user.preferences.notifyTaskAssignment	Users notification preference

Example response

HTTP/1.1 200 OK
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: POST, GET, PUT, OPTIONS, DELETE
Access-Control-Max-Age: 3600
Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Authorization
Content-Type: application/json;charset=UTF-8
Content-Length: 417

{
  "User" : {
    "Id" : 5066549580791808,
    "FirstName" : "User",
    "LastName" : "name",
    "Email" : "user@mail.com",
    "Active" : true,
    "Title" : "User title",
    "UserPictureUrl" : "/users/5066549580791808/image",
    "Address" : "User address",
    "Phone" : "User phone",
    "Skype" : "User skype id",
    "Preferences" : {
      "NotifyTaskAssignment" : true
    },
    "Name" : "User name"
  }
}

Path	Type	Description
User	Object	User object
User.Name	String	User name
User.Email	String	User email
User.Title	String	User title
User.Address	String	User address
User.Phone	String	User phone
User.Skype	String	User skype id
User.Preferences.NotifyTaskAssignment	Boolean	Users notification preference

Help requests

Make help requests

Example request

POST /organization/SUBS/help-request HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjUwNjY1NDk1ODA3OTE4MDgsImV4cCI6MTUyODk2MDk2Nywib3JnQ29kZSI6InRlc3RPcmc3OCIsInJvbGVzIjpbImFkbWluaXN0cmF0b3IiXSwiZG9tYWluQXBwUm9sZXMiOltdLCJwZXJtaXNzaW9ucyI6WyJSRVRSWV9XT1JLRkxPVyIsIlJPTEVfYWRtaW5pc3RyYXRvciIsIkVSUk9SX01BTkFHRU1FTlQiLCJTVUJTQ1JJQkVSU19NQU5BR0VNRU5UIiwiQ1JFQVRFX1VTRVIiLCJFWEVDVVRFX0FDVElPTiIsIkNMSUVOVF9VU0VSU19NQU5BR0VNRU5UIiwiQVBQUk9WRV9DQU5DRUwiLCJSRVFVRVNUX0NBTkNFTCIsIlVTRVJTX01BTkFHRU1FTlQiLCJOT1RJRklDQVRJT05TX01BTkFHRU1FTlQiLCJHRVRfVVNFUlMiLCJSRVNPVVJDRVNfTUFOQUdFTUVOVCIsIkFDQ0VTU19BRE1JTl9QQUdFIiwiVVNFUl9ST0xFU19NQU5BR0VNRU5UIiwiQ0xJRU5UU19NQU5BR0VNRU5UIiwiSEVMUF9BUlRJQ0xFU19NQU5BR0VNRU5UIiwiU1RBUlRfV09SS0ZMT1ciXX0.Tw2gJFFS5c2hbmYMWKcxeQHHk_7z6FtKIqVR4G5CYEmaUhbs4TcavNDtbqYfL2BbuIfgwQwwTNcHkgZ_ptc-Ng
Host: corporateservices.com
Content-Length: 98

{
  "Email" : "user@mail.com",
  "Phone" : "23523462456",
  "Message" : "Help!!! Help!!! SOS!!!"
}

$ curl 'https://corporateservices.com:8080/organization/SUBS/help-request' -i -X POST -H 'Content-Type: application/json' -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjUwNjY1NDk1ODA3OTE4MDgsImV4cCI6MTUyODk2MDk2Nywib3JnQ29kZSI6InRlc3RPcmc3OCIsInJvbGVzIjpbImFkbWluaXN0cmF0b3IiXSwiZG9tYWluQXBwUm9sZXMiOltdLCJwZXJtaXNzaW9ucyI6WyJSRVRSWV9XT1JLRkxPVyIsIlJPTEVfYWRtaW5pc3RyYXRvciIsIkVSUk9SX01BTkFHRU1FTlQiLCJTVUJTQ1JJQkVSU19NQU5BR0VNRU5UIiwiQ1JFQVRFX1VTRVIiLCJFWEVDVVRFX0FDVElPTiIsIkNMSUVOVF9VU0VSU19NQU5BR0VNRU5UIiwiQVBQUk9WRV9DQU5DRUwiLCJSRVFVRVNUX0NBTkNFTCIsIlVTRVJTX01BTkFHRU1FTlQiLCJOT1RJRklDQVRJT05TX01BTkFHRU1FTlQiLCJHRVRfVVNFUlMiLCJSRVNPVVJDRVNfTUFOQUdFTUVOVCIsIkFDQ0VTU19BRE1JTl9QQUdFIiwiVVNFUl9ST0xFU19NQU5BR0VNRU5UIiwiQ0xJRU5UU19NQU5BR0VNRU5UIiwiSEVMUF9BUlRJQ0xFU19NQU5BR0VNRU5UIiwiU1RBUlRfV09SS0ZMT1ciXX0.Tw2gJFFS5c2hbmYMWKcxeQHHk_7z6FtKIqVR4G5CYEmaUhbs4TcavNDtbqYfL2BbuIfgwQwwTNcHkgZ_ptc-Ng' -d '{
  "Email" : "user@mail.com",
  "Phone" : "23523462456",
  "Message" : "Help!!! Help!!! SOS!!!"
}'

/organization/{orgCode}/help-request

Parameter	Description
orgCode	Organization code

Only one of email, phone, skype is required Path | Type | Description ---- | ---- | ----------- Email | String | User email Phone | String | User phone Message | String | Help request message

Example response

HTTP/1.1 200 OK
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: POST, GET, PUT, OPTIONS, DELETE
Access-Control-Max-Age: 3600
Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Authorization