Skip to content
MoltaroMoltaroMoltaro Docs

Return readiness for unpublished process files prepared by the current actor.

POST
/api/workspace/boards/{boardIdOrKey}/items/{boardItemId}/collaboration/files/preparations/status
curl --request POST \
  --url https://example.com/api/workspace/boards/example/items/example/collaboration/files/preparations/status \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "FileReferenceIds": [ "example" ] }'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
boardIdOrKey
required
string
boardItemId
required
string

Query Parameters

Section titled “Query Parameters”
access_token
string

Optional access token for clients that cannot set Authorization headers. Prefer Authorization: Bearer <token> when possible.

Request Body

Section titled “Request Body”

Request readiness for unpublished Board process files prepared by the current actor.

object
FileReferenceIds
Array<string>
nullable
Examplegenerated
{
  "FileReferenceIds": [
    "example"
  ]
}

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
object
Data
required
Any of:
Array<object>
nullable
object
FileReferenceId
required
string
State
required
integer format: int32
Allowed values: 1 2 3 4
ExpiresAtUtc
required
string format: date-time
RetryAfterMilliseconds
required
integer format: int32
FailureCode
string
nullable
FailureMessage
string
nullable
Errors
required
Array<object>
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Warnings
required
Array<object>
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Success
required
boolean
Example
{
  "Data": null,
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

400

Section titled “400”

Bad Request

Media typeapplication/json
object
Data
required
Any of:
Array<object>
nullable
object
FileReferenceId
required
string
State
required
integer format: int32
Allowed values: 1 2 3 4
ExpiresAtUtc
required
string format: date-time
RetryAfterMilliseconds
required
integer format: int32
FailureCode
string
nullable
FailureMessage
string
nullable
Errors
required
Array<object>
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Warnings
required
Array<object>
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Success
required
boolean
Example
{
  "Data": null,
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

403

Section titled “403”

Forbidden

Media typeapplication/json
object
type
string
nullable
title
string
nullable
status
integer format: int32
nullable
detail
string
nullable
instance
string
nullable
key
additional properties
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

404

Section titled “404”

Not Found

Media typeapplication/json
object
Data
required
Any of:
Array<object>
nullable
object
FileReferenceId
required
string
State
required
integer format: int32
Allowed values: 1 2 3 4
ExpiresAtUtc
required
string format: date-time
RetryAfterMilliseconds
required
integer format: int32
FailureCode
string
nullable
FailureMessage
string
nullable
Errors
required
Array<object>
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Warnings
required
Array<object>
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Success
required
boolean
Example
{
  "Data": null,
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

409

Section titled “409”

Conflict

Media typeapplication/json
object
Data
required
Any of:
Array<object>
nullable
object
FileReferenceId
required
string
State
required
integer format: int32
Allowed values: 1 2 3 4
ExpiresAtUtc
required
string format: date-time
RetryAfterMilliseconds
required
integer format: int32
FailureCode
string
nullable
FailureMessage
string
nullable
Errors
required
Array<object>
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Warnings
required
Array<object>
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Success
required
boolean
Example
{
  "Data": null,
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}