FAfabric
Catalog Connector Files

Create a file object and retrieve the file upload URL

Use this endpoint to retrieve the URL of the AWS S3 location to upload the file that you want to import to the Catalog Connector.

post/catalog-connector-files

Request

Headers

x-fabric-tenant-idstring required

A header retrieved from your Copilot Account Details that's used by the API to identify the tenant making the request. Tenant ID must be included in the authentication header for API requests to access any of fabric’s endpoints.

x-fabric-request-idstring

Unique request ID

Request body

type'CATALOG_CONN_ITEM_VARIANT_IMPORT' | 'CATALOG_CONN_ITEM_VARIANT_EXPORT' | 'CATALOG_CONN_BUNDLE_IMPORT' | 'CATALOG_CONN_BUNDLE_EXPORT' required

Specify the type of operation or job performed by uploading the file.

namestring required

The name of the file to be imported.

localestring required

The language code, which is a combination of language (ISO 639 format) and country (ISO 3166 format).

The default value is en-US.

formatType'csv' | 'jsonl' required

Specify the file format used to upload to Catalog Connector.

Example request

{
  "type": "CATALOG_CONN_ITEM_VARIANT_IMPORT",
  "name": "bulk_import_123345677788999.csv",
  "locale": "en-US",
  "formatType": "jsonl"
}

Response

OK

idstring

A 24-character system-generated file ID.

type'CATALOG_CONN_ITEM_VARIANT_IMPORT' | 'CATALOG_CONN_ITEM_VARIANT_EXPORT' | 'CATALOG_CONN_BUNDLE_IMPORT' | 'CATALOG_CONN_BUNDLE_EXPORT'

Specify the type of operation or job performed by uploading the file.

namestring

The name of the file name to be uploaded to the AWS S3 location.

localestring

The language code, which is a combination of language (ISO 639 format) and country (ISO 3166 format).

The default value is en-US.

formatType'csv' | 'jsonl'

Specify the file format used to upload to Catalog Connector.

createdAtstring

The time of file creation, in UTC format.

updatedBystring

The email of the user who last updated the file.

updatedAtstring

The time of last update to the file, in UTC format.

locationstring

The AWS S3 file location of the imported file is provided as a URL.

Example response

{
  "id": "857f1f77bcf86cd799439054",
  "type": "CATALOG_CONN_ITEM_VARIANT_IMPORT",
  "name": "bulk_import_123345677788999.csv",
  "locale": "en-US",
  "formatType": "jsonl",
  "createdAt": "2021-09-14T22:10:30.618Z",
  "updatedBy": "test@email.com",
  "updatedAt": "2021-09-14T22:10:30.618Z",
  "location": "https://s3.console.aws.amazon.com/s3/buckets/greatwall-stg01-bulk-import-pim/bulk_import_123345677788999.csv"
}

Changes

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