Flow Reference Material Assignment Entries

Get a flow's reference material assignment.

get

Returns a flow's source-document assignment and the reference material documents currently linked to it.

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

projectIdentifierstringRequired

flowObjectIdentifierstringRequired

Query parameters

flowSourceDocumentAssignmentObjectIdentifierstring · 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-assignment-entries

HTTPcURLJavaScriptPython

GET /projects/{projectIdentifier}/flows/{flowObjectIdentifier}/flow-reference-material-assignment-entries 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"
    }
  ]
}

Sync flow reference material documents.

put

Adds and removes reference material documents on a flow's source-document assignment in a single call, returning the updated assignment.

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

projectIdentifierstringRequired

flowObjectIdentifierstringRequired

Body

application/jsontext/jsonapplication/*+json

flowSourceDocumentAssignmentObjectIdentifierstring · uuidOptional

documentObjectIdentifiersToAddstring · uuid[] · nullableOptional

documentObjectIdentifiersToRemovestring · 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-assignment-entries

HTTPcURLJavaScriptPython

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

{
  "flowSourceDocumentAssignmentObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "documentObjectIdentifiersToAdd": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "documentObjectIdentifiersToRemove": [
    "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"
    }
  ]
}