Collections Content

post

https://api.percipio.com/content-discovery/v1/organizations/{orgId}/report-requests/collections-content

Collections content report provides information about the organization’s subscribed collections and includes details such as the collection name, asset types, status, etc. This API call returns a report handle used to retrieve the collections content report via the report request API. The report data can be customized and filtered based on the parameters mentioned below. If the response is not successful, the appropriate error response returns.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

orgId

uuid

required

Organization UUID

Body Params

The configuration to create request handle is supplied in the request body

collectionName

string

Defaults to ALL

Collections used for content lookup, comma delimited and defaults to all collections

sort

object

The field to use for sorting and which order to sort in, if sort is not included the results will be returned ascending by collection

contentType

string

Content types filter, comma delimited and default to all content types

status

string

enum

Content status filter, comma delimited and defaults to all status type.

Allowed:

locale

string

The field to use for specifying language. Will default to all when not specified. example format 'en-US' or 'fr-FR' or 'de-DE' etc.

sftpId

uuid

SFTP Id associated with OrgId

isFileRequiredInSftp

boolean

Defaults to true

Generated files are required to deliver in the respected sftp location. Default value is true.

zip

boolean

Defaults to false

Generate the reports in zip file format. Default value is false.

encrypt

boolean

Defaults to false

Generate the report file as PGP encrypted file. Default value is false.

isPgpFileExtnNotReqrd

boolean

Defaults to false

If the file that need to be ecncrypted should not include a extension of .pgp at the end of the file name, the value should be set to true. If user sets the value as false or doesn't include the flag a .pgp extension will be appended at the end of file name.

formatType

string

enum

Defaults to JSON

Format Type, defaults to JSON, the value is extracted from Accept attribute in header

Allowed:

fileMask

string

Absolute or masked pattern for the generated report file. Example file masks - fileName_{DD}{MM}{YYYY}, fileName_{ORG_ID}

folderName

string

custom folder under sftp reports wherein the generated report file is to be placed.

includeMillisInFilename

boolean

Defaults to false

Generate files with unix based timestamp. Example - fileName.csv.1561642446608

Responses

400

Bad Request

401

Unauthorized

422

Unprocessable Entity

500

Unexpected error

200Ok

202Accepted