Create a document

post

https://api.operations1.app/tenants/{tenantId}/documents

Path Params

tenantId

string

required

length between 1 and 100

Consists of the subdomain. The tenantId for https://company.operations1.app/ is company.

Body Params

name

string

required

length between 1 and 255

lang

string

enum

required

visible

boolean

hasVariables

boolean

changeNotes

length between 1 and 1000

notes

length between 1 and 1000

validityDate

date-time

confidentiality

string

enum

Allowed:

reportHidden

boolean

reportCompletionPreventionMode

string

enum

Allowed:

locales

array of objects

Additional document locales

locales

steps

array of objects

length ≥ 1

steps

name

string

required

length between 1 and 2000

locales

array of objects

Additional locales

locales

type

string

enum

required

Allowed:

processSteps

array of objects

required

length ≥ 1

processSteps*

name

string

required

length between 1 and 2000

locales

array of objects

Additional locales

locales

individualReport

boolean

interactions

array

required

interactions*

qualificationsRequiredIds

array of integers

qualificationsRequiredIds

qualificationsGrantedIds

array of integers

qualificationsGrantedIds

Headers

accept-version

required

Defines the API version. Using a date is recommended for stability. Avoid using latest in production, as it refers to the most up-to-date functionality, which may include breaking changes. For more details, see our article on versioning.

Responses

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Default Response

401This error ist returned if authentication of the request was not successful. For more information read our article about authentication.

403This error is returned if you do not have the necessary permissions for the endpoint.

429This error is returned if your request was not executed due to rate limit. For more information read our article about rate limiting.

defaultGeneral errors