Get process by ID - JobAffinity API

GET

process

{processid}

Get process by ID

curl --request GET \
  --url https://jobaffinity.fr/restapi/v1/process/{processid} \
  --header 'Authorization: Basic <encoded-value>'

{
  "_self": "<string>",
  "_schema": "<string>",
  "id": 123,
  "name": "<string>",
  "organisations": {
    "items": [
      {
        "id": 123,
        "name": "<string>"
      }
    ]
  },
  "steps": {
    "items": [
      {
        "id": 123,
        "name": "<string>"
      }
    ]
  }
}

Authorizations

Authorization

string

header

required

HTTP Basic Authentication with API credentials

Path Parameters

processid

integer

required

Process ID

Response

Process details

_self

string<uri>

URL of the resource

_schema

string<uri>

URL to the schema

_status

enum<string>

Available options:

OK,

INVALID

integer

Process identifier

name

string

Process name

organisations

object

Show child attributes

steps

object

Show child attributes

List all process step changesReturns a paginated list of all process step changes (most recently added first)

Get process by ID

curl --request GET \
  --url https://jobaffinity.fr/restapi/v1/process/{processid} \
  --header 'Authorization: Basic <encoded-value>'

{
  "_self": "<string>",
  "_schema": "<string>",
  "id": 123,
  "name": "<string>",
  "organisations": {
    "items": [
      {
        "id": 123,
        "name": "<string>"
      }
    ]
  },
  "steps": {
    "items": [
      {
        "id": 123,
        "name": "<string>"
      }
    ]
  }
}