Return the authorized readiness of unpublished Entity collaboration files.

POST

/api/workspace/collaboration/files/preparations/status

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Post,
    RequestUri = new Uri("https://example.com/api/workspace/collaboration/files/preparations/status"),
    Headers =
    {
        { "Authorization", "Bearer <token>" },
    },
    Content = new StringContent("{ \"Owner\": { \"ModuleKey\": \"example\", \"ResourceKind\": \"example\", \"ContextResourceId\": \"example\", \"ResourceObjectId\": \"example\" }, \"FileReferenceIds\": [ \"example\" ] }")
    {
        Headers =
        {
            ContentType = new MediaTypeHeaderValue("application/json")
        }
    }
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

const url = 'https://example.com/api/workspace/collaboration/files/preparations/status';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"Owner":{"ModuleKey":"example","ResourceKind":"example","ContextResourceId":"example","ResourceObjectId":"example"},"FileReferenceIds":["example"]}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://example.com/api/workspace/collaboration/files/preparations/status \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "Owner": { "ModuleKey": "example", "ResourceKind": "example", "ContextResourceId": "example", "ResourceObjectId": "example" }, "FileReferenceIds": [ "example" ] }'

Authorizations

WorkspaceBearer

Parameters

Query Parameters

access_token

string

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

Request Body

Identifies unpublished Entity collaboration files whose readiness should be returned.

object

Owner

Stable identity of one Moltaro resource instance.

object

ModuleKey

string

nullable

ResourceKind

string

nullable

ContextResourceId

string

nullable

ResourceObjectId

string

nullable

FileReferenceIds

Array<string>

nullable

Example^generated

{
  "Owner": {
    "ModuleKey": "example",
    "ResourceKind": "example",
    "ContextResourceId": "example",
    "ResourceObjectId": "example"
  },
  "FileReferenceIds": [
    "example"
  ]
}

Identifies unpublished Entity collaboration files whose readiness should be returned.

object

Owner

Stable identity of one Moltaro resource instance.

object

ModuleKey

string

nullable

ResourceKind

string

nullable

ContextResourceId

string

nullable

ResourceObjectId

string

nullable

FileReferenceIds

Array<string>

nullable

Example^generated

{
  "Owner": {
    "ModuleKey": "example",
    "ResourceKind": "example",
    "ContextResourceId": "example",
    "ResourceObjectId": "example"
  },
  "FileReferenceIds": [
    "example"
  ]
}

Identifies unpublished Entity collaboration files whose readiness should be returned.

object

Owner

Stable identity of one Moltaro resource instance.

object

ModuleKey

string

nullable

ResourceKind

string

nullable

ContextResourceId

string

nullable

ResourceObjectId

string

nullable

FileReferenceIds

Array<string>

nullable

Example^generated

{
  "Owner": {
    "ModuleKey": "example",
    "ResourceKind": "example",
    "ContextResourceId": "example",
    "ResourceObjectId": "example"
  },
  "FileReferenceIds": [
    "example"
  ]
}

Responses

200

application/json

object

Data

required

Any of:

Array<object>
object

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

Invalid request. Service validation returns this error envelope; a missing request/file can return no body.

application/json

object

Data

required

Any of:

Array<object>
object

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

Forbidden. An authenticated policy refusal can contain this error envelope; Forbid() returns no body.

application/json

object

Data

required

Any of:

Array<object>
object

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
    }
  ]
}

404

Not Found

application/json

object

Data

required

Any of:

Array<object>
object

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

The operation was refused; inspect Errors. Data may be null.

application/json

object

Data

required

Any of:

Array<object>
object

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
    }
  ]
}

Return the authorized readiness of unpublished Entity collaboration files.

Authorizations

Parameters

Query Parameters

Request Body

Examplegenerated

Examplegenerated

Examplegenerated

Responses

200

Example

400

Example

403

Example

404

Example

409

Example

Example^generated

Example^generated

Example^generated