Powered by Redocly

Projects

Endpoints for project management

Create a project

Creates a project based on the request

SecurityOAuth2
Request
Request Body schema: application/json
required

Project data

name
required
string (ProjectName) [ 1 .. 60 ] characters

Project name

note
string (ProjectNote) [ 1 .. 1000 ] characters

Project note

required
any
extractionModelId
required
string (ProjectExtractionModelId)

Extraction Model id

completion
string (ProjectCompletion)
Default: "manual"

ProjectCompletion type

  • automatic - Mark documents as completed after succesfull validation
  • manual - Mark documents to review after succesfull validation
Enum: "automatic" "manual"
duplicates
string (ProjectDuplicates)
Default: "fail"

How duplicates documents show be handle

  • allow - Allow documents duplicates to be processed
  • fail - Mark documents duplicates as failed
Enum: "allow" "fail"
required
any
object (Schema)
retentionDays
integer [ 1 .. 3650 ]
Default: 180

Project document retention in days

isLive
boolean (ProjectIsLive)
Default: false

Indicates if a project is live or not

Responses
201

Project created

400

Response when client request is wrong

401

Unauthorized

403

Forbidden

404

Response when resource was not found

422

Validation error

post/projects
Request samples
application/json
{
  • "name": "My Project",
  • "note": "My project description note",
  • "ocr": {
    },
  • "extractionModelId": "63e6663823b4c1f5287398bb",
  • "completion": "manual",
  • "duplicates": "allow",
  • "members": {
    },
  • "schema": {
    },
  • "retentionDays": 180,
  • "isLive": false
}
Response samples
application/json
{
  • "id": "63e6663823b4c1f5287398bb",
  • "createdAt": "1990-12-31T15:46:19.384990Z",
  • "createdBy": "63e6663823b4c1f5287398bb",
  • "updatedAt": "1990-12-31T15:46:19.384990Z",
  • "updatedBy": "63e6663823b4c1f5287398bb",
  • "name": "My Project",
  • "note": "My project description note",
  • "extractionModelId": "63e6663823b4c1f5287398bb",
  • "ocr": {
    },
  • "completion": "manual",
  • "duplicates": "allow",
  • "members": {
    },
  • "retentionDays": 180,
  • "isLive": false
}

Retrieve a projects list for given search criteria

SecurityOAuth2
Request
query Parameters
offset
integer >= 0

A zero-based offset of the first item in the data collection to return.

limit
integer [ 0 .. 50 ]
Default: 20

Limit the amount of items returned in the response. If the value exceeds the maximum, then the maximum value will be used.

sort
string
Default: "-createdAt"

The field to sort reponse items by.

Enum: "-createdAt" "+createdAt"
isLive
boolean
search
string (Search text used to find projects.)

Search text is used against projects name and id

Responses
200

Projects list retrieved

401

Unauthorized

403

Forbidden

422

Validation error

500

Internal Server Error

get/projects
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "limit": 20,
  • "offset": 0,
  • "totalCount": 1
}
Retrieve a project by id
Retrieve a project by id


SecurityOAuth2 
Request 
path Parameters
id
required
string (ProjectId) 
Project id


 
 Example:  63e6663823b4c1f5287398bb
Responses 
200
Project by id


401
Unauthorized


403
Forbidden


404
Response when resource was not found


get/projects/{id}
Request samples 
Response samples 
application/json
{
  • "id": "63e6663823b4c1f5287398bb",
  • "createdAt": "1990-12-31T15:46:19.384990Z",
  • "createdBy": "63e6663823b4c1f5287398bb",
  • "updatedAt": "1990-12-31T15:46:19.384990Z",
  • "updatedBy": "63e6663823b4c1f5287398bb",
  • "name": "My Project",
  • "note": "My project description note",
  • "extractionModelId": "63e6663823b4c1f5287398bb",
  • "ocr": {
    },
  • "completion": "manual",
  • "duplicates": "allow",
  • "members": {
    },
  • "retentionDays": 180,
  • "isLive": false
}
Retrieve a schema by project id
Retrieve a schema by project id


SecurityOAuth2 
Request 
path Parameters
id
required
string (ProjectId) 
Project id


 
 Example:  63e6663823b4c1f5287398bb
Responses 
200
Schema retrieved


400
Response when client request is wrong


401
Unauthorized


403
Forbidden


404
Response when resource was not found


get/projects/{id}/schema
Request samples 
Response samples 
application/json
{
  • "version": 1,
  • "dataPoints": [
    ],
  • "features": {
    },
  • "enrichment": { },
  • "normalization": { },
  • "validation": { }
}
➔ Next to E-Invoices