REregdoor
contents

Preview Bulk Contents

post/api/companies/{company_uuid}/contents/bulk/preview

Request

  • Base URL
    https://api.regdoor.com (the document declares no server; this is the origin it was published from)
  • Auth
    HTTP bearer

Path parameters

company_uuidstring uuid required

Headers

X-User-Emailstring nullable
X-User-Namestring nullable

Request body

action'delete' | 'add_collections' | 'remove_collections' required

Supported bulk actions for library contents.

collections_to_addstring[] nullable

Collection names to merge for add_collections bulk action

collections_to_removestring[] nullable

Collection names to remove for remove_collections bulk action

searchstring nullable

Current list search term

only_companyboolean nullable

Only company private documents

list_selected_contentsboolean nullable

Only contents selected for the company

collection_liststring[] nullable

Current list collection name filters

collections_unassigned_onlyboolean nullable

Only documents with no collections

user_uuid_liststring[] nullable

Filter by content authors

created_fromstring date-time nullable

Filter by created_at from

created_tostring date-time nullable

Filter by created_at to

updated_fromstring date-time nullable

Filter by updated_at from

updated_tostring date-time nullable

Filter by updated_at to

type_liststring[] nullable

Filter by content type names

typestring nullable

Filter by a single content type name

type_uuidstring uuid nullable

Filter by content type UUID

organization_liststring[] nullable

Filter by organization UUIDs (OR)

jurisdiction_listinteger[] nullable

Filter by jurisdiction IDs (OR)

sector_uuid_liststring[] nullable

Filter by sector UUIDs (OR)

subsector_uuid_liststring[] nullable

Filter by subsector UUIDs (OR)

group_uuid_liststring[] nullable

Filter by responsible area (group) UUIDs (OR), via the documents' organizations

mine_groupsboolean nullable

When true, adds the authenticated user's areas (leader or member) to group_uuid_list. Ignored when the user has no area.

unassigned_groupboolean nullable

Only documents whose organizations have no area in this company

only_publicboolean nullable

Only public (global) contents

evaluation_status'pending' | 'in_treatment' | 'treated' | 'not_applicable' nullable

Company evaluation status of the document (Inbox slices)

relevancesCompanyContentRelevanceEnum[] nullable

Company relevance filter (OR)

sort_bystring nullable

Current list sort field

sort_orderstring nullable

Current list sort order

include_content_uuidsstring[] nullable

Manual content UUID selection. When present, filters are ignored.

exclude_content_uuidsstring[] nullable

Content UUIDs excluded from a filtered bulk selection

Response

Successful Response

action'delete' | 'add_collections' | 'remove_collections' required

Supported bulk actions for library contents.

eligible_countinteger required
blocked_countinteger required
processed_countinteger nullable
processed_uuidsstring[]

UUIDs of contents effectively processed by execute

blocked_reasonsobject

Changes

No recorded changes to this operation across all 1 revision of this API.