Return a compact owned and related attachment summary for a Resource Catalog identity.

POST

/api/workspace/attachments/resource-summary

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Post,
    RequestUri = new Uri("https://example.com/api/workspace/attachments/resource-summary"),
    Content = new StringContent("{ \"Resource\": { \"ModuleKey\": \"example\", \"ResourceKind\": \"example\", \"ContextResourceId\": \"example\", \"ResourceObjectId\": \"example\" }, \"Scope\": 0, \"Limit\": 1 }")
    {
        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/attachments/resource-summary';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: '{"Resource":{"ModuleKey":"example","ResourceKind":"example","ContextResourceId":"example","ResourceObjectId":"example"},"Scope":0,"Limit":1}'
};

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/attachments/resource-summary \
  --header 'Content-Type: application/json' \
  --data '{ "Resource": { "ModuleKey": "example", "ResourceKind": "example", "ContextResourceId": "example", "ResourceObjectId": "example" }, "Scope": 0, "Limit": 1 }'

Authorizations

None

Parameters

Query Parameters

access_token

string

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

Request Body

object

Resource

object

ModuleKey

string

nullable

ResourceKind

string

nullable

ContextResourceId

string

nullable

ResourceObjectId

string

nullable

Scope

integer format: int32

Allowed values: 0 1 2

Limit

integer format: int32

Responses

200

application/json

object

Data

object

Count

integer format: int32

Items

Array<object>

nullable

object

Placement

integer format: int32

Allowed values: 0 1

File

object

string

nullable

FolderId

string

nullable

Owner

object

ModuleKey

string

nullable

ResourceKind

string

nullable

ContextResourceId

string

nullable

ResourceObjectId

string

nullable

Relations

Array<object>

nullable

object

string

nullable

Target

object

ModuleKey

string

nullable

ResourceKind

string

nullable

ContextResourceId

string

nullable

ResourceObjectId

string

nullable

RelationKind

integer format: int32

Allowed values: 0

Source

object

ModuleKey

string

nullable

ResourceKind

string

nullable

ContextResourceId

string

nullable

ResourceObjectId

string

nullable

PolicyCode

string

nullable

CorrelationId

string

nullable

CreatedByUserId

string

nullable

CreatedAt

string format: date-time

DeletedAt

string format: date-time

nullable

Origin

object

Source

object

ModuleKey

string

nullable

ResourceKind

string

nullable

ContextResourceId

string

nullable

ResourceObjectId

string

nullable

PolicyCode

string

nullable

CorrelationId

string

nullable

IsDeleted

boolean

EditDeadline

string format: date-time

Descriptor

object

string

nullable

FileName

string

nullable

Description

string

nullable

MimeType

string

nullable

SizeBytes

integer format: int64

ChecksumSha256

string

nullable

CreatedAt

string format: date-time

ModifiedAt

string format: date-time

nullable

CreatedByUserId

string

nullable

CreatedByUserName

string

nullable

ModifiedByUserId

string

nullable

ModifiedByUserName

string

nullable

Owner

object

Identity

object

ModuleKey

string

nullable

ResourceKind

string

nullable

ContextResourceId

string

nullable

ResourceObjectId

string

nullable

DisplayName

string

nullable

SafeLabel

string

nullable

OpenTarget

object

TargetCode

string

nullable

Parameters

object

key

additional properties

string

CanOpen

boolean

RelatedTarget

object

Identity

object

ModuleKey

string

nullable

ResourceKind

string

nullable

ContextResourceId

string

nullable

ResourceObjectId

string

nullable

DisplayName

string

nullable

SafeLabel

string

nullable

OpenTarget

object

TargetCode

string

nullable

Parameters

object

key

additional properties

string

CanOpen

boolean

Source

object

Identity

object

ModuleKey

string

nullable

ResourceKind

string

nullable

ContextResourceId

string

nullable

ResourceObjectId

string

nullable

DisplayName

string

nullable

SafeLabel

string

nullable

OpenTarget

object

TargetCode

string

nullable

Parameters

object

key

additional properties

string

CanOpen

boolean

RelationId

string

nullable

RelationKind

integer format: int32

Allowed values: 0

PolicyCode

string

nullable

CorrelationId

string

nullable

CreatedAt

string format: date-time

Permissions

object

CanView

boolean

CanRename

boolean

CanDelete

boolean

CanDownload

boolean

Errors

Array<object>

nullable

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

Array<object>

nullable

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

boolean

Example

{
  "Data": {
    "Items": [
      {
        "Placement": 0,
        "File": {
          "Relations": [
            {
              "RelationKind": 0
            }
          ]
        },
        "RelationKind": 0
      }
    ]
  },
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

400

Bad Request

application/json

object

Data

object

Count

integer format: int32

Items

Array<object>

nullable

object

Placement

integer format: int32

Allowed values: 0 1

File

object

string

nullable

FolderId

string

nullable

Owner

object

ModuleKey

string

nullable

ResourceKind

string

nullable

ContextResourceId

string

nullable

ResourceObjectId

string

nullable

Relations

Array<object>

nullable

object

string

nullable

Target

object

ModuleKey

string

nullable

ResourceKind

string

nullable

ContextResourceId

string

nullable

ResourceObjectId

string

nullable

RelationKind

integer format: int32

Allowed values: 0

Source

object

ModuleKey

string

nullable

ResourceKind

string

nullable

ContextResourceId

string

nullable

ResourceObjectId

string

nullable

PolicyCode

string

nullable

CorrelationId

string

nullable

CreatedByUserId

string

nullable

CreatedAt

string format: date-time

DeletedAt

string format: date-time

nullable

Origin

object

Source

object

ModuleKey

string

nullable

ResourceKind

string

nullable

ContextResourceId

string

nullable

ResourceObjectId

string

nullable

PolicyCode

string

nullable

CorrelationId

string

nullable

IsDeleted

boolean

EditDeadline

string format: date-time

Descriptor

object

string

nullable

FileName

string

nullable

Description

string

nullable

MimeType

string

nullable

SizeBytes

integer format: int64

ChecksumSha256

string

nullable

CreatedAt

string format: date-time

ModifiedAt

string format: date-time

nullable

CreatedByUserId

string

nullable

CreatedByUserName

string

nullable

ModifiedByUserId

string

nullable

ModifiedByUserName

string

nullable

Owner

object

Identity

object

ModuleKey

string

nullable

ResourceKind

string

nullable

ContextResourceId

string

nullable

ResourceObjectId

string

nullable

DisplayName

string

nullable

SafeLabel

string

nullable

OpenTarget

object

TargetCode

string

nullable

Parameters

object

key

additional properties

string

CanOpen

boolean

RelatedTarget

object

Identity

object

ModuleKey

string

nullable

ResourceKind

string

nullable

ContextResourceId

string

nullable

ResourceObjectId

string

nullable

DisplayName

string

nullable

SafeLabel

string

nullable

OpenTarget

object

TargetCode

string

nullable

Parameters

object

key

additional properties

string

CanOpen

boolean

Source

object

Identity

object

ModuleKey

string

nullable

ResourceKind

string

nullable

ContextResourceId

string

nullable

ResourceObjectId

string

nullable

DisplayName

string

nullable

SafeLabel

string

nullable

OpenTarget

object

TargetCode

string

nullable

Parameters

object

key

additional properties

string

CanOpen

boolean

RelationId

string

nullable

RelationKind

integer format: int32

Allowed values: 0

PolicyCode

string

nullable

CorrelationId

string

nullable

CreatedAt

string format: date-time

Permissions

object

CanView

boolean

CanRename

boolean

CanDelete

boolean

CanDownload

boolean

Errors

Array<object>

nullable

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

Array<object>

nullable

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

boolean

Example

{
  "Data": {
    "Items": [
      {
        "Placement": 0,
        "File": {
          "Relations": [
            {
              "RelationKind": 0
            }
          ]
        },
        "RelationKind": 0
      }
    ]
  },
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

403

Forbidden

application/json

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

key

additional properties

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

Return a compact owned and related attachment summary for a Resource Catalog identity.

Authorizations

Parameters

Query Parameters

Request Body

Responses

200

Example

400

Example

403

Examplegenerated

Example^generated