Flow Reference Material Assignments
Returns all source document assignments associated with the specified flow reference material.
Bearer authentication with JWT
OK
Unauthorized
Forbidden
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"
}
]
}
]Attaches one or more source documents to a flow's reference material so the flow can use them as reference during execution.
Bearer authentication with JWT
Created
Unauthorized
Forbidden
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"
]
}{
"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"
}
]
}Returns how many source document assignments are currently active for the specified flow.
Bearer authentication with JWT
OK
Unauthorized
Forbidden
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: */*
1Retrieves a single flow source document assignment by its unique identifier.
Bearer authentication with JWT
OK
Unauthorized
Forbidden
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"
}
]
}Replaces the documents attached to an existing flow source document assignment.
Bearer authentication with JWT
OK
Unauthorized
Forbidden
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"
]
}{
"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"
}
]
}Removes a flow source document assignment, detaching its documents from the flow's reference material.
Bearer authentication with JWT
No Content
No content
Unauthorized
Forbidden
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
Last updated
