Document Uploads

Retrieves a paginated list of document upload records for the specified project.

get

Retrieves a paginated list of document upload records for the specified project, optionally filtered and sorted.

Authorizations
AuthorizationstringRequired

Bearer authentication with JWT

Path parameters
projectIdentifierstringRequired
Query parameters
pageNumberinteger · int32Optional

The page number to retrieve.

pageSizeinteger · int32Optional

The number of items per page.

searchTextstringOptional

Optional search text to filter document uploads.

sortinginteger · enumOptional

The sorting option for the results.

Possible values:
descbooleanOptional

Whether to sort in descending order.

Default: true
Responses
200

OK

get
/projects/{projectIdentifier}/document-uploads
GET /projects/{projectIdentifier}/document-uploads HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
[
  {
    "name": "text",
    "isCompleted": true,
    "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000"
  }
]

Creates a new document upload record for the specified project.

post

Creates a new document upload record for the specified project.

Authorizations
AuthorizationstringRequired

Bearer authentication with JWT

Path parameters
projectIdentifierstringRequired
Body
namestring | nullableRequired
isCompletedbooleanRequired
Responses
200

OK

post
/projects/{projectIdentifier}/document-uploads
POST /projects/{projectIdentifier}/document-uploads HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 34

{
  "name": "text",
  "isCompleted": true
}
{
  "name": "text",
  "isCompleted": true,
  "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000"
}

Retrieves a document upload record by its object identifier.

get

Retrieves a document upload record by its object identifier.

Authorizations
AuthorizationstringRequired

Bearer authentication with JWT

Path parameters
objectIdentifierstring · uuidRequired

The unique identifier of the document upload record.

projectIdentifierstringRequired
Responses
200

OK

get
/projects/{projectIdentifier}/document-uploads/{objectIdentifier}
GET /projects/{projectIdentifier}/document-uploads/{objectIdentifier} HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "name": "text",
  "isCompleted": true,
  "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000"
}

Updates a document upload record by its object identifier.

patch

Updates a document upload record by its object identifier.

Authorizations
AuthorizationstringRequired

Bearer authentication with JWT

Path parameters
objectIdentifierstring · uuidRequired

The unique identifier of the document upload record to update.

projectIdentifierstringRequired
Body
namestring | nullableRequired
isCompletedbooleanRequired
Responses
200

OK

patch
/projects/{projectIdentifier}/document-uploads/{objectIdentifier}
PATCH /projects/{projectIdentifier}/document-uploads/{objectIdentifier} HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 34

{
  "name": "text",
  "isCompleted": true
}
{
  "name": "text",
  "isCompleted": true,
  "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000"
}

Last updated