Skip to main content

Returns directory for a file exchange

Returns the complete directory (files 'n folders) shared by a provider with a consumer organization

Path Parameters
organizationId uuid REQUIRED

A valid provider or consumer organization id. Must be a valid consumer id, if id of header value organization-id is a consumer id and opposite a valid provider id, if header value organization-id is a consumer id.

Header Parameters
organization-id uuid REQUIRED

ID of organization context this request belongs to.

Responses
200

The complete directory

Schema OPTIONAL
folders object[] OPTIONAL
createdAt date-time OPTIONAL
createdBy string OPTIONAL
customProperties object OPTIONAL

Contains optional properties. Please note that custom properties may disappear without notice.

id uuid OPTIONAL
name string OPTIONAL
parentId uuid OPTIONAL
permissions object[] OPTIONAL
group string OPTIONAL

Possible values: [ACCESS, ACCESS_DEFINITION, BUNDLE, CONSUMER, CONTACT, FILE, FOLDER, INVITATION, ORGANIZATION, PLAN, PLATFORM_ADMIN, PRODUCT, TENANT, TEAM, TECHNICAL_USER, USER, USER_ROLES]

files object[] OPTIONAL
createdAt date-time OPTIONAL
createdBy string OPTIONAL
id uuid OPTIONAL
mimeType string OPTIONAL
name string OPTIONAL
parentId uuid OPTIONAL
permissions object[] OPTIONAL
group string OPTIONAL

Possible values: [ACCESS, ACCESS_DEFINITION, BUNDLE, CONSUMER, CONTACT, FILE, FOLDER, INVITATION, ORGANIZATION, PLAN, PLATFORM_ADMIN, PRODUCT, TENANT, TEAM, TECHNICAL_USER, USER, USER_ROLES]

size int64 OPTIONAL
updatedAt date-time OPTIONAL
updatedBy string OPTIONAL
createdByOrganizationId uuid OPTIONAL
nodeType string OPTIONAL

Possible values: [CONTRACT, INVOICE, CREDENTIAL, REPORT, MISC, CUSTOM]

subfolders (circular)[] OPTIONAL
400

Bad Request (e.g. element not found or resource conflict).

Schema OPTIONAL
message string OPTIONAL
timestamp date-time OPTIONAL
traceId string OPTIONAL
type string OPTIONAL
403

Missing permission

Schema OPTIONAL
message string OPTIONAL
timestamp date-time OPTIONAL
traceId string OPTIONAL
type string OPTIONAL
500

Internal server error (Internal service communication or process error).

Schema OPTIONAL
message string OPTIONAL
timestamp date-time OPTIONAL
traceId string OPTIONAL
type string OPTIONAL