Flow Reference Material Assignments

List assignments for reference material.

get

Returns all source document assignments associated with the specified flow reference material.

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

projectIdentifierstringRequired

flowObjectIdentifierstringRequired

Query parameters

flowReferenceMaterialObjectIdentifierstring · uuidOptional

Responses

200

OK

text/plainapplication/jsontext/json

objectIdentifierstring · uuidOptional

flowReferenceMaterialObjectIdentifierstring · uuidOptional

401

Unauthorized

text/plainapplication/jsontext/json

403

Forbidden

text/plainapplication/jsontext/json

get/projects/{projectIdentifier}/flows/{flowObjectIdentifier}/flow-reference-material-assignments

HTTPcURLJavaScriptPython

GET /projects/{projectIdentifier}/flows/{flowObjectIdentifier}/flow-reference-material-assignments HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "flowReferenceMaterialObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "entries": [
      {
        "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
        "documentObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000"
      }
    ]
  }
]

Assign documents to flow reference material.

post

Attaches one or more source documents to a flow's reference material so the flow can use them as reference during execution.

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

projectIdentifierstringRequired

flowObjectIdentifierstringRequired

Body

application/jsontext/jsonapplication/*+json

flowReferenceMaterialObjectIdentifierstring · uuidOptional

documentObjectIdentifiersstring · uuid[] · nullableOptional

Responses

201

Created

text/plainapplication/jsontext/json

objectIdentifierstring · uuidOptional

flowReferenceMaterialObjectIdentifierstring · uuidOptional

401

Unauthorized

text/plainapplication/jsontext/json

403

Forbidden

text/plainapplication/jsontext/json

post/projects/{projectIdentifier}/flows/{flowObjectIdentifier}/flow-reference-material-assignments

HTTPcURLJavaScriptPython

POST /projects/{projectIdentifier}/flows/{flowObjectIdentifier}/flow-reference-material-assignments HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 149

{
  "flowReferenceMaterialObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "documentObjectIdentifiers": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

application/jsontext/jsonapplication/*+json

{
  "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "flowReferenceMaterialObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "entries": [
    {
      "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
      "documentObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000"
    }
  ]
}

Count active flow document assignments.

get

Returns how many source document assignments are currently active for the specified flow.

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

flowObjectIdentifierstring · uuidRequired

projectIdentifierstringRequired

Responses

200

OK

text/plainapplication/jsontext/json

integer · int32Optional

401

Unauthorized

text/plainapplication/jsontext/json

403

Forbidden

text/plainapplication/jsontext/json

get/projects/{projectIdentifier}/flows/{flowObjectIdentifier}/flow-reference-material-assignments/active-assignments

HTTPcURLJavaScriptPython

GET /projects/{projectIdentifier}/flows/{flowObjectIdentifier}/flow-reference-material-assignments/active-assignments HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

1

Get a flow document assignment by id.

get

Retrieves a single flow source document assignment by its unique identifier.

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

objectIdentifierstring · uuidRequired

projectIdentifierstringRequired

flowObjectIdentifierstringRequired

Responses

200

OK

text/plainapplication/jsontext/json

objectIdentifierstring · uuidOptional

flowReferenceMaterialObjectIdentifierstring · uuidOptional

401

Unauthorized

text/plainapplication/jsontext/json

403

Forbidden

text/plainapplication/jsontext/json

get/projects/{projectIdentifier}/flows/{flowObjectIdentifier}/flow-reference-material-assignments/{objectIdentifier}

HTTPcURLJavaScriptPython

GET /projects/{projectIdentifier}/flows/{flowObjectIdentifier}/flow-reference-material-assignments/{objectIdentifier} HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "flowReferenceMaterialObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "entries": [
    {
      "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
      "documentObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000"
    }
  ]
}

Update a flow document assignment.

put

Replaces the documents attached to an existing flow source document assignment.

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

objectIdentifierstring · uuidRequired

projectIdentifierstringRequired

flowObjectIdentifierstringRequired

Body

application/jsontext/jsonapplication/*+json

documentObjectIdentifiersstring · uuid[] · nullableOptional

Responses

200

OK

text/plainapplication/jsontext/json

objectIdentifierstring · uuidOptional

flowReferenceMaterialObjectIdentifierstring · uuidOptional

401

Unauthorized

text/plainapplication/jsontext/json

403

Forbidden

text/plainapplication/jsontext/json

put/projects/{projectIdentifier}/flows/{flowObjectIdentifier}/flow-reference-material-assignments/{objectIdentifier}

HTTPcURLJavaScriptPython

PUT /projects/{projectIdentifier}/flows/{flowObjectIdentifier}/flow-reference-material-assignments/{objectIdentifier} HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 70

{
  "documentObjectIdentifiers": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

application/jsontext/jsonapplication/*+json

{
  "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "flowReferenceMaterialObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "entries": [
    {
      "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
      "documentObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000"
    }
  ]
}

Delete a flow document assignment.

delete

Removes a flow source document assignment, detaching its documents from the flow's reference material.

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

objectIdentifierstring · uuidRequired

projectIdentifierstringRequired

flowObjectIdentifierstringRequired

Responses

204

No Content

No content

401

Unauthorized

text/plainapplication/jsontext/json

403

Forbidden

text/plainapplication/jsontext/json

delete/projects/{projectIdentifier}/flows/{flowObjectIdentifier}/flow-reference-material-assignments/{objectIdentifier}

HTTPcURLJavaScriptPython

DELETE /projects/{projectIdentifier}/flows/{flowObjectIdentifier}/flow-reference-material-assignments/{objectIdentifier} HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content