Process Registries

Processes are organized into registries

Create a new Registry

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

Headers

Name
Type
Description

Authentication

string

Request Body

Name
Type
Description

name

string

The registry name

{
    "result": "success",
    "id": 766833938,
    "timestamp": "2020-09-03T21:58:04.933673600"
}
{   
    "name": "Test"
}

Update Registry

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

Path Parameters

Name
Type
Description

registryid

number

Headers

Name
Type
Description

Authentication

string

Request Body

Name
Type
Description

name

string

The new registry name

{
    "result": "success",
    "id": 766833938,
    "timestamp": "2020-09-03T22:00:57.818512800"
}
{  
    "name": "Test"
}

Get Registries

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

Gets Registries belonging to the caller in a paged manner

Query Parameters

Name
Type
Description

search

string

Optionally filter list by name

sort_by

string

column to sort by (created or name)

order

string

order to sort by ASC or DESC

per_page

number

page

number

{
    "registries": [
        {
            "registry": 766833938,
            "created_by": "5EZ7gNcZidoanKK45JK4YVQNDpEScbcCNbV4BU7fJWJdAFsu",
            "name": "Test",
            "created": "2020-09-03T21:58:04.933673"
        }
    ],
    "total": 1
}

Get a single Registry

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

Gets a single Registry by id

Path Parameters

Name
Type
Description

registryid

number

{
    "registry": 766833938,
    "created_by": "5EZ7gNcZidoanKK45JK4YVQNDpEScbcCNbV4BU7fJWJdAFsu",
    "name": "Test",
    "created": "2020-09-03T21:58:04.933673"
}

Delete a Registry

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

Delete a Registry by id

Path Parameters

Name
Type
Description

registryid

number

{
    "result": "success",
    "message": "Registry Deleted",
    "id": 1587147195,
    "timestamp": "2020-09-03T22:06:43.908498400"
}

Last updated

Was this helpful?