Get results for board export job

GET 
/v2/orgs/:org_id/boards/export/jobs/:job_id/results

Retrieves the result of the board export job. The response provides more information about the board export job, such as the S3 link to the files created.

Required scope

boards:export

Rate limiting

Level 4

Enterprise only

This API is available only for Enterprise plan users. You can only use this endpoint if you have the role of a Company Admin and eDiscovery is enabled in the Settings. You can request temporary access to Enterprise APIs using this form.

Request

Path Parameters

org_id stringrequired
Unique identifier of the organization.
Example: 3074457345821141000
job_id uuidrequired
Unique identifier of the job.
Example: 92343229-c532-446d-b8cb-2f155bedb807

Responses

200

Board export job result

application/json

Schema

Schema

jobId uuid

Unique identifier of the board export job.

results

object[]

Board export task results.

Array [

boardId stringrequired

Unique identifier of the board.

errorMessage string

Contains the description of the error that occurred during a board export task.

exportLink string

URL of the S3 bucket that contains the exported files.

status stringrequired

Indicates the status of the individual board export task. Possible values: SUCCESS: the board export task was completed successfully and the results are available. ERROR: the board export task encountered an error and failed to complete. The errorMessage field provides more information on the error.

]

Example (from schema)

{
  "jobId": "92343229-c532-446d-b8cb-2f155bedb807",
  "results": [
    {
      "boardId": "o9J_kzlUDmo=",
      "errorMessage": "string",
      "exportLink": "string",
      "status": "CREATED"
    }
  ]
}

400

Malformed request

application/json

Schema

Schema

status number

Default value: 400

HTTP status code.

code string

Default value: invalidParameters

Description of the status code.

message string

Explanation for the error

type string

Default value: error

Type of the object returned.

Example (from schema)

{
  "status": 400,
  "code": "invalidParameters",
  "message": "string",
  "type": "error"
}

401

Invalid authentication credentials

application/json

Schema

Schema

status number

Default value: 401

HTTP status code.

code string

Default value: tokenNotProvided

Description of the status code.

message string

Explanation for the error

type string

Default value: error

Type of the object returned.

Example (from schema)

{
  "status": 401,
  "code": "tokenNotProvided",
  "message": "string",
  "type": "error"
}

403

Invalid access

application/json

Schema

Schema

status number

Default value: 403

HTTP status code.

code string

Default value: forbiddenAccess

Description of the status code.

message string

Explanation for the error

type string

Default value: error

Type of the object returned.

Example (from schema)

{
  "status": 403,
  "code": "forbiddenAccess",
  "message": "string",
  "type": "error"
}

404

Invalid access

application/json

Schema

Schema

status number

Default value: 404

HTTP status code.

code string

Default value: notFound

Description of the status code.

message string

Explanation for the error

type string

Default value: error

Type of the object returned.

Example (from schema)

{
  "status": 404,
  "code": "notFound",
  "message": "string",
  "type": "error"
}

429

Too many requests

application/json

Schema

Schema

status number

Default value: 429

HTTP status code.

code string

Default value: tooManyRequests

Description of the status code.

message string

Explanation for the error

type string

Default value: error

Type of the object returned.

Example (from schema)

{
  "status": 429,
  "code": "tooManyRequests",
  "message": "string",
  "type": "error"
}

Loading...