Process Definitions

A process template defines the steps in a process including who is authorized to sign off each step

Create a Process Definition

POST https://api.borlaug.network/provenance/registries/:registryid/definitions

Path Parameters

Name	Type	Description
registryid	number	The registry to create the process definition in.

Headers

Name	Type	Description
Authentication	string

Request Body

Name	Type	Description
name	string	The name of the process template

200 Cake successfully retrieved.

{
    "result": "success",
    "id": 835300330,
    "timestamp": "2020-09-03T22:15:01.470373"
}

Example JSON body

{
    "name": "Test"
}

Update the name of a Process Template

PATCH https://api.borlaug.network/provenance/registries/:registryid/definitions/:definitionid

Path Parameters

Name	Type	Description
definitionid	number
registryid	number

Headers

Name	Type	Description
Authentication	string

Request Body

Name	Type	Description
name	string

200

{
    "result": "success",
    "id": 835300330,
    "timestamp": "2020-09-03T22:15:21.034412100"
}

Example JSON body

{
    "name": "Test"
}

Get Process Templates

GET https://api.borlaug.network/provenance/registries/:registryid/definitions

Get the Process Templates in given Registry in a paged, searchable manner

Path Parameters

Name	Type	Description
registryid	number

Query Parameters

Name	Type	Description
per_page	number
page	number
search	string
sort_by	string
order	string

Headers

Name	Type	Description
Authentication	string

200

{
    "templates": [
        {
            "template": 835300330,
            "created_by": "5EZ7gNcZidoanKK45JK4YVQNDpEScbcCNbV4BU7fJWJdAFsu",
            "name": "Test 2",
            "created": "2020-09-03T22:15:01.470373"
        }
    ],
    "total": 1
}

Get a single Process Template

GET https://api.borlaug.network/provenance/registries/:registryid/definitions/:definitionid

Path Parameters

Name	Type	Description
definitionid	number
registryid	number

200

{
    "template": 835300330,
    "created_by": "5EZ7gNcZidoanKK45JK4YVQNDpEScbcCNbV4BU7fJWJdAFsu",
    "name": "Test 2",
    "created": "2020-09-03T22:15:01.470373"
}

Delete a Process Template

DELETE https://api.borlaug.network/provenance/registries/:registryid/definitions/:definitionid

Path Parameters

Name	Type	Description
definitionid	number
registryid	number

200

{
    "result": "success",
    "message": "Template Deleted",
    "id": 171523477,
    "timestamp": "2020-09-04T15:11:31.333815332"
}