DomainCommonWorkflow

An API that supports general workflow processes.

More information: https://it.byu.edu
Contact Info: api@byu.edu

Base URL: /domains/common/workflow

Version: v1

Default response content-types: application/json
Schemes: https

Summary

Path Operation Description
/ GET

Get the list of workflows

POST

Add a workflow

/{workflow_id} GET

Get a workflow

PUT

Modify a workflow

/{workflow_id}/input/{packet_id} PUT

Input a packet to a workflow

/{workflow_id}/member/{byu_id} GET

Get processes for member

/{workflow_id}/packet_sets GET

Get the list of packet sets

POST

Create a packet set

/{workflow_id}/packet_sets/{packet_set_id} DELETE

Remove a packet set

GET

Get the packets in a packet set

PUT

Modify a packet set

/{workflow_id}/packet_sets/{packet_set_id}/packet/{packet_id} DELETE

Remove a packet from a packet set

PUT

Add a packet to a packet set

/{workflow_id}/processes GET

Get the list of processes

POST

Add a process

/{workflow_id}/processes/{process_id} GET

Get a process

PUT

Modify a process

/{workflow_id}/processes/{process_id}/input/{packet_id} PUT

Input a packet to a process

/{workflow_id}/processes/{process_id}/log GET

Get the process log

PUT

Add a process log message

/{workflow_id}/processes/{process_id}/member/{byu_id} DELETE

Remove a person from a process

PUT

Associate a person with a process

/{workflow_id}/processes/{process_id}/packet_set_ref PUT

Add a packet set reference

/{workflow_id}/processes/{process_id}/role/{byu_id} DELETE

Remove a role from a process

PUT

Associate a person with a process

/{workflow_id}/processes/{process_id}/subprocess PUT

Add a subprocess

/{workflow_id}/processes/{process_id}/work/{byu_id} GET

Get the next work packet

PUT

Finish a work packet

Paths

Get the list of workflows

GET /

Tags: Workflows

Get the list of workflow objects.

page_start

Skip into a large collection to this item

query string #/parameters/page_start
page_size

Return this many items of a large collection

query string #/parameters/page_size

Uses default content-types: application/json

200 OK

Retrieved the list of workflow objects

Example for application/json
{
"links": {
"workflow__add": {
"href": "https://api.byu.edu/domain/common/workflow/v1",
"method": "POST",
"rel": "workflow__add"
}
,
"workflows__info": {
"href": "https://api.byu.edu/domain/common/workflow/v1?page_start=51&page_size=50",
"method": "GET",
"rel": "self"
}
}
,
"metadata": {
"collection_size": 1,
"default_page_size": 50,
"max_page_size": 1000,
"page_end": 1,
"page_size": 1,
"page_start": 1,
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"values": [
{
"attributes": {
"api_type": "modifiable",
"display_label": "attributes",
"values": [
{
"key": "institution",
"value": "BYUP"
},
{
"key": "admit_period",
"value": "2018F"
}
]
}
,
"event_handler": {
"api_type": "modifiable",
"display_label": "Event Handler",
"value": "myLambda@aws"
}
,
"id": {
"api_type": "modifiable",
"display_label": "ID",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
}
,
"input_set": {
"api_type": "modifiable",
"display_label": "Input Set",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
}
,
"links": {
"workflow__info": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id",
"method": "GET",
"rel": "self"
}
,
"workflow__modify": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id",
"method": "PUT",
"rel": "workflow__modify"
}
}
,
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"name": {
"api_type": "modifiable",
"display_label": "Name",
"value": "BYUP-2018F"
}
,
"output_set": {
"api_type": "modifiable",
"display_label": "Output Set",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
}
,
"processes": {
"api_type": "modifiable",
"display_label": "Processes",
"values": [
{
"key": "screen",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
},
{
"key": "score",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
},
{
"key": "model",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
}
]
}
}
]
}
400 Bad Request #/responses/400

Invalid Request - unable to interpret request

401 Unauthorized #/responses/401

Authentication required to access data

403 Forbidden #/responses/403

Access denied to protected data

409 Conflict #/responses/409

Query parameters conflict or are malformed

default #/responses/default

Unexpected error

Add a workflow

POST /

Tags: Workflows

Creates an decision processing packet

New workflow

Uses default content-types: application/json

201 Created

Workflow successfully created

Example for application/json
{
"attributes": {
"api_type": "modifiable",
"display_label": "attributes",
"values": [
{
"key": "institution",
"value": "BYUP"
},
{
"key": "admit_period",
"value": "2018F"
}
]
}
,
"event_handler": {
"api_type": "modifiable",
"display_label": "Event Handler",
"value": "myLambda@aws"
}
,
"id": {
"api_type": "modifiable",
"display_label": "ID",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
}
,
"input_set": {
"api_type": "modifiable",
"display_label": "Input Set",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
}
,
"links": {
"workflow__info": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id",
"method": "GET",
"rel": "self"
}
,
"workflow__modify": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id",
"method": "PUT",
"rel": "workflow__modify"
}
}
,
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"name": {
"api_type": "modifiable",
"display_label": "Name",
"value": "BYUP-2018F"
}
,
"output_set": {
"api_type": "modifiable",
"display_label": "Output Set",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
}
,
"processes": {
"api_type": "modifiable",
"display_label": "Processes",
"values": [
{
"key": "screen",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
},
{
"key": "score",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
},
{
"key": "model",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
}
]
}
}
400 Bad Request #/responses/400

Invalid Request - unable to interpret request

401 Unauthorized #/responses/401

Authentication required to access data

403 Forbidden #/responses/403

Access denied to protected data

409 Conflict #/responses/409

Query parameters conflict or are malformed

default #/responses/default

Unexpected error

Get a workflow

GET /{workflow_id}

Tags: Workflows

Get a workflow object.

workflow_id

Workflow UUID

path string #/parameters/workflow_id

Uses default content-types: application/json

200 OK

Retrieve a workflow object

Example for application/json
{
"attributes": {
"api_type": "modifiable",
"display_label": "attributes",
"values": [
{
"key": "institution",
"value": "BYUP"
},
{
"key": "admit_period",
"value": "2018F"
}
]
}
,
"event_handler": {
"api_type": "modifiable",
"display_label": "Event Handler",
"value": "myLambda@aws"
}
,
"id": {
"api_type": "modifiable",
"display_label": "ID",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
}
,
"input_set": {
"api_type": "modifiable",
"display_label": "Input Set",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
}
,
"links": {
"workflow__info": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id",
"method": "GET",
"rel": "self"
}
,
"workflow__modify": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id",
"method": "PUT",
"rel": "workflow__modify"
}
}
,
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"name": {
"api_type": "modifiable",
"display_label": "Name",
"value": "BYUP-2018F"
}
,
"output_set": {
"api_type": "modifiable",
"display_label": "Output Set",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
}
,
"processes": {
"api_type": "modifiable",
"display_label": "Processes",
"values": [
{
"key": "screen",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
},
{
"key": "score",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
},
{
"key": "model",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
}
]
}
}
400 Bad Request #/responses/400

Invalid Request - unable to interpret request

401 Unauthorized #/responses/401

Authentication required to access data

403 Forbidden #/responses/403

Access denied to protected data

404 Not Found #/responses/404

Application not found

409 Conflict #/responses/409

Query parameters conflict or are malformed

default #/responses/default

Unexpected error

Modify a workflow

PUT /{workflow_id}

Tags: Workflows

Modify workflow object

Workflow modifications

workflow_id

Workflow UUID

path string #/parameters/workflow_id

Uses default content-types: application/json

200 OK

Workflow successfully modified

Example for application/json
{
"attributes": {
"api_type": "modifiable",
"display_label": "attributes",
"values": [
{
"key": "institution",
"value": "BYUP"
},
{
"key": "admit_period",
"value": "2018F"
}
]
}
,
"event_handler": {
"api_type": "modifiable",
"display_label": "Event Handler",
"value": "myLambda@aws"
}
,
"id": {
"api_type": "modifiable",
"display_label": "ID",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
}
,
"input_set": {
"api_type": "modifiable",
"display_label": "Input Set",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
}
,
"links": {
"workflow__info": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id",
"method": "GET",
"rel": "self"
}
,
"workflow__modify": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id",
"method": "PUT",
"rel": "workflow__modify"
}
}
,
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"name": {
"api_type": "modifiable",
"display_label": "Name",
"value": "BYUP-2018F"
}
,
"output_set": {
"api_type": "modifiable",
"display_label": "Output Set",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
}
,
"processes": {
"api_type": "modifiable",
"display_label": "Processes",
"values": [
{
"key": "screen",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
},
{
"key": "score",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
},
{
"key": "model",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
}
]
}
}
400 Bad Request #/responses/400

Invalid Request - unable to interpret request

401 Unauthorized #/responses/401

Authentication required to access data

403 Forbidden #/responses/403

Access denied to protected data

404 Not Found #/responses/404

Application not found

409 Conflict #/responses/409

Query parameters conflict or are malformed

default #/responses/default

Unexpected error

Input a packet to a workflow

PUT /{workflow_id}/input/{packet_id}

Tags: Workflows

Add a packet to the input set of a workflow object.

workflow_id

Workflow UUID

path string #/parameters/workflow_id
packet_id

Packet UUID

path string #/parameters/packet_id

Uses default content-types: application/json

200 OK

Packet input succeeded

Example for application/json
{
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
}
}
400 Bad Request #/responses/400

Invalid Request - unable to interpret request

401 Unauthorized #/responses/401

Authentication required to access data

403 Forbidden #/responses/403

Access denied to protected data

404 Not Found #/responses/404

Application not found

409 Conflict #/responses/409

Query parameters conflict or are malformed

default #/responses/default

Unexpected error

Get processes for member

GET /{workflow_id}/member/{byu_id}

Tags: Process Members

Return the processes within a given workflow with which a member is associated.

workflow_id

Workflow UUID

path string #/parameters/workflow_id
byu_id

BYU ID

path string #/parameters/byu_id

Uses default content-types: application/json

200 OK

List of processes associated with member

Example for application/json
{
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"values": [
{
"key": "screen",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
},
{
"key": "score",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
},
{
"key": "model",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
}
]
}
400 Bad Request #/responses/400

Invalid Request - unable to interpret request

401 Unauthorized #/responses/401

Authentication required to access data

403 Forbidden #/responses/403

Access denied to protected data

409 Conflict #/responses/409

Query parameters conflict or are malformed

default #/responses/default

Unexpected error

Get the list of packet sets

GET /{workflow_id}/packet_sets

Tags: Packet Sets

Responds with a success validation_response (200) when pinged

workflow_id

Workflow UUID

path string #/parameters/workflow_id
page_start

Skip into a large collection to this item

query string #/parameters/page_start
page_size

Return this many items of a large collection

query string #/parameters/page_size

Uses default content-types: application/json

200 OK

Retrived list of packet sets

Example for application/json
{
"links": {
"packet_set__add": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/packet_sets",
"method": "POST",
"rel": "packet_set__add"
}
,
"packet_sets__info": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/packet_sets?page_start=51&page_size=50",
"method": "GET",
"rel": "self"
}
}
,
"metadata": {
"collection_size": 1,
"default_page_size": 50,
"max_page_size": 1000,
"page_end": 1,
"page_size": 1,
"page_start": 1,
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"values": [
{
"attributes": {
"api_type": "modifiable",
"display_label": "Attributes",
"values": [
{
"key": "admit_period",
"value": "2018F"
},
{
"key": "name",
"value": "IntF"
},
{
"key": "description",
"value": "International Freshmen"
},
{
"key": "type",
"value": "SCREEN"
}
]
}
,
"id": {
"api_type": "system",
"display_label": "ID",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
}
,
"links": {
"packet_set__info": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/packet_sets/:packet_set_id",
"method": "GET",
"rel": "self"
}
,
"packet_set__modify": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/packet_sets/:packet_set_id",
"method": "PUT",
"rel": "packet_set__modify"
}
}
,
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"packet_refs": {
"api_type": "modifiable",
"display_label": "Packet References",
"values": [
"cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
]
}
}
]
}
400 Bad Request #/responses/400

Invalid Request - unable to interpret request

401 Unauthorized #/responses/401

Authentication required to access data

403 Forbidden #/responses/403

Access denied to protected data

404 Not Found #/responses/404

Application not found

409 Conflict #/responses/409

Query parameters conflict or are malformed

default #/responses/default

Unexpected error

Create a packet set

POST /{workflow_id}/packet_sets

Tags: Packet Sets

Create a packet set

New packet set

workflow_id

Workflow UUID

path string #/parameters/workflow_id

Uses default content-types: application/json

201 Created

Packet set successfully created

Example for application/json
{
"attributes": {
"api_type": "modifiable",
"display_label": "Attributes",
"values": [
{
"key": "admit_period",
"value": "2018F"
},
{
"key": "name",
"value": "IntF"
},
{
"key": "description",
"value": "International Freshmen"
},
{
"key": "type",
"value": "SCREEN"
}
]
}
,
"id": {
"api_type": "system",
"display_label": "ID",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
}
,
"links": {
"packet_set__info": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/packet_sets/:packet_set_id",
"method": "GET",
"rel": "self"
}
,
"packet_set__modify": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/packet_sets/:packet_set_id",
"method": "PUT",
"rel": "packet_set__modify"
}
}
,
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"packet_refs": {
"api_type": "modifiable",
"display_label": "Packet References",
"values": [
"cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
]
}
}
400 Bad Request #/responses/400

Invalid Request - unable to interpret request

401 Unauthorized #/responses/401

Authentication required to access data

403 Forbidden #/responses/403

Access denied to protected data

409 Conflict #/responses/409

Query parameters conflict or are malformed

default #/responses/default

Unexpected error

Remove a packet set

DELETE /{workflow_id}/packet_sets/{packet_set_id}

Tags: Packet Sets

Remove a packet set

workflow_id

Workflow UUID

path string #/parameters/workflow_id
packet_set_id

Packet Set UUID

path string #/parameters/packet_set_id

Uses default content-types: application/json

204 No Content

Packet reference successfully removed

400 Bad Request #/responses/400

Invalid Request - unable to interpret request

401 Unauthorized #/responses/401

Authentication required to access data

403 Forbidden #/responses/403

Access denied to protected data

default #/responses/default

Unexpected error

Get the packets in a packet set

GET /{workflow_id}/packet_sets/{packet_set_id}

Tags: Packet Sets

Retrieve the list of packets in a packet set

workflow_id

Workflow UUID

path string #/parameters/workflow_id
packet_set_id

Packet Set UUID

path string #/parameters/packet_set_id

Uses default content-types: application/json

200 OK

Retrieved packet set

Example for application/json
{
"attributes": {
"api_type": "modifiable",
"display_label": "Attributes",
"values": [
{
"key": "admit_period",
"value": "2018F"
},
{
"key": "name",
"value": "IntF"
},
{
"key": "description",
"value": "International Freshmen"
},
{
"key": "type",
"value": "SCREEN"
}
]
}
,
"id": {
"api_type": "system",
"display_label": "ID",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
}
,
"links": {
"packet_set__info": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/packet_sets/:packet_set_id",
"method": "GET",
"rel": "self"
}
,
"packet_set__modify": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/packet_sets/:packet_set_id",
"method": "PUT",
"rel": "packet_set__modify"
}
}
,
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"packet_refs": {
"api_type": "modifiable",
"display_label": "Packet References",
"values": [
"cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
]
}
}
400 Bad Request #/responses/400

Invalid Request - unable to interpret request

401 Unauthorized #/responses/401

Authentication required to access data

403 Forbidden #/responses/403

Access denied to protected data

404 Not Found #/responses/404

Application not found

409 Conflict #/responses/409

Query parameters conflict or are malformed

default #/responses/default

Unexpected error

Modify a packet set

PUT /{workflow_id}/packet_sets/{packet_set_id}

Tags: Packet Sets

Modify packet set attributes.

Modify packet set

workflow_id

Workflow UUID

path string #/parameters/workflow_id
packet_set_id

Packet Set UUID

path string #/parameters/packet_set_id

Uses default content-types: application/json

200 OK

Packet set successfully modified

Example for application/json
{
"attributes": {
"api_type": "modifiable",
"display_label": "Attributes",
"values": [
{
"key": "admit_period",
"value": "2018F"
},
{
"key": "name",
"value": "IntF"
},
{
"key": "description",
"value": "International Freshmen"
},
{
"key": "type",
"value": "SCREEN"
}
]
}
,
"id": {
"api_type": "system",
"display_label": "ID",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
}
,
"links": {
"packet_set__info": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/packet_sets/:packet_set_id",
"method": "GET",
"rel": "self"
}
,
"packet_set__modify": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/packet_sets/:packet_set_id",
"method": "PUT",
"rel": "packet_set__modify"
}
}
,
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"packet_refs": {
"api_type": "modifiable",
"display_label": "Packet References",
"values": [
"cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
]
}
}
400 Bad Request #/responses/400

Invalid Request - unable to interpret request

401 Unauthorized #/responses/401

Authentication required to access data

403 Forbidden #/responses/403

Access denied to protected data

409 Conflict #/responses/409

Query parameters conflict or are malformed

default #/responses/default

Unexpected error

Remove a packet from a packet set

DELETE /{workflow_id}/packet_sets/{packet_set_id}/packet/{packet_id}

Tags: Packet Sets

Remove a packet from a packet set

workflow_id

Workflow UUID

path string #/parameters/workflow_id
packet_set_id

Packet Set UUID

path string #/parameters/packet_set_id
packet_id

Packet UUID

path string #/parameters/packet_id

Uses default content-types: application/json

204 No Content

Packet reference successfully removed

400 Bad Request #/responses/400

Invalid Request - unable to interpret request

401 Unauthorized #/responses/401

Authentication required to access data

403 Forbidden #/responses/403

Access denied to protected data

default #/responses/default

Unexpected error

Add a packet to a packet set

PUT /{workflow_id}/packet_sets/{packet_set_id}/packet/{packet_id}

Tags: Packet Sets

Add a packet to a packet set

workflow_id

Workflow UUID

path string #/parameters/workflow_id
packet_set_id

Packet Set UUID

path string #/parameters/packet_set_id
packet_id

Packet UUID

path string #/parameters/packet_id

Uses default content-types: application/json

200 OK

Packet successfully added to packet set

Example for application/json
{
"attributes": {
"api_type": "modifiable",
"display_label": "Attributes",
"values": [
{
"key": "admit_period",
"value": "2018F"
},
{
"key": "name",
"value": "IntF"
},
{
"key": "description",
"value": "International Freshmen"
},
{
"key": "type",
"value": "SCREEN"
}
]
}
,
"id": {
"api_type": "system",
"display_label": "ID",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
}
,
"links": {
"packet_set__info": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/packet_sets/:packet_set_id",
"method": "GET",
"rel": "self"
}
,
"packet_set__modify": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/packet_sets/:packet_set_id",
"method": "PUT",
"rel": "packet_set__modify"
}
}
,
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"packet_refs": {
"api_type": "modifiable",
"display_label": "Packet References",
"values": [
"cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
]
}
}
400 Bad Request #/responses/400

Invalid Request - unable to interpret request

401 Unauthorized #/responses/401

Authentication required to access data

403 Forbidden #/responses/403

Access denied to protected data

409 Conflict #/responses/409

Query parameters conflict or are malformed

default #/responses/default

Unexpected error

Get the list of processes

GET /{workflow_id}/processes

Tags: Processes

Retrieve a list of processes

workflow_id

Workflow UUID

path string #/parameters/workflow_id
page_start

Skip into a large collection to this item

query string #/parameters/page_start
page_size

Return this many items of a large collection

query string #/parameters/page_size

Uses default content-types: application/json

200 OK

Retrieved a list of processes

Example for application/json
{
"links": {
"process__add": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes",
"method": "POST",
"rel": "process__add"
}
,
"processes__info": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes?page_start=51&page_size=50",
"method": "GET",
"rel": "self"
}
}
,
"metadata": {
"collection_size": 1,
"default_page_size": 50,
"max_page_size": 1000,
"page_end": 1,
"page_size": 1,
"page_start": 1,
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"values": [
{
"attributes": {
"api_type": "modifiable",
"display_label": "Attributes",
"values": [
{
"key": "process",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
},
{
"key": "institution",
"value": "BYUP"
},
{
"key": "admit_period",
"value": "2018F"
}
]
}
,
"event_handler": {
"api_type": "modifiable",
"display_label": "Event Handler",
"value": "myLambda@aws"
}
,
"id": {
"api_type": "system",
"display_label": "ID",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
}
,
"input_set": {
"api_type": "modifiable",
"display_label": "Input Set",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
}
,
"links": {
"process__info": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id",
"method": "GET",
"rel": "self"
}
,
"process__modify": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id",
"method": "PUT",
"rel": "process__modify"
}
,
"process_log__add": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id/log",
"method": "PUT",
"rel": "process_log__add"
}
,
"process_log__info": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id/log",
"method": "GET",
"rel": "process_log__info"
}
,
"process_member__add": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id/member/:byu_id",
"method": "PUT",
"rel": "process_member__add"
}
,
"process_member__remove": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id/member/:byu_id",
"method": "DELETE",
"rel": "process_member__remove"
}
,
"process_packet_set__add": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id/packet_set_ref",
"method": "PUT",
"rel": "process_packet_set__add"
}
,
"process_role__add": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id/role/:byu_id",
"method": "PUT",
"rel": "process_role__add"
}
,
"process_role__remove": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id/role/:byu_id",
"method": "DELETE",
"rel": "process_role__remove"
}
,
"process_subprocess__add": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id/subprocess",
"method": "PUT",
"rel": "process_subprocess__add"
}
}
,
"log": {
"links": {
"process_log__add": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id/log",
"method": "PUT",
"rel": "process_log__add"
}
,
"process_log__info": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id/log",
"method": "GET",
"rel": "self"
}
}
,
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"values": [
{
"action": {
"api_type": "modifiable",
"display_label": "Action",
"value": "Updated status"
}
,
"date_time_updated": {
"api_type": "system",
"display_label": "Updated",
"value": "2014-05-11T13:45:53.200Z"
}
,
"id_updated_by": {
"api_type": "system",
"description": "Bugs Bunny Ithaca",
"display_label": "Updated by",
"value": "764634873"
}
}
]
}
,
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"name": {
"api_type": "modifiable",
"display_label": "Name",
"value": "Transfer 1"
}
,
"output_set": {
"api_type": "modifiable",
"display_label": "Output Set",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
}
,
"packet_set_refs": {
"api_type": "modifiable",
"display_label": "Packet Set References",
"values": [
{
"key": "Score0",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
},
{
"key": "Score1",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
},
{
"key": "Score2",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
}
]
}
,
"people": {
"api_type": "modifiable",
"display_label": "People",
"members": [
"987654321",
"876543219",
"765432198"
]
,
"roles": [
{
"key": "leader",
"value": "123456789"
}
]
}
,
"processes": {
"api_type": "modifiable",
"display_label": "Processes",
"values": [
{
"key": "screen",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
},
{
"key": "score",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
},
{
"key": "model",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
}
]
}
}
]
}
400 Bad Request #/responses/400

Invalid Request - unable to interpret request

401 Unauthorized #/responses/401

Authentication required to access data

403 Forbidden #/responses/403

Access denied to protected data

409 Conflict #/responses/409

Query parameters conflict or are malformed

default #/responses/default

Unexpected error

Add a process

POST /{workflow_id}/processes

Tags: Processes

Add a process

New process

workflow_id

Workflow UUID

path string #/parameters/workflow_id

Uses default content-types: application/json

201 Created

Process successfully created

Example for application/json
{
"attributes": {
"api_type": "modifiable",
"display_label": "Attributes",
"values": [
{
"key": "process",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
},
{
"key": "institution",
"value": "BYUP"
},
{
"key": "admit_period",
"value": "2018F"
}
]
}
,
"event_handler": {
"api_type": "modifiable",
"display_label": "Event Handler",
"value": "myLambda@aws"
}
,
"id": {
"api_type": "system",
"display_label": "ID",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
}
,
"input_set": {
"api_type": "modifiable",
"display_label": "Input Set",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
}
,
"links": {
"process__info": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id",
"method": "GET",
"rel": "self"
}
,
"process__modify": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id",
"method": "PUT",
"rel": "process__modify"
}
,
"process_log__add": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id/log",
"method": "PUT",
"rel": "process_log__add"
}
,
"process_log__info": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id/log",
"method": "GET",
"rel": "process_log__info"
}
,
"process_member__add": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id/member/:byu_id",
"method": "PUT",
"rel": "process_member__add"
}
,
"process_member__remove": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id/member/:byu_id",
"method": "DELETE",
"rel": "process_member__remove"
}
,
"process_packet_set__add": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id/packet_set_ref",
"method": "PUT",
"rel": "process_packet_set__add"
}
,
"process_role__add": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id/role/:byu_id",
"method": "PUT",
"rel": "process_role__add"
}
,
"process_role__remove": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id/role/:byu_id",
"method": "DELETE",
"rel": "process_role__remove"
}
,
"process_subprocess__add": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id/subprocess",
"method": "PUT",
"rel": "process_subprocess__add"
}
}
,
"log": {
"links": {
"process_log__add": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id/log",
"method": "PUT",
"rel": "process_log__add"
}
,
"process_log__info": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id/log",
"method": "GET",
"rel": "self"
}
}
,
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"values": [
{
"action": {
"api_type": "modifiable",
"display_label": "Action",
"value": "Updated status"
}
,
"date_time_updated": {
"api_type": "system",
"display_label": "Updated",
"value": "2014-05-11T13:45:53.200Z"
}
,
"id_updated_by": {
"api_type": "system",
"description": "Bugs Bunny Ithaca",
"display_label": "Updated by",
"value": "764634873"
}
}
]
}
,
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"name": {
"api_type": "modifiable",
"display_label": "Name",
"value": "Transfer 1"
}
,
"output_set": {
"api_type": "modifiable",
"display_label": "Output Set",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
}
,
"packet_set_refs": {
"api_type": "modifiable",
"display_label": "Packet Set References",
"values": [
{
"key": "Score0",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
},
{
"key": "Score1",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
},
{
"key": "Score2",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
}
]
}
,
"people": {
"api_type": "modifiable",
"display_label": "People",
"members": [
"987654321",
"876543219",
"765432198"
]
,
"roles": [
{
"key": "leader",
"value": "123456789"
}
]
}
,
"processes": {
"api_type": "modifiable",
"display_label": "Processes",
"values": [
{
"key": "screen",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
},
{
"key": "score",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
},
{
"key": "model",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
}
]
}
}
400 Bad Request #/responses/400

Invalid Request - unable to interpret request

401 Unauthorized #/responses/401

Authentication required to access data

403 Forbidden #/responses/403

Access denied to protected data

409 Conflict #/responses/409

Query parameters conflict or are malformed

default #/responses/default

Unexpected error

Get a process

GET /{workflow_id}/processes/{process_id}

Tags: Processes

Get a process

workflow_id

Workflow UUID

path string #/parameters/workflow_id
process_id

Process UUID

path string #/parameters/process_id

Uses default content-types: application/json

200 OK

Retrieve a process object

Example for application/json
{
"attributes": {
"api_type": "modifiable",
"display_label": "Attributes",
"values": [
{
"key": "process",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
},
{
"key": "institution",
"value": "BYUP"
},
{
"key": "admit_period",
"value": "2018F"
}
]
}
,
"event_handler": {
"api_type": "modifiable",
"display_label": "Event Handler",
"value": "myLambda@aws"
}
,
"id": {
"api_type": "system",
"display_label": "ID",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
}
,
"input_set": {
"api_type": "modifiable",
"display_label": "Input Set",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
}
,
"links": {
"process__info": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id",
"method": "GET",
"rel": "self"
}
,
"process__modify": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id",
"method": "PUT",
"rel": "process__modify"
}
,
"process_log__add": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id/log",
"method": "PUT",
"rel": "process_log__add"
}
,
"process_log__info": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id/log",
"method": "GET",
"rel": "process_log__info"
}
,
"process_member__add": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id/member/:byu_id",
"method": "PUT",
"rel": "process_member__add"
}
,
"process_member__remove": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id/member/:byu_id",
"method": "DELETE",
"rel": "process_member__remove"
}
,
"process_packet_set__add": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id/packet_set_ref",
"method": "PUT",
"rel": "process_packet_set__add"
}
,
"process_role__add": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id/role/:byu_id",
"method": "PUT",
"rel": "process_role__add"
}
,
"process_role__remove": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id/role/:byu_id",
"method": "DELETE",
"rel": "process_role__remove"
}
,
"process_subprocess__add": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id/subprocess",
"method": "PUT",
"rel": "process_subprocess__add"
}
}
,
"log": {
"links": {
"process_log__add": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id/log",
"method": "PUT",
"rel": "process_log__add"
}
,
"process_log__info": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id/log",
"method": "GET",
"rel": "self"
}
}
,
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"values": [
{
"action": {
"api_type": "modifiable",
"display_label": "Action",
"value": "Updated status"
}
,
"date_time_updated": {
"api_type": "system",
"display_label": "Updated",
"value": "2014-05-11T13:45:53.200Z"
}
,
"id_updated_by": {
"api_type": "system",
"description": "Bugs Bunny Ithaca",
"display_label": "Updated by",
"value": "764634873"
}
}
]
}
,
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"name": {
"api_type": "modifiable",
"display_label": "Name",
"value": "Transfer 1"
}
,
"output_set": {
"api_type": "modifiable",
"display_label": "Output Set",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
}
,
"packet_set_refs": {
"api_type": "modifiable",
"display_label": "Packet Set References",
"values": [
{
"key": "Score0",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
},
{
"key": "Score1",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
},
{
"key": "Score2",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
}
]
}
,
"people": {
"api_type": "modifiable",
"display_label": "People",
"members": [
"987654321",
"876543219",
"765432198"
]
,
"roles": [
{
"key": "leader",
"value": "123456789"
}
]
}
,
"processes": {
"api_type": "modifiable",
"display_label": "Processes",
"values": [
{
"key": "screen",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
},
{
"key": "score",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
},
{
"key": "model",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
}
]
}
}
400 Bad Request #/responses/400

Invalid Request - unable to interpret request

401 Unauthorized #/responses/401

Authentication required to access data

403 Forbidden #/responses/403

Access denied to protected data

404 Not Found #/responses/404

Application not found

409 Conflict #/responses/409

Query parameters conflict or are malformed

default #/responses/default

Unexpected error

Modify a process

PUT /{workflow_id}/processes/{process_id}

Tags: Processes

Modify a process

Modify process

workflow_id

Workflow UUID

path string #/parameters/workflow_id
process_id

Process UUID

path string #/parameters/process_id

Uses default content-types: application/json

200 OK

Process successfully modified

Example for application/json
{
"attributes": {
"api_type": "modifiable",
"display_label": "Attributes",
"values": [
{
"key": "process",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
},
{
"key": "institution",
"value": "BYUP"
},
{
"key": "admit_period",
"value": "2018F"
}
]
}
,
"event_handler": {
"api_type": "modifiable",
"display_label": "Event Handler",
"value": "myLambda@aws"
}
,
"id": {
"api_type": "system",
"display_label": "ID",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
}
,
"input_set": {
"api_type": "modifiable",
"display_label": "Input Set",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
}
,
"links": {
"process__info": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id",
"method": "GET",
"rel": "self"
}
,
"process__modify": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id",
"method": "PUT",
"rel": "process__modify"
}
,
"process_log__add": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id/log",
"method": "PUT",
"rel": "process_log__add"
}
,
"process_log__info": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id/log",
"method": "GET",
"rel": "process_log__info"
}
,
"process_member__add": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id/member/:byu_id",
"method": "PUT",
"rel": "process_member__add"
}
,
"process_member__remove": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id/member/:byu_id",
"method": "DELETE",
"rel": "process_member__remove"
}
,
"process_packet_set__add": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id/packet_set_ref",
"method": "PUT",
"rel": "process_packet_set__add"
}
,
"process_role__add": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id/role/:byu_id",
"method": "PUT",
"rel": "process_role__add"
}
,
"process_role__remove": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id/role/:byu_id",
"method": "DELETE",
"rel": "process_role__remove"
}
,
"process_subprocess__add": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id/subprocess",
"method": "PUT",
"rel": "process_subprocess__add"
}
}
,
"log": {
"links": {
"process_log__add": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id/log",
"method": "PUT",
"rel": "process_log__add"
}
,
"process_log__info": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id/log",
"method": "GET",
"rel": "self"
}
}
,
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"values": [
{
"action": {
"api_type": "modifiable",
"display_label": "Action",
"value": "Updated status"
}
,
"date_time_updated": {
"api_type": "system",
"display_label": "Updated",
"value": "2014-05-11T13:45:53.200Z"
}
,
"id_updated_by": {
"api_type": "system",
"description": "Bugs Bunny Ithaca",
"display_label": "Updated by",
"value": "764634873"
}
}
]
}
,
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"name": {
"api_type": "modifiable",
"display_label": "Name",
"value": "Transfer 1"
}
,
"output_set": {
"api_type": "modifiable",
"display_label": "Output Set",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
}
,
"packet_set_refs": {
"api_type": "modifiable",
"display_label": "Packet Set References",
"values": [
{
"key": "Score0",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
},
{
"key": "Score1",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
},
{
"key": "Score2",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
}
]
}
,
"people": {
"api_type": "modifiable",
"display_label": "People",
"members": [
"987654321",
"876543219",
"765432198"
]
,
"roles": [
{
"key": "leader",
"value": "123456789"
}
]
}
,
"processes": {
"api_type": "modifiable",
"display_label": "Processes",
"values": [
{
"key": "screen",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
},
{
"key": "score",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
},
{
"key": "model",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
}
]
}
}
400 Bad Request #/responses/400

Invalid Request - unable to interpret request

401 Unauthorized #/responses/401

Authentication required to access data

403 Forbidden #/responses/403

Access denied to protected data

404 Not Found #/responses/404

Application not found

409 Conflict #/responses/409

Query parameters conflict or are malformed

default #/responses/default

Unexpected error

Input a packet to a process

PUT /{workflow_id}/processes/{process_id}/input/{packet_id}

Tags: Processes

Add a packet to the input set of a process object.

workflow_id

Workflow UUID

path string #/parameters/workflow_id
process_id

Process UUID

path string #/parameters/process_id
packet_id

Packet UUID

path string #/parameters/packet_id

Uses default content-types: application/json

200 OK

Packet input succeeded

Example for application/json
{
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
}
}
400 Bad Request #/responses/400

Invalid Request - unable to interpret request

401 Unauthorized #/responses/401

Authentication required to access data

403 Forbidden #/responses/403

Access denied to protected data

404 Not Found #/responses/404

Application not found

409 Conflict #/responses/409

Query parameters conflict or are malformed

default #/responses/default

Unexpected error

Get the process log

GET /{workflow_id}/processes/{process_id}/log

Tags: Process Logs

Get the process log

workflow_id

Workflow UUID

path string #/parameters/workflow_id
process_id

Process UUID

path string #/parameters/process_id
page_start

Skip into a large collection to this item

query string #/parameters/page_start
page_size

Return this many items of a large collection

query string #/parameters/page_size

Uses default content-types: application/json

200 OK

Retrieve the process log

Example for application/json
{
"links": {
"process_log__add": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id/log",
"method": "PUT",
"rel": "process_log__add"
}
,
"process_log__info": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id/log",
"method": "GET",
"rel": "self"
}
}
,
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"values": [
{
"action": {
"api_type": "modifiable",
"display_label": "Action",
"value": "Updated status"
}
,
"date_time_updated": {
"api_type": "system",
"display_label": "Updated",
"value": "2014-05-11T13:45:53.200Z"
}
,
"id_updated_by": {
"api_type": "system",
"description": "Bugs Bunny Ithaca",
"display_label": "Updated by",
"value": "764634873"
}
}
]
}
400 Bad Request #/responses/400

Invalid Request - unable to interpret request

401 Unauthorized #/responses/401

Authentication required to access data

403 Forbidden #/responses/403

Access denied to protected data

404 Not Found #/responses/404

Application not found

409 Conflict #/responses/409

Query parameters conflict or are malformed

default #/responses/default

Unexpected error

Add a process log message

PUT /{workflow_id}/processes/{process_id}/log

Tags: Process Logs

Add a process log message

Process log message

workflow_id

Workflow UUID

path string #/parameters/workflow_id
process_id

Process UUID

path string #/parameters/process_id

Uses default content-types: application/json

200 OK

Process log successfully modified

Example for application/json
{
"links": {
"process_log__add": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id/log",
"method": "PUT",
"rel": "process_log__add"
}
,
"process_log__info": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id/log",
"method": "GET",
"rel": "self"
}
}
,
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"values": [
{
"action": {
"api_type": "modifiable",
"display_label": "Action",
"value": "Updated status"
}
,
"date_time_updated": {
"api_type": "system",
"display_label": "Updated",
"value": "2014-05-11T13:45:53.200Z"
}
,
"id_updated_by": {
"api_type": "system",
"description": "Bugs Bunny Ithaca",
"display_label": "Updated by",
"value": "764634873"
}
}
]
}
400 Bad Request #/responses/400

Invalid Request - unable to interpret request

401 Unauthorized #/responses/401

Authentication required to access data

403 Forbidden #/responses/403

Access denied to protected data

404 Not Found #/responses/404

Application not found

409 Conflict #/responses/409

Query parameters conflict or are malformed

default #/responses/default

Unexpected error

Remove a person from a process

DELETE /{workflow_id}/processes/{process_id}/member/{byu_id}

Tags: Process Members

Remove a person from a process member list

workflow_id

Workflow UUID

path string #/parameters/workflow_id
process_id

Process UUID

path string #/parameters/process_id
byu_id

BYU ID

path string #/parameters/byu_id

Uses default content-types: application/json

200 OK

Person successfully removed

Example for application/json
{
"attributes": {
"api_type": "modifiable",
"display_label": "Attributes",
"values": [
{
"key": "process",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
},
{
"key": "institution",
"value": "BYUP"
},
{
"key": "admit_period",
"value": "2018F"
}
]
}
,
"event_handler": {
"api_type": "modifiable",
"display_label": "Event Handler",
"value": "myLambda@aws"
}
,
"id": {
"api_type": "system",
"display_label": "ID",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
}
,
"input_set": {
"api_type": "modifiable",
"display_label": "Input Set",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
}
,
"links": {
"process__info": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id",
"method": "GET",
"rel": "self"
}
,
"process__modify": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id",
"method": "PUT",
"rel": "process__modify"
}
,
"process_log__add": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id/log",
"method": "PUT",
"rel": "process_log__add"
}
,
"process_log__info": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id/log",
"method": "GET",
"rel": "process_log__info"
}
,
"process_member__add": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id/member/:byu_id",
"method": "PUT",
"rel": "process_member__add"
}
,
"process_member__remove": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id/member/:byu_id",
"method": "DELETE",
"rel": "process_member__remove"
}
,
"process_packet_set__add": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id/packet_set_ref",
"method": "PUT",
"rel": "process_packet_set__add"
}
,
"process_role__add": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id/role/:byu_id",
"method": "PUT",
"rel": "process_role__add"
}
,
"process_role__remove": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id/role/:byu_id",
"method": "DELETE",
"rel": "process_role__remove"
}
,
"process_subprocess__add": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id/subprocess",
"method": "PUT",
"rel": "process_subprocess__add"
}
}
,
"log": {
"links": {
"process_log__add": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id/log",
"method": "PUT",
"rel": "process_log__add"
}
,
"process_log__info": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id/log",
"method": "GET",
"rel": "self"
}
}
,
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"values": [
{
"action": {
"api_type": "modifiable",
"display_label": "Action",
"value": "Updated status"
}
,
"date_time_updated": {
"api_type": "system",
"display_label": "Updated",
"value": "2014-05-11T13:45:53.200Z"
}
,
"id_updated_by": {
"api_type": "system",
"description": "Bugs Bunny Ithaca",
"display_label": "Updated by",
"value": "764634873"
}
}
]
}
,
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"name": {
"api_type": "modifiable",
"display_label": "Name",
"value": "Transfer 1"
}
,
"output_set": {
"api_type": "modifiable",
"display_label": "Output Set",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
}
,
"packet_set_refs": {
"api_type": "modifiable",
"display_label": "Packet Set References",
"values": [
{
"key": "Score0",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
},
{
"key": "Score1",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
},
{
"key": "Score2",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
}
]
}
,
"people": {
"api_type": "modifiable",
"display_label": "People",
"members": [
"987654321",
"876543219",
"765432198"
]
,
"roles": [
{
"key": "leader",
"value": "123456789"
}
]
}
,
"processes": {
"api_type": "modifiable",
"display_label": "Processes",
"values": [
{
"key": "screen",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
},
{
"key": "score",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
},
{
"key": "model",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
}
]
}
}
400 Bad Request #/responses/400

Invalid Request - unable to interpret request

401 Unauthorized #/responses/401

Authentication required to access data

403 Forbidden #/responses/403

Access denied to protected data

default #/responses/default

Unexpected error

Associate a person with a process

PUT /{workflow_id}/processes/{process_id}/member/{byu_id}

Tags: Process Members

Associate a person with a process

workflow_id

Workflow UUID

path string #/parameters/workflow_id
process_id

Process UUID

path string #/parameters/process_id
byu_id

BYU ID

path string #/parameters/byu_id

Uses default content-types: application/json

200 OK

Person successfully added

Example for application/json
{
"attributes": {
"api_type": "modifiable",
"display_label": "Attributes",
"values": [
{
"key": "process",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
},
{
"key": "institution",
"value": "BYUP"
},
{
"key": "admit_period",
"value": "2018F"
}
]
}
,
"event_handler": {
"api_type": "modifiable",
"display_label": "Event Handler",
"value": "myLambda@aws"
}
,
"id": {
"api_type": "system",
"display_label": "ID",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
}
,
"input_set": {
"api_type": "modifiable",
"display_label": "Input Set",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
}
,
"links": {
"process__info": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id",
"method": "GET",
"rel": "self"
}
,
"process__modify": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id",
"method": "PUT",
"rel": "process__modify"
}
,
"process_log__add": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id/log",
"method": "PUT",
"rel": "process_log__add"
}
,
"process_log__info": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id/log",
"method": "GET",
"rel": "process_log__info"
}
,
"process_member__add": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id/member/:byu_id",
"method": "PUT",
"rel": "process_member__add"
}
,
"process_member__remove": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id/member/:byu_id",
"method": "DELETE",
"rel": "process_member__remove"
}
,
"process_packet_set__add": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id/packet_set_ref",
"method": "PUT",
"rel": "process_packet_set__add"
}
,
"process_role__add": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id/role/:byu_id",
"method": "PUT",
"rel": "process_role__add"
}
,
"process_role__remove": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id/role/:byu_id",
"method": "DELETE",
"rel": "process_role__remove"
}
,
"process_subprocess__add": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id/subprocess",
"method": "PUT",
"rel": "process_subprocess__add"
}
}
,
"log": {
"links": {
"process_log__add": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id/log",
"method": "PUT",
"rel": "process_log__add"
}
,
"process_log__info": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id/log",
"method": "GET",
"rel": "self"
}
}
,
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"values": [
{
"action": {
"api_type": "modifiable",
"display_label": "Action",
"value": "Updated status"
}
,
"date_time_updated": {
"api_type": "system",
"display_label": "Updated",
"value": "2014-05-11T13:45:53.200Z"
}
,
"id_updated_by": {
"api_type": "system",
"description": "Bugs Bunny Ithaca",
"display_label": "Updated by",
"value": "764634873"
}
}
]
}
,
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"name": {
"api_type": "modifiable",
"display_label": "Name",
"value": "Transfer 1"
}
,
"output_set": {
"api_type": "modifiable",
"display_label": "Output Set",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
}
,
"packet_set_refs": {
"api_type": "modifiable",
"display_label": "Packet Set References",
"values": [
{
"key": "Score0",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
},
{
"key": "Score1",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
},
{
"key": "Score2",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
}
]
}
,
"people": {
"api_type": "modifiable",
"display_label": "People",
"members": [
"987654321",
"876543219",
"765432198"
]
,
"roles": [
{
"key": "leader",
"value": "123456789"
}
]
}
,
"processes": {
"api_type": "modifiable",
"display_label": "Processes",
"values": [
{
"key": "screen",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
},
{
"key": "score",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
},
{
"key": "model",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
}
]
}
}
400 Bad Request #/responses/400

Invalid Request - unable to interpret request

401 Unauthorized #/responses/401

Authentication required to access data

403 Forbidden #/responses/403

Access denied to protected data

404 Not Found #/responses/404

Application not found

409 Conflict #/responses/409

Query parameters conflict or are malformed

default #/responses/default

Unexpected error

Add a packet set reference

PUT /{workflow_id}/processes/{process_id}/packet_set_ref

Tags: Processes

Add a packet set reference to a process

Packet set information

workflow_id

Workflow UUID

path string #/parameters/workflow_id
process_id

Process UUID

path string #/parameters/process_id

Uses default content-types: application/json

200 OK

Packet set successfully added

Example for application/json
{
"attributes": {
"api_type": "modifiable",
"display_label": "Attributes",
"values": [
{
"key": "process",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
},
{
"key": "institution",
"value": "BYUP"
},
{
"key": "admit_period",
"value": "2018F"
}
]
}
,
"event_handler": {
"api_type": "modifiable",
"display_label": "Event Handler",
"value": "myLambda@aws"
}
,
"id": {
"api_type": "system",
"display_label": "ID",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
}
,
"input_set": {
"api_type": "modifiable",
"display_label": "Input Set",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
}
,
"links": {
"process__info": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id",
"method": "GET",
"rel": "self"
}
,
"process__modify": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id",
"method": "PUT",
"rel": "process__modify"
}
,
"process_log__add": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id/log",
"method": "PUT",
"rel": "process_log__add"
}
,
"process_log__info": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id/log",
"method": "GET",
"rel": "process_log__info"
}
,
"process_member__add": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id/member/:byu_id",
"method": "PUT",
"rel": "process_member__add"
}
,
"process_member__remove": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id/member/:byu_id",
"method": "DELETE",
"rel": "process_member__remove"
}
,
"process_packet_set__add": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id/packet_set_ref",
"method": "PUT",
"rel": "process_packet_set__add"
}
,
"process_role__add": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id/role/:byu_id",
"method": "PUT",
"rel": "process_role__add"
}
,
"process_role__remove": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id/role/:byu_id",
"method": "DELETE",
"rel": "process_role__remove"
}
,
"process_subprocess__add": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id/subprocess",
"method": "PUT",
"rel": "process_subprocess__add"
}
}
,
"log": {
"links": {
"process_log__add": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id/log",
"method": "PUT",
"rel": "process_log__add"
}
,
"process_log__info": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id/log",
"method": "GET",
"rel": "self"
}
}
,
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"values": [
{
"action": {
"api_type": "modifiable",
"display_label": "Action",
"value": "Updated status"
}
,
"date_time_updated": {
"api_type": "system",
"display_label": "Updated",
"value": "2014-05-11T13:45:53.200Z"
}
,
"id_updated_by": {
"api_type": "system",
"description": "Bugs Bunny Ithaca",
"display_label": "Updated by",
"value": "764634873"
}
}
]
}
,
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"name": {
"api_type": "modifiable",
"display_label": "Name",
"value": "Transfer 1"
}
,
"output_set": {
"api_type": "modifiable",
"display_label": "Output Set",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
}
,
"packet_set_refs": {
"api_type": "modifiable",
"display_label": "Packet Set References",
"values": [
{
"key": "Score0",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
},
{
"key": "Score1",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
},
{
"key": "Score2",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
}
]
}
,
"people": {
"api_type": "modifiable",
"display_label": "People",
"members": [
"987654321",
"876543219",
"765432198"
]
,
"roles": [
{
"key": "leader",
"value": "123456789"
}
]
}
,
"processes": {
"api_type": "modifiable",
"display_label": "Processes",
"values": [
{
"key": "screen",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
},
{
"key": "score",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
},
{
"key": "model",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
}
]
}
}
400 Bad Request #/responses/400

Invalid Request - unable to interpret request

401 Unauthorized #/responses/401

Authentication required to access data

403 Forbidden #/responses/403

Access denied to protected data

404 Not Found #/responses/404

Application not found

409 Conflict #/responses/409

Query parameters conflict or are malformed

default #/responses/default

Unexpected error

Remove a role from a process

DELETE /{workflow_id}/processes/{process_id}/role/{byu_id}

Tags: Process Members

Remove a person and a role from a process

workflow_id

Workflow UUID

path string #/parameters/workflow_id
process_id

Process UUID

path string #/parameters/process_id
byu_id

BYU ID

path string #/parameters/byu_id

Uses default content-types: application/json

200 OK

Person and role successfully removed

Example for application/json
{
"attributes": {
"api_type": "modifiable",
"display_label": "Attributes",
"values": [
{
"key": "process",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
},
{
"key": "institution",
"value": "BYUP"
},
{
"key": "admit_period",
"value": "2018F"
}
]
}
,
"event_handler": {
"api_type": "modifiable",
"display_label": "Event Handler",
"value": "myLambda@aws"
}
,
"id": {
"api_type": "system",
"display_label": "ID",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
}
,
"input_set": {
"api_type": "modifiable",
"display_label": "Input Set",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
}
,
"links": {
"process__info": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id",
"method": "GET",
"rel": "self"
}
,
"process__modify": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id",
"method": "PUT",
"rel": "process__modify"
}
,
"process_log__add": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id/log",
"method": "PUT",
"rel": "process_log__add"
}
,
"process_log__info": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id/log",
"method": "GET",
"rel": "process_log__info"
}
,
"process_member__add": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id/member/:byu_id",
"method": "PUT",
"rel": "process_member__add"
}
,
"process_member__remove": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id/member/:byu_id",
"method": "DELETE",
"rel": "process_member__remove"
}
,
"process_packet_set__add": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id/packet_set_ref",
"method": "PUT",
"rel": "process_packet_set__add"
}
,
"process_role__add": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id/role/:byu_id",
"method": "PUT",
"rel": "process_role__add"
}
,
"process_role__remove": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id/role/:byu_id",
"method": "DELETE",
"rel": "process_role__remove"
}
,
"process_subprocess__add": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id/subprocess",
"method": "PUT",
"rel": "process_subprocess__add"
}
}
,
"log": {
"links": {
"process_log__add": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id/log",
"method": "PUT",
"rel": "process_log__add"
}
,
"process_log__info": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id/log",
"method": "GET",
"rel": "self"
}
}
,
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"values": [
{
"action": {
"api_type": "modifiable",
"display_label": "Action",
"value": "Updated status"
}
,
"date_time_updated": {
"api_type": "system",
"display_label": "Updated",
"value": "2014-05-11T13:45:53.200Z"
}
,
"id_updated_by": {
"api_type": "system",
"description": "Bugs Bunny Ithaca",
"display_label": "Updated by",
"value": "764634873"
}
}
]
}
,
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"name": {
"api_type": "modifiable",
"display_label": "Name",
"value": "Transfer 1"
}
,
"output_set": {
"api_type": "modifiable",
"display_label": "Output Set",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
}
,
"packet_set_refs": {
"api_type": "modifiable",
"display_label": "Packet Set References",
"values": [
{
"key": "Score0",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
},
{
"key": "Score1",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
},
{
"key": "Score2",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
}
]
}
,
"people": {
"api_type": "modifiable",
"display_label": "People",
"members": [
"987654321",
"876543219",
"765432198"
]
,
"roles": [
{
"key": "leader",
"value": "123456789"
}
]
}
,
"processes": {
"api_type": "modifiable",
"display_label": "Processes",
"values": [
{
"key": "screen",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
},
{
"key": "score",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
},
{
"key": "model",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
}
]
}
}
400 Bad Request #/responses/400

Invalid Request - unable to interpret request

401 Unauthorized #/responses/401

Authentication required to access data

403 Forbidden #/responses/403

Access denied to protected data

default #/responses/default

Unexpected error

Associate a person with a process

PUT /{workflow_id}/processes/{process_id}/role/{byu_id}

Tags: Process Members

Associate a person with a process

Process role information

workflow_id

Workflow UUID

path string #/parameters/workflow_id
process_id

Process UUID

path string #/parameters/process_id
byu_id

BYU ID

path string #/parameters/byu_id

Uses default content-types: application/json

200 OK

Person and role successfully added

Example for application/json
{
"attributes": {
"api_type": "modifiable",
"display_label": "Attributes",
"values": [
{
"key": "process",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
},
{
"key": "institution",
"value": "BYUP"
},
{
"key": "admit_period",
"value": "2018F"
}
]
}
,
"event_handler": {
"api_type": "modifiable",
"display_label": "Event Handler",
"value": "myLambda@aws"
}
,
"id": {
"api_type": "system",
"display_label": "ID",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
}
,
"input_set": {
"api_type": "modifiable",
"display_label": "Input Set",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
}
,
"links": {
"process__info": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id",
"method": "GET",
"rel": "self"
}
,
"process__modify": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id",
"method": "PUT",
"rel": "process__modify"
}
,
"process_log__add": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id/log",
"method": "PUT",
"rel": "process_log__add"
}
,
"process_log__info": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id/log",
"method": "GET",
"rel": "process_log__info"
}
,
"process_member__add": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id/member/:byu_id",
"method": "PUT",
"rel": "process_member__add"
}
,
"process_member__remove": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id/member/:byu_id",
"method": "DELETE",
"rel": "process_member__remove"
}
,
"process_packet_set__add": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id/packet_set_ref",
"method": "PUT",
"rel": "process_packet_set__add"
}
,
"process_role__add": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id/role/:byu_id",
"method": "PUT",
"rel": "process_role__add"
}
,
"process_role__remove": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id/role/:byu_id",
"method": "DELETE",
"rel": "process_role__remove"
}
,
"process_subprocess__add": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id/subprocess",
"method": "PUT",
"rel": "process_subprocess__add"
}
}
,
"log": {
"links": {
"process_log__add": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id/log",
"method": "PUT",
"rel": "process_log__add"
}
,
"process_log__info": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id/log",
"method": "GET",
"rel": "self"
}
}
,
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"values": [
{
"action": {
"api_type": "modifiable",
"display_label": "Action",
"value": "Updated status"
}
,
"date_time_updated": {
"api_type": "system",
"display_label": "Updated",
"value": "2014-05-11T13:45:53.200Z"
}
,
"id_updated_by": {
"api_type": "system",
"description": "Bugs Bunny Ithaca",
"display_label": "Updated by",
"value": "764634873"
}
}
]
}
,
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"name": {
"api_type": "modifiable",
"display_label": "Name",
"value": "Transfer 1"
}
,
"output_set": {
"api_type": "modifiable",
"display_label": "Output Set",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
}
,
"packet_set_refs": {
"api_type": "modifiable",
"display_label": "Packet Set References",
"values": [
{
"key": "Score0",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
},
{
"key": "Score1",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
},
{
"key": "Score2",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
}
]
}
,
"people": {
"api_type": "modifiable",
"display_label": "People",
"members": [
"987654321",
"876543219",
"765432198"
]
,
"roles": [
{
"key": "leader",
"value": "123456789"
}
]
}
,
"processes": {
"api_type": "modifiable",
"display_label": "Processes",
"values": [
{
"key": "screen",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
},
{
"key": "score",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
},
{
"key": "model",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
}
]
}
}
400 Bad Request #/responses/400

Invalid Request - unable to interpret request

401 Unauthorized #/responses/401

Authentication required to access data

403 Forbidden #/responses/403

Access denied to protected data

404 Not Found #/responses/404

Application not found

409 Conflict #/responses/409

Query parameters conflict or are malformed

default #/responses/default

Unexpected error

Add a subprocess

PUT /{workflow_id}/processes/{process_id}/subprocess

Tags: Processes

Add a subprocess

Subprocess information

workflow_id

Workflow UUID

path string #/parameters/workflow_id
process_id

Process UUID

path string #/parameters/process_id

Uses default content-types: application/json

200 OK

Subprocess successfully added

Example for application/json
{
"attributes": {
"api_type": "modifiable",
"display_label": "Attributes",
"values": [
{
"key": "process",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
},
{
"key": "institution",
"value": "BYUP"
},
{
"key": "admit_period",
"value": "2018F"
}
]
}
,
"event_handler": {
"api_type": "modifiable",
"display_label": "Event Handler",
"value": "myLambda@aws"
}
,
"id": {
"api_type": "system",
"display_label": "ID",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
}
,
"input_set": {
"api_type": "modifiable",
"display_label": "Input Set",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
}
,
"links": {
"process__info": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id",
"method": "GET",
"rel": "self"
}
,
"process__modify": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id",
"method": "PUT",
"rel": "process__modify"
}
,
"process_log__add": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id/log",
"method": "PUT",
"rel": "process_log__add"
}
,
"process_log__info": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id/log",
"method": "GET",
"rel": "process_log__info"
}
,
"process_member__add": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id/member/:byu_id",
"method": "PUT",
"rel": "process_member__add"
}
,
"process_member__remove": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id/member/:byu_id",
"method": "DELETE",
"rel": "process_member__remove"
}
,
"process_packet_set__add": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id/packet_set_ref",
"method": "PUT",
"rel": "process_packet_set__add"
}
,
"process_role__add": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id/role/:byu_id",
"method": "PUT",
"rel": "process_role__add"
}
,
"process_role__remove": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id/role/:byu_id",
"method": "DELETE",
"rel": "process_role__remove"
}
,
"process_subprocess__add": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id/subprocess",
"method": "PUT",
"rel": "process_subprocess__add"
}
}
,
"log": {
"links": {
"process_log__add": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id/log",
"method": "PUT",
"rel": "process_log__add"
}
,
"process_log__info": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id/log",
"method": "GET",
"rel": "self"
}
}
,
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"values": [
{
"action": {
"api_type": "modifiable",
"display_label": "Action",
"value": "Updated status"
}
,
"date_time_updated": {
"api_type": "system",
"display_label": "Updated",
"value": "2014-05-11T13:45:53.200Z"
}
,
"id_updated_by": {
"api_type": "system",
"description": "Bugs Bunny Ithaca",
"display_label": "Updated by",
"value": "764634873"
}
}
]
}
,
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"name": {
"api_type": "modifiable",
"display_label": "Name",
"value": "Transfer 1"
}
,
"output_set": {
"api_type": "modifiable",
"display_label": "Output Set",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
}
,
"packet_set_refs": {
"api_type": "modifiable",
"display_label": "Packet Set References",
"values": [
{
"key": "Score0",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
},
{
"key": "Score1",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
},
{
"key": "Score2",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
}
]
}
,
"people": {
"api_type": "modifiable",
"display_label": "People",
"members": [
"987654321",
"876543219",
"765432198"
]
,
"roles": [
{
"key": "leader",
"value": "123456789"
}
]
}
,
"processes": {
"api_type": "modifiable",
"display_label": "Processes",
"values": [
{
"key": "screen",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
},
{
"key": "score",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
},
{
"key": "model",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
}
]
}
}
400 Bad Request #/responses/400

Invalid Request - unable to interpret request

401 Unauthorized #/responses/401

Authentication required to access data

403 Forbidden #/responses/403

Access denied to protected data

404 Not Found #/responses/404

Application not found

409 Conflict #/responses/409

Query parameters conflict or are malformed

default #/responses/default

Unexpected error

Get the next work packet

GET /{workflow_id}/processes/{process_id}/work/{byu_id}

Tags: Process Work

Get the next packet to work on

workflow_id

Workflow UUID

path string #/parameters/workflow_id
process_id

Process UUID

path string #/parameters/process_id
byu_id

BYU ID

path string #/parameters/byu_id

Uses default content-types: application/json

200 OK

Retrieved work packet

Example for application/json
{
"links": {
"process_log__finish": {
"href": "https://api.byu.edu/domain/common/workflow/v1/cea9a774-dfe8-4dfd-8a2a-bb2edc984407/processes/cea9a774-dfe8-4dfd-8a2a-bb2edc984407/work/123456789",
"method": "PUT",
"rel": "process_log__finish"
},
"process_log__next": {
"href": "https://api.byu.edu/domain/common/workflow/v1/cea9a774-dfe8-4dfd-8a2a-bb2edc984407/processes/cea9a774-dfe8-4dfd-8a2a-bb2edc984407/work/123456789",
"method": "GET",
"rel": "self"
}
},
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
},
"packet_id": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
}
400 Bad Request #/responses/400

Invalid Request - unable to interpret request

401 Unauthorized #/responses/401

Authentication required to access data

403 Forbidden #/responses/403

Access denied to protected data

404 Not Found #/responses/404

Application not found

409 Conflict #/responses/409

Query parameters conflict or are malformed

default #/responses/default

Unexpected error

Finish a work packet

PUT /{workflow_id}/processes/{process_id}/work/{byu_id}

Tags: Process Work

Report the work on a packet complete

Process role information

workflow_id

Workflow UUID

path string #/parameters/workflow_id
process_id

Process UUID

path string #/parameters/process_id
byu_id

BYU ID

path string #/parameters/byu_id

Uses default content-types: application/json

200 OK

Work packet report succeeded

Example for application/json
{
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
}
}
400 Bad Request #/responses/400

Invalid Request - unable to interpret request

401 Unauthorized #/responses/401

Authentication required to access data

403 Forbidden #/responses/403

Access denied to protected data

404 Not Found #/responses/404

Application not found

409 Conflict #/responses/409

Query parameters conflict or are malformed

default #/responses/default

Unexpected error

Parameter definitions

byu_id byu_id

BYU ID

path string
workflow_id workflow_id

Workflow UUID

path string
packet_id packet_id

Packet UUID

path string
packet_set_id packet_set_id

Packet Set UUID

path string
process_id process_id

Process UUID

path string
page_start page_start

Skip into a large collection to this item

query string
page_size page_size

Return this many items of a large collection

query string

Response definitions

400

Invalid Request - unable to interpret request

401

Authentication required to access data

403

Access denied to protected data

404

Application not found

409

Query parameters conflict or are malformed

default

Unexpected error

Schema definitions

attribute_modify: object

Modify an attribute

{
"key": "institution",
"value": "BYUP"
}
key: string
value: string

error_response: object

metadata: metadata_simple

member: object

{
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"values": [
{
"key": "screen",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
},
{
"key": "score",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
},
{
"key": "model",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
}
]
}
links: object

Hypermedia links that operate on member process lists

member__info: object

Hypermedia link to retrieve a member process list

rel: string , x ∈ { self (default) }
href: string (uri) https://api.byu.edu/domain/common/workflow/v1/:workflow_id/member
method: string , x ∈ { GET (default) }
metadata: metadata_simple
values: object[]

metadata_collection:

collection_size: integer , { x ∈ ℤ | x ≥ 0 }
page_start: integer , { x ∈ ℤ | x ≥ 0 }
page_end: integer , { x ∈ ℤ | x ≥ 0 }
page_size: integer , { x ∈ ℤ | x ≥ 0 }
default_page_size: integer , { x ∈ ℤ | x ≥ 1 }
max_page_size: integer

metadata_simple: object

validation_response: object
code: integer
message: string
validation_information: string[]
string
cache: object

If data is from live source, value will be null, otherwise it will be date-time of cache

date_time: string (date-time)

packet_set: object

{
"attributes": {
"api_type": "modifiable",
"display_label": "Attributes",
"values": [
{
"key": "admit_period",
"value": "2018F"
},
{
"key": "name",
"value": "IntF"
},
{
"key": "description",
"value": "International Freshmen"
},
{
"key": "type",
"value": "SCREEN"
}
]
}
,
"id": {
"api_type": "system",
"display_label": "ID",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
}
,
"links": {
"packet_set__info": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/packet_sets/:packet_set_id",
"method": "GET",
"rel": "self"
}
,
"packet_set__modify": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/packet_sets/:packet_set_id",
"method": "PUT",
"rel": "packet_set__modify"
}
}
,
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"packet_refs": {
"api_type": "modifiable",
"display_label": "Packet References",
"values": [
"cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
]
}
}
links: object

Hypermedia links that operate on Packet Set

packet_set__info: object

Hypermedia link to retrieve a specific packet_set

rel: string , x ∈ { self (default) }
href: string (uri) https://api.byu.edu/domain/common/workflow/v1/:workflow_id/packet_sets/:packet_set_id
method: string , x ∈ { GET (default) }
packet_set__modify: object

Hypermedia link to modify a specific packet_set

rel: string , x ∈ { packet_set__modify (default) }
href: string (uri) https://api.byu.edu/domain/common/workflow/v1/:workflow_id/packet_sets/:packet_set_id
method: string , x ∈ { PUT (default) }
metadata: metadata_simple
id: packet_set_id
attributes: packet_set_attributes
packet_refs: packet_set_packet_refs

packet_set_attributes: object

Packet Set: attributes

{
"api_type": "modifiable",
"display_label": "Attributes",
"values": [
{
"key": "admit_period",
"value": "2018F"
},
{
"key": "name",
"value": "IntF"
},
{
"key": "description",
"value": "International Freshmen"
},
{
"key": "type",
"value": "SCREEN"
}
]
}
values: object[]
api_type: string , x ∈ { modifiable (default) }
display_label: string Attributes

packet_set_id: object

Packet Set: id

{
"api_type": "system",
"display_label": "ID",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
}
value: string
api_type: string , x ∈ { system (default) }
display_label: string ID

packet_set_modify: object

Modifiable information.

{
"attributes": [
{
"key": "admit_period",
"value": "2018F"
},
{
"key": "name",
"value": "IntF"
},
{
"key": "description",
"value": "International Freshmen"
},
{
"key": "type",
"value": "SCREEN"
}
]
}
attributes: object[]
object
key: string
value: string

packet_set_packet_refs: object

Packet Set: packet_refs

{
"api_type": "modifiable",
"display_label": "Packet References",
"value": [
"cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
]
}
values: string[]
string
api_type: string , x ∈ { modifiable (default) }
display_label: string Packet References

packet_sets: object

A list of packet sets

{
"links": {
"packet_set__add": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/packet_sets",
"method": "POST",
"rel": "packet_set__add"
}
,
"packet_sets__info": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/packet_sets?page_start=51&page_size=50",
"method": "GET",
"rel": "self"
}
}
,
"metadata": {
"collection_size": 1,
"default_page_size": 50,
"max_page_size": 1000,
"page_end": 1,
"page_size": 1,
"page_start": 1,
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"values": [
{
"attributes": {
"api_type": "modifiable",
"display_label": "Attributes",
"values": [
{
"key": "admit_period",
"value": "2018F"
},
{
"key": "name",
"value": "IntF"
},
{
"key": "description",
"value": "International Freshmen"
},
{
"key": "type",
"value": "SCREEN"
}
]
}
,
"id": {
"api_type": "system",
"display_label": "ID",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
}
,
"links": {
"packet_set__info": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/packet_sets/:packet_set_id",
"method": "GET",
"rel": "self"
}
,
"packet_set__modify": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/packet_sets/:packet_set_id",
"method": "PUT",
"rel": "packet_set__modify"
}
}
,
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"packet_refs": {
"api_type": "modifiable",
"display_label": "Packet References",
"values": [
"cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
]
}
}
]
}
links: object

Hypermedia Links that operate on a list of packet sets

packet_sets__info: object

Hypermedia link to retrieve a list of packet sets

rel: string , x ∈ { self (default) }
href: string (uri) https://api.byu.edu/domain/common/workflow/v1/:workflow_id/packet_sets
method: string , x ∈ { GET (default) }
packet_set__add: object

Hypermedia link to add a packet set

rel: string , x ∈ { packet_set__add (default) }
href: string (uri) https://api.byu.edu/domain/admissions/packets/v1/packet_sets
method: string , x ∈ { POST (default) }
metadata: metadata_collection
values: object[]

process: object

{
"attributes": {
"api_type": "modifiable",
"display_label": "Attributes",
"values": [
{
"key": "process",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
},
{
"key": "institution",
"value": "BYUP"
},
{
"key": "admit_period",
"value": "2018F"
}
]
}
,
"event_handler": {
"api_type": "modifiable",
"display_label": "Event Handler",
"value": "myLambda@aws"
}
,
"id": {
"api_type": "system",
"display_label": "ID",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
}
,
"input_set": {
"api_type": "modifiable",
"display_label": "Input Set",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
}
,
"links": {
"process__info": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id",
"method": "GET",
"rel": "self"
}
,
"process__modify": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id",
"method": "PUT",
"rel": "process__modify"
}
,
"process_log__add": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id/log",
"method": "PUT",
"rel": "process_log__add"
}
,
"process_log__info": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id/log",
"method": "GET",
"rel": "process_log__info"
}
,
"process_member__add": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id/member/:byu_id",
"method": "PUT",
"rel": "process_member__add"
}
,
"process_member__remove": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id/member/:byu_id",
"method": "DELETE",
"rel": "process_member__remove"
}
,
"process_packet_set__add": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id/packet_set_ref",
"method": "PUT",
"rel": "process_packet_set__add"
}
,
"process_role__add": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id/role/:byu_id",
"method": "PUT",
"rel": "process_role__add"
}
,
"process_role__remove": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id/role/:byu_id",
"method": "DELETE",
"rel": "process_role__remove"
}
,
"process_subprocess__add": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id/subprocess",
"method": "PUT",
"rel": "process_subprocess__add"
}
}
,
"log": {
"links": {
"process_log__add": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id/log",
"method": "PUT",
"rel": "process_log__add"
}
,
"process_log__info": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id/log",
"method": "GET",
"rel": "self"
}
}
,
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"values": [
{
"action": {
"api_type": "modifiable",
"display_label": "Action",
"value": "Updated status"
}
,
"date_time_updated": {
"api_type": "system",
"display_label": "Updated",
"value": "2014-05-11T13:45:53.200Z"
}
,
"id_updated_by": {
"api_type": "system",
"description": "Bugs Bunny Ithaca",
"display_label": "Updated by",
"value": "764634873"
}
}
]
}
,
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"name": {
"api_type": "modifiable",
"display_label": "Name",
"value": "Transfer 1"
}
,
"output_set": {
"api_type": "modifiable",
"display_label": "Output Set",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
}
,
"packet_set_refs": {
"api_type": "modifiable",
"display_label": "Packet Set References",
"values": [
{
"key": "Score0",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
},
{
"key": "Score1",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
},
{
"key": "Score2",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
}
]
}
,
"people": {
"api_type": "modifiable",
"display_label": "People",
"members": [
"987654321",
"876543219",
"765432198"
]
,
"roles": [
{
"key": "leader",
"value": "123456789"
}
]
}
,
"processes": {
"api_type": "modifiable",
"display_label": "Processes",
"values": [
{
"key": "screen",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
},
{
"key": "score",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
},
{
"key": "model",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
}
]
}
}
links: object

Hypermedia links that operate on Process

process__info: object

Hypermedia link to retrieve a specific process

rel: string , x ∈ { self (default) }
href: string (uri) https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id
method: string , x ∈ { GET (default) }
process__modify: object

Hypermedia link to modify a specific process

rel: string , x ∈ { process__modify (default) }
href: string (uri) https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id
method: string , x ∈ { PUT (default) }
process_log__info: object

Hypermedia link to retrieve the process log

rel: string , x ∈ { process_log__info (default) }
href: string (uri) https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id/log
method: string , x ∈ { GET (default) }
process_log__add: object

Hypermedia link to add a process log message

rel: string , x ∈ { process_log__add (default) }
href: string (uri) https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id/log
method: string , x ∈ { PUT (default) }
process_member__add: object

Hypermedia link to associate a person with a process

rel: string , x ∈ { process_member__add (default) }
href: string (uri) https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id/member/:byu_id
method: string , x ∈ { PUT (default) }
process_member__remove: object

Hypermedia link to remove a person associated with a process

rel: string , x ∈ { process_member__remove (default) }
href: string (uri) https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id/member/:byu_id
method: string , x ∈ { DELETE (default) }
process_packet_set__add: object

Hypermedia link to add a packet set to a process

rel: string , x ∈ { process_packet_set__add (default) }
href: string (uri) https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id/packet_set_ref
method: string , x ∈ { PUT (default) }
process_role__add: object

Hypermedia link to add a role to a process

rel: string , x ∈ { process_role__add (default) }
href: string (uri) https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id/role/:byu_id
method: string , x ∈ { PUT (default) }
process_role__remove: object

Hypermedia link to remove a role from a process

rel: string , x ∈ { process_role__remove (default) }
href: string (uri) https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id/role/:byu_id
method: string , x ∈ { DELETE (default) }
process_subprocess__add: object

Hypermedia link to add a subprocess to a process

rel: string , x ∈ { process_subprocess__add (default) }
href: string (uri) https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id/subprocess
method: string , x ∈ { PUT (default) }
metadata: metadata_simple
id: process_id
name: process_name
attributes: process_attributes
people: process_people
log: process_log
input_set: process_input_set
output_set: process_output_set
event_handler: process_event_handler
packet_set_refs: process_packet_set_refs
processes: process_processes

process_add: object

Modifiable information.

{
"attributes": [
{
"key": "process",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
},
{
"key": "institution",
"value": "BYUP"
},
{
"key": "admit_period",
"value": "2018F"
}
]
,
"event_handler": "myLambda@aws",
"input_set": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407",
"name": "Transfer 1",
"output_set": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
}
name: string
attributes: object[]
object
key: string
value: string
input_set: string
output_set: string
event_handler: string

process_attributes: object

Process: attributes

{
"api_type": "modifiable",
"display_label": "attributes",
"values": [
{
"key": "process",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
},
{
"key": "institution",
"value": "BYUP"
},
{
"key": "admit_period",
"value": "2018F"
}
]
}
values: object[]
api_type: string , x ∈ { modifiable (default) }
display_label: string Attributes

process_event_handler: object

Process: event_handler

{
"api_type": "modifiable",
"display_label": "Event Handler",
"value": "myLambda@aws"
}
value: string
api_type: string , x ∈ { modifiable (default) }
display_label: string Event Handler

process_id: object

Process: id

{
"api_type": "system",
"display_label": "ID",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
}
value: string
api_type: string , x ∈ { system (default) }
display_label: string ID

process_input_set: object

Process: input_set

{
"api_type": "modifiable",
"display_label": "Input Set",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
}
value: string
api_type: string , x ∈ { modifiable (default) }
display_label: string Input Set

process_log: object

Process: log

{
"links": {
"process_log__add": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id/log",
"method": "PUT",
"rel": "process_log__add"
}
,
"process_log__info": {
"href": "https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id/log",
"method": "GET",
"rel": "self"
}
}
,
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"values": [
{
"action": {
"api_type": "modifiable",
"display_label": "Action",
"value": "Updated status"
}
,
"date_time_updated": {
"api_type": "system",
"display_label": "Updated",
"value": "2014-05-11T13:45:53.200Z"
}
,
"id_updated_by": {
"api_type": "system",
"description": "Bugs Bunny Ithaca",
"display_label": "Updated by",
"value": "764634873"
}
}
]
}
links: object

Hypermedia links that operate on Process Logs

process_log__info: object

Hypermedia link to retrieve the process log

rel: string , x ∈ { self (default) }
href: string (uri) https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id/log
method: string , x ∈ { GET (default) }
process_log__add: object

Hypermedia link to add a process log message

rel: string , x ∈ { process_log__add (default) }
href: string (uri) https://api.byu.edu/domain/common/workflow/v1/:workflow_id/processes/:process_id/log
method: string , x ∈ { PUT (default) }
metadata: metadata_simple
values: object[]

process_log_action: object

Process: log action

{
"api_type": "modifiable",
"display_label": "Action",
"value": "Updated status"
}
value: string
api_type: string , x ∈ { modifiable (default) }
display_label: string Action

process_log_entry: object

{
"action": {
"api_type": "modifiable",
"display_label":