IRironcladapp
Exports

Submit a request to generate a new data export

Submit a request to generate a new data export.

OAuth Scope required: public.export.createReports

The Data Export feature is part of the paid Security & Data Pro add-on. Contact your Ironclad account representative for more information about purchasing this package.

post/exports

Request

  • Base URL
    https://ironcladapp.com/public/api/v1
  • URL
    https://ironcladapp.com/public/api/v1/exports
  • Auth
    API key in header Authorization and OAuth 2
    Authorization code: https://ironcladapp.com/oauth/authorize
    Client credentials
    Token URL: https://ironcladapp.com/oauth/token scopes: public.export.createReports

Headers

x-as-user-emailstring
Example:jane.doe@test.com

Denotes the actor of the request. When used, the API will take into account this user's permissions and access. This or x-as-user-id is required when the associated token was produced from the Client Credentials grant or with legacy bearer tokens on select endpoints. A token produced from the Authorization Code grant (which is already scoped to a user) may also use this header to act as a different user in the same company, provided the token carries the identity.users.impersonate scope and the token's own user has been granted the API User Impersonation permission. A request that sends this header without both never acts as the named user; depending on the company's configuration it either proceeds as the token's own user or is rejected with a 403. More information about permissions.

x-as-user-idstring
Example:5f0375c4cdc1927a3c5edcd3

Denotes the actor of the request. When used, the API will take into account this user's permissions and access. This or x-as-user-email is required when the associated token was produced from the Client Credentials grant or with legacy bearer tokens on select endpoints. A token produced from the Authorization Code grant (which is already scoped to a user) may also use this header to act as a different user in the same company, provided the token carries the identity.users.impersonate scope and the token's own user has been granted the API User Impersonation permission. A request that sends this header without both never acts as the named user; depending on the company's configuration it either proceeds as the token's own user or is rejected with a 403. More information about permissions.

Request body

exportType'workflow_activities' | 'audit_log' required

string for record type. Example: workflow_activities

startDatestring

Starting date (ISO8601 format) of data to be included in the export. Example: 2016-11-17T00:37:22.318Z

endDatestring

Starting date (ISO8601 format) of data to be included in the export. Example: 2016-11-17T00:37:22.318Z

exportFormat'CSV' | 'JSON'

File format for the export. CSV is the default.

signedUrlEnabledboolean

An optional boolean value to enable a signed url for downloading the exported file. If not provided, defaults to false.

Example request

{
  "exportType": "workflow_activities",
  "startDate": "2016-11-17T00:37:22.318Z",
  "endDate": "2016-11-17T00:37:22.318Z",
  "exportFormat": "CSV",
  "exportConfigs": {
    "metadataProperties": [
      "counterpartyName"
    ]
  }
}

Response

200

jobIdstring
jobStatus'pending' | 'running' | 'done' | 'failed'

Example response

{
  "jobId": "02e1343b-d024-4de0-a22e-a579282f05d9"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.