CampusAPI Process Services API documentation version 0.1.1
Based on OSID version 3.0.0
https://demo.dxtera.org/open/campusapi/process
Overview
The Personnel services define people and organizations.
Objects may take part in multiple processes simulataneously, and while an object can only be in one state within a process, an object may have more than one state across processes. An externally mapped Id is restricted to one State per Process.
States
A State is a simple object that captures the name and description of a state. A State belongs to a single Process. A process for representing the lifecycle of Assets and another process for representing the lifecycle of Courses may each define a "draft" state. Two States need to be created to represent the draft state of a course in the course lifecycle process and the draft state of an asset in the asset lifecycle process.
| Field | Description | Type |
|---|---|---|
| id(read‑only) | The unique id of this state, provided by system. | string(osid‑id) |
| uri(read‑only) | The uri of this state, provided by system. | string(uri) |
| displayName | The name of this state for display. | string |
| description | The description of this state. | string |
| genusType (read‑only) | The immutable type of this state. Default type set by system unless specified in query parameter. | string(osid‑type) |
Processes
A Process is a collection (catalog) of States. States are mapped to a Process to form a finite state machine.
The standard catalog federating pattern was blindly applied which can create views of combined processes. What this means in practice is anyone's guess.
As an auxiliary orchestrated service, a Process represents not only a collection of States but also the implicit object type of the mapped Ids. For example, the "Publishing Asset" process manages Asset Ids where all Assets in the orchestrated repository are known and already in some initial State.
| Field | Description | Type |
|---|---|---|
| id(read‑only) | The unique id of this process, provided by system. | string(osid‑id) |
| uri(read‑only) | The uri of this process, provided by system. | string(uri) |
| displayName | The name of this process for display. | string |
| description | The description of this process. | string |
| genusType (read‑only) | The immutable type of this process. Default type set by system unless specified in query parameter. | string(osid‑type) |
| providerId | The provider of this process. References a resource.Resource object. | string(osid‑id) |
| brandingIds | The branding of this process. References repository.Asset objects. | string(osid‑id)[] |
| license | The licensing that applies to this process. | string |
License
CampusAPI REST Documentation Copyright 2020 DXtera Institute. Based on the Open Service Interface Defitions: http://osid.org
/states
Collection of states in a system, federation of systems, or in a default process.
Get all states in the system or default process.
Create a new state in the default process.
get /states
Get all states in the system or default process.
Query Parameters
- offset: (integer - default: 0)
Skip over a number of elements by specifying an offset value for the query
Example:
20 - limit: (integer - default: 10)
Limit the number of elements on the response
Example:
80 - genusType: (string)
The id string to match a genusType
Example:
type.Type%3AexampleStateType%40dxtera.org - parentGenusType: (string)
The id string to match a parent genusType
Example:
type.Type%3AparentTypeExampleStateType%40dxtera.org - processId: (string)
The id string to match a process
Example:
process.Process%3A8374%40demo.dxtera.org
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
[
{
"id": "process.State:1344@demo.dxtera.org",
"uri": "http://demo.dxtera.org/open/campusapi/process/state/process.State%3A1344%40demo.dxtera.org",
"displayName": "Display Name of this State",
"description": "The description of this State",
"genusType": "type.Type:defaultStateType@dxtera.org"
},
{
"...": "..."
}
]
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
post /states
Create a new state in the default process.
Query Parameters
- genusType: (string)
specify a particular state type to create
Example:
type.Type%3AexampleStateType%40dxtera.org - processId: (string)
specify in which process to create this state
Example:
process.Process%3A8374%40demo.dxtera.org
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "State",
"type": "object",
"properties": {
"id": {
"description": "The unique id of this state, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this state, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this state for display.",
"type": "string"
},
"description": {
"description": "The description of this state.",
"type": "string"
},
"genusType": {
"description": "The immutable type of this state. Default type set by system unless specified in query parameter.",
"type": "string",
"format": "osid-type",
"readOnly": true
}
}
}Example:
{
"id": "process.State:7638@demo.dxtera.org",
"uri": "http://demo.dxtera.org/open/campusapi/process/state/process.State%3A7638%40demo.dxtera.org",
"displayName": "Display Name of this State",
"description": "The description of this State"
}
Entity representing a state form metadata.
Get form metadata for creating a new state.
get /states/metadata
Get form metadata for creating a new state.
Query Parameters
- genusType: (string)
specify a particular state type to create
Example:
type.Type%3AexampleStateType%40dxtera.org - processId: (string)
specify in which process to create this state
Example:
process.Process%3A8374%40demo.dxtera.org
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"$schema": "http://json-schema.org/draft/2019-9/schema#",
"title": "State",
"type": "object",
"required": ["displayName"],
"properties": {
"id": {
"description": "The unique id of this state, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this state, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this state for display.",
"type": "string",
"read-only": false,
"minLength": 1,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "State.State:displayName@demo.dxtera.org",
"existingValue": "The Existing Name",
"elementLabel": "Name",
"instructions": "Enter a name for this state",
"linked": false
},
"description": {
"description": "The description of this state.",
"type": "string",
"read-only": false,
"minLength": 0,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "State.State:displayName@demo.demo.dxtera.org",
"existingValue": "The Existing Description",
"elementLabel": "Description",
"instructions": "Enter a description for this state",
"linked": false
},
"genusType": {
"description": "The immutable type of this state. Default type set by system unless specified in query parameter.",
"type": "string",
"format": "osid-type",
"readOnly": true
}
}
}
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
Entity representing a state
Get a state given its id.
Update a given state.
Delete a given state.
get /states/{stateId}
Get a state given its id.
URI Parameters
- stateId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"id": "process.State:1344@demo.dxtera.org",
"uri": "http://demo.dxtera.org/open/campusapi/process/state/process.State%3A1344%40demo.dxtera.org",
"displayName": "Display Name of this State",
"description": "The description of this State",
"genusType": "type.Type:defaultStateType@dxtera.org"
}
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{"message": "state not found" }
put /states/{stateId}
Update a given state.
URI Parameters
- stateId: required(string)
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "State",
"type": "object",
"properties": {
"id": {
"description": "The unique id of this state, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this state, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this state for display.",
"type": "string"
},
"description": {
"description": "The description of this state.",
"type": "string"
},
"genusType": {
"description": "The immutable type of this state. Default type set by system unless specified in query parameter.",
"type": "string",
"format": "osid-type",
"readOnly": true
}
}
}Example:
{
"id": "process.State:7638@demo.dxtera.org",
"uri": "http://demo.dxtera.org/open/campusapi/process/state/process.State%3A7638%40demo.dxtera.org",
"displayName": "Display Name of this State",
"description": "The description of this State"
}
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "The state has been updated" }
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{"message": "state not found" }
delete /states/{stateId}
Delete a given state.
URI Parameters
- stateId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "The state has been deleted" }
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{"message": "state not found" }
Entity representing a state form metadata for update
Get form metadata for updating an existing state.
get /states/{stateId}/metadata
Get form metadata for updating an existing state.
URI Parameters
- stateId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"$schema": "http://json-schema.org/draft/2019-9/schema#",
"title": "State",
"type": "object",
"required": ["displayName"],
"properties": {
"id": {
"description": "The unique id of this state, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this state, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this state for display.",
"type": "string",
"read-only": false,
"minLength": 1,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "State.State:displayName@demo.dxtera.org",
"existingValue": "The Existing Name",
"elementLabel": "Name",
"instructions": "Enter a name for this state",
"linked": false
},
"description": {
"description": "The description of this state.",
"type": "string",
"read-only": false,
"minLength": 0,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "State.State:displayName@demo.demo.dxtera.org",
"existingValue": "The Existing Description",
"elementLabel": "Description",
"instructions": "Enter a description for this state",
"linked": false
},
"genusType": {
"description": "The immutable type of this state. Default type set by system unless specified in query parameter.",
"type": "string",
"format": "osid-type",
"readOnly": true
}
}
}
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{"message": "state not found" }
/processes
Collection of processes in a system or federation of systems.
Get all processes.
Create a new process.
get /processes
Get all processes.
Query Parameters
- offset: (integer - default: 0)
Skip over a number of elements by specifying an offset value for the query
Example:
20 - limit: (integer - default: 10)
Limit the number of elements on the response
Example:
80 - genusType: (string)
The id string to match a genusType
Example:
type.Type%3AexampleProcessType%40dxtera.org - parentGenusType: (string)
The id string to match a parent genusType
Example:
type.Type%3AparentTypeExampleProcessType%40dxtera.org - providerId: (string)
Id string to match provider.
Example:
resource.Resource%3A3007%40demo.dxtera.org - stateId: (string)
Get processes mapped to this state.
Example:
process.State%3A245%40demo.dxtera.org
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
[
{
"id": "process.Process:4955@demo.dxtera.org",
"uri": "http://demo.dxtera.org/open/campusapi/process/process/process.Process%3A4955%40demo.dxtera.org",
"displayName": "Display Name of this Process",
"description": "The description of this Process",
"genusType": "type.Type:defaultProcessType@dxtera.org",
"providerId": "resource.Resource:123@demo.dxtera.org",
"brandingId": "asset.Asset:Process@demo.dxtera.org",
"license": "The license that applies to this Process"
},
{
"...": "..."
}
]
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
post /processes
Create a new process.
Query Parameters
- genusType: (string)
specify a particular process type to create
Example:
type.Type%3AexampleProcessType%40dxtera.org
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Process",
"type": "object",
"properties": {
"id": {
"description": "The unique id of this process, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this process, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this process for display.",
"type": "string"
},
"description": {
"description": "The description of this process.",
"type": "string"
},
"genusType": {
"description": "The immutable type of this process. Default type set by system unless specified in query parameter.",
"type": "string",
"format": "osid-type",
"readOnly": true
},
"providerId": {
"description": "The provider of this process.",
"type": "string",
"format": "osid-id"
},
"brandingIds": {
"description": "The branding of this process. A collection of Assets.",
"type": "array",
"items" : {
"type": "string",
"format": "osid-id"
}
},
"license": {
"description": "The licensing that applies to this process.",
"type": "string"
}
}
}Example:
{
"id": "process.Process:6516@demo.dxtera.org",
"uri": "http://demo.dxtera.org/open/campusapi/process/process/process.Process%3A6516%40demo.dxtera.org",
"displayName": "Display Name of this Process",
"description": "The description of this Process",
"providerId": "resource.Resource:123@demo.dxtera.org",
"brandingId": "asset.Asset:Process@demo.dxtera.org",
"license": "The license that applies to this Process"
}
Entity representing a process form metadata.
Get form metadata for creating a new process.
get /processes/metadata
Get form metadata for creating a new process.
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"$schema": "http://json-schema.org/draft/2019-9/schema#",
"title": "Process",
"type": "object",
"required": ["displayName"],
"properties": {
"id": {
"description": "The unique id of this process, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this process, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this process for display.",
"type": "string",
"read-only": false,
"minLength": 1,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Process.Process:displayName@demo.dxtera.org",
"existingValue": "The Existing Name",
"elementLabel": "Name",
"instructions": "Enter a name for this process",
"linked": false
},
"description": {
"description": "The description of this process.",
"type": "string",
"read-only": false,
"minLength": 0,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Process.Process:displayName@demo.demo.dxtera.org",
"existingValue": "The Existing Description",
"elementLabel": "Description",
"instructions": "Enter a description for this process",
"linked": false
},
"genusType": {
"description": "The immutable type of this process. Default type set by system unless specified in query parameter.",
"type": "string",
"format": "osid-type",
"readOnly": true
},
"providerId": {
"description": "The provider of this process.",
"type": "string",
"format": "osid-id",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Process.Process:provider@demo.dxtera.org",
"existingValue": "",
"elementLabel": "Provider",
"instructions": "Enter the provider of this process",
"linked": false
},
"brandingIds": {
"description": "The branding of this process. A list of Assets.",
"type": "array",
"items" : {
"type": "string",
"format": "osid-id",
"pattern": "",
"enum": []
},
"read-only": false,
"default": [],
"elementId": "Process.Process:branding@demo.dxtera.org",
"existingValue": "",
"elementLabel": "Branding",
"instructions": "Enter the branding images for this process",
"linked": false
},
"license": {
"description": "The licensing that applies to this process.",
"type": "string",
"read-only": false,
"minLength": 0,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Process.Process:license@demo.dxtera.org",
"existingValue": "The Existing License",
"elementLabel": "License",
"instructions": "Include a license for this process",
"linked": false
}
}
}
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
The root processes in the process hierarchy. A node with no parents is an orphan. While all process Ids are known to the hierarchy, an orphan does not appear in the hierarchy unless explicitly added as a root node or child of another node.
Get all root root-process
get /processes/root-process
Get all root root-process
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
[
{
"id": "process.Process:4955@demo.dxtera.org",
"uri": "http://demo.dxtera.org/open/campusapi/process/process/process.Process%3A4955%40demo.dxtera.org",
"displayName": "Display Name of this Process",
"description": "The description of this Process",
"genusType": "type.Type:defaultProcessType@dxtera.org",
"providerId": "resource.Resource:123@demo.dxtera.org",
"brandingId": "asset.Asset:Process@demo.dxtera.org",
"license": "The license that applies to this Process"
},
{
"...": "..."
}
]
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
Entity representing a process
Get a process given its id.
Update a given process.
Delete a given process.
get /processes/{processId}
Get a process given its id.
URI Parameters
- processId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"id": "process.Process:4955@demo.dxtera.org",
"uri": "http://demo.dxtera.org/open/campusapi/process/process/process.Process%3A4955%40demo.dxtera.org",
"displayName": "Display Name of this Process",
"description": "The description of this Process",
"genusType": "type.Type:defaultProcessType@dxtera.org",
"providerId": "resource.Resource:123@demo.dxtera.org",
"brandingId": "asset.Asset:Process@demo.dxtera.org",
"license": "The license that applies to this Process"
}
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{"message": "process not found" }
put /processes/{processId}
Update a given process.
URI Parameters
- processId: required(string)
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Process",
"type": "object",
"properties": {
"id": {
"description": "The unique id of this process, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this process, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this process for display.",
"type": "string"
},
"description": {
"description": "The description of this process.",
"type": "string"
},
"genusType": {
"description": "The immutable type of this process. Default type set by system unless specified in query parameter.",
"type": "string",
"format": "osid-type",
"readOnly": true
},
"providerId": {
"description": "The provider of this process.",
"type": "string",
"format": "osid-id"
},
"brandingIds": {
"description": "The branding of this process. A collection of Assets.",
"type": "array",
"items" : {
"type": "string",
"format": "osid-id"
}
},
"license": {
"description": "The licensing that applies to this process.",
"type": "string"
}
}
}Example:
{
"id": "process.Process:6516@demo.dxtera.org",
"uri": "http://demo.dxtera.org/open/campusapi/process/process/process.Process%3A6516%40demo.dxtera.org",
"displayName": "Display Name of this Process",
"description": "The description of this Process",
"providerId": "resource.Resource:123@demo.dxtera.org",
"brandingId": "asset.Asset:Process@demo.dxtera.org",
"license": "The license that applies to this Process"
}
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "The process has been updated" }
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{"message": "process not found" }
delete /processes/{processId}
Delete a given process.
URI Parameters
- processId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "The process has been deleted" }
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{"message": "process not found" }
Entity representing a process form metadata for update
Get form metadata for updating an existing process.
get /processes/{processId}/metadata
Get form metadata for updating an existing process.
URI Parameters
- processId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"$schema": "http://json-schema.org/draft/2019-9/schema#",
"title": "Process",
"type": "object",
"required": ["displayName"],
"properties": {
"id": {
"description": "The unique id of this process, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this process, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this process for display.",
"type": "string",
"read-only": false,
"minLength": 1,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Process.Process:displayName@demo.dxtera.org",
"existingValue": "The Existing Name",
"elementLabel": "Name",
"instructions": "Enter a name for this process",
"linked": false
},
"description": {
"description": "The description of this process.",
"type": "string",
"read-only": false,
"minLength": 0,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Process.Process:displayName@demo.demo.dxtera.org",
"existingValue": "The Existing Description",
"elementLabel": "Description",
"instructions": "Enter a description for this process",
"linked": false
},
"genusType": {
"description": "The immutable type of this process. Default type set by system unless specified in query parameter.",
"type": "string",
"format": "osid-type",
"readOnly": true
},
"providerId": {
"description": "The provider of this process.",
"type": "string",
"format": "osid-id",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Process.Process:provider@demo.dxtera.org",
"existingValue": "",
"elementLabel": "Provider",
"instructions": "Enter the provider of this process",
"linked": false
},
"brandingIds": {
"description": "The branding of this process. A list of Assets.",
"type": "array",
"items" : {
"type": "string",
"format": "osid-id",
"pattern": "",
"enum": []
},
"read-only": false,
"default": [],
"elementId": "Process.Process:branding@demo.dxtera.org",
"existingValue": "",
"elementLabel": "Branding",
"instructions": "Enter the branding images for this process",
"linked": false
},
"license": {
"description": "The licensing that applies to this process.",
"type": "string",
"read-only": false,
"minLength": 0,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Process.Process:license@demo.dxtera.org",
"existingValue": "The Existing License",
"elementLabel": "License",
"instructions": "Include a license for this process",
"linked": false
}
}
}
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{"message": "process not found" }
Get children processes for the given process in the hierarchy.
get /processes/{processId}/children
Get children processes for the given process in the hierarchy.
URI Parameters
- processId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
[
{
"id": "process.Process:4955@demo.dxtera.org",
"uri": "http://demo.dxtera.org/open/campusapi/process/process/process.Process%3A4955%40demo.dxtera.org",
"displayName": "Display Name of this Process",
"description": "The description of this Process",
"genusType": "type.Type:defaultProcessType@dxtera.org",
"providerId": "resource.Resource:123@demo.dxtera.org",
"brandingId": "asset.Asset:Process@demo.dxtera.org",
"license": "The license that applies to this Process"
},
{
"...": "..."
}
]
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
Add process as child of the given process in the hierarchy.
Remove the given process as a child of the given process in the hierarchy.
put /processes/{processId}/children/{childId}
Add process as child of the given process in the hierarchy.
URI Parameters
- processId: required(string)
- childId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "The child process has been added" }
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{ "message": "process not found" }
delete /processes/{processId}/children/{childId}
Remove the given process as a child of the given process in the hierarchy.
Get all states in this process
get /processes/{processId}/states
Get all states in this process
URI Parameters
- processId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
[
{
"id": "process.State:1344@demo.dxtera.org",
"uri": "http://demo.dxtera.org/open/campusapi/process/state/process.State%3A1344%40demo.dxtera.org",
"displayName": "Display Name of this State",
"description": "The description of this State",
"genusType": "type.Type:defaultStateType@dxtera.org"
},
{
"...": "..."
}
]
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
Add the given state to this process
Remove the given state from the process.
put /processes/{processId}/states/{stateId}
Add the given state to this process
URI Parameters
- processId: required(string)
- stateId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "state has been added to process" }
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{ "message": "state not found" }
delete /processes/{processId}/states/{stateId}
Remove the given state from the process.
URI Parameters
- processId: required(string)
- stateId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "state has been removed" }
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{ "message": "state not found" }