Store and inspect a small file while keeping it hidden until explicit Send.

POST

/api/workspace/collaboration/files/prepare

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/prepare"),
    Headers =
    {
        { "Authorization", "Bearer <token>" },
    },
    Content = new MultipartFormDataContent
    {
        new StringContent("")
        {
            Headers =
            {
                ContentType = new MediaTypeHeaderValue("application/octet-stream"),
                ContentDisposition = new ContentDispositionHeaderValue("form-data")
                {
                    Name = "File",
                    FileName = "file",
                }
            }
        },
        new StringContent("example")
        {
            Headers =
            {
                ContentType = new MediaTypeHeaderValue("text/plain"),
                ContentDisposition = new ContentDispositionHeaderValue("form-data")
                {
                    Name = "OwnerModuleKey",
                }
            }
        },
        new StringContent("example")
        {
            Headers =
            {
                ContentType = new MediaTypeHeaderValue("text/plain"),
                ContentDisposition = new ContentDispositionHeaderValue("form-data")
                {
                    Name = "OwnerResourceKind",
                }
            }
        },
        new StringContent("example")
        {
            Headers =
            {
                ContentType = new MediaTypeHeaderValue("text/plain"),
                ContentDisposition = new ContentDispositionHeaderValue("form-data")
                {
                    Name = "OwnerContextResourceId",
                }
            }
        },
        new StringContent("example")
        {
            Headers =
            {
                ContentType = new MediaTypeHeaderValue("text/plain"),
                ContentDisposition = new ContentDispositionHeaderValue("form-data")
                {
                    Name = "OwnerResourceObjectId",
                }
            }
        },
        new StringContent("2489E9AD-2EE2-8E00-8EC9-32D5F69181C0")
        {
            Headers =
            {
                ContentType = new MediaTypeHeaderValue("text/plain"),
                ContentDisposition = new ContentDispositionHeaderValue("form-data")
                {
                    Name = "OperationKey",
                }
            }
        },
        new StringContent("example")
        {
            Headers =
            {
                ContentType = new MediaTypeHeaderValue("text/plain"),
                ContentDisposition = new ContentDispositionHeaderValue("form-data")
                {
                    Name = "Description",
                }
            }
        },
    },
};
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/prepare';
const form = new FormData();
form.append('File', 'file');
form.append('OwnerModuleKey', 'example');
form.append('OwnerResourceKind', 'example');
form.append('OwnerContextResourceId', 'example');
form.append('OwnerResourceObjectId', 'example');
form.append('OperationKey', '2489E9AD-2EE2-8E00-8EC9-32D5F69181C0');
form.append('Description', 'example');

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

options.body = form;

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/prepare \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form File=@file \
  --form OwnerModuleKey=example \
  --form OwnerResourceKind=example \
  --form OwnerContextResourceId=example \
  --form OwnerResourceObjectId=example \
  --form OperationKey=2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --form Description=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

multipart/form-data

object

File

string format: binary

OwnerModuleKey

string

OwnerResourceKind

string

OwnerContextResourceId

string

OwnerResourceObjectId

string

OperationKey

string format: uuid

Description

string

Responses

200

application/json

object

Data

required

Any of:

object
object

One of: discriminator: Kind

object
object

object

Data

required

object

FileReferenceId

required

string

FileName

required

string

ContentType

required

string

Size

required

integer format: int64

RowVersion

required

string format: uuid

CanViewResult

required

boolean

Kind

required

string

Allowed values: AuthorizedAttachment

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:

object
object

One of: discriminator: Kind

object
object

object

Data

required

object

FileReferenceId

required

string

FileName

required

string

ContentType

required

string

Size

required

integer format: int64

RowVersion

required

string format: uuid

CanViewResult

required

boolean

Kind

required

string

Allowed values: AuthorizedAttachment

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:

object
object

One of: discriminator: Kind

object
object

object

Data

required

object

FileReferenceId

required

string

FileName

required

string

ContentType

required

string

Size

required

integer format: int64

RowVersion

required

string format: uuid

CanViewResult

required

boolean

Kind

required

string

Allowed values: AuthorizedAttachment

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:

object
object

One of: discriminator: Kind

object
object

object

Data

required

object

FileReferenceId

required

string

FileName

required

string

ContentType

required

string

Size

required

integer format: int64

RowVersion

required

string format: uuid

CanViewResult

required

boolean

Kind

required

string

Allowed values: AuthorizedAttachment

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:

object
object

One of: discriminator: Kind

object
object

object

Data

required

object

FileReferenceId

required

string

FileName

required

string

ContentType

required

string

Size

required

integer format: int64

RowVersion

required

string format: uuid

CanViewResult

required

boolean

Kind

required

string

Allowed values: AuthorizedAttachment

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