v2.84.0

TS Dev 108 API Documentation

Download OpenAPI Document

JSON

Download OpenAPI Document

YAML

---

Export Profiles

Endpoints to interact with export profiles

Operations

GET/api/v2/export-profile/GET/api/v2/export-profile/{id}GET/api/v2/export-profile/{id}/columnsPOST/api/v2/export-profile/countPOST/api/v2/export-profile/{id}/generate-report

---

GET /api/v2/export-profile/

GET

/api/v2/export-profile/

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Query Parameters

name

Name to match against profiles

Type

string

Responses

GET

/api/v2/export-profile/

Playground

Authorization

bearerAuth

Variables

Key

Value

name

Samples

---

Find Export Profile by ID

GET

/api/v2/export-profile/{id}

Returns a single export profile

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

id*

Id of export profile to return

Type

integer

Required

Format

"int64"

Responses

GET

/api/v2/export-profile/{id}

Playground

Authorization

bearerAuth

Variables

Key

Value

id*

Samples

---

Get the columns of an export profile

GET

/api/v2/export-profile/{id}/columns

Get the columns of an export profile

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

id*

Id of export profile

Type

integer

Required

Format

"int64"

Responses

GET

/api/v2/export-profile/{id}/columns

Playground

Authorization

bearerAuth

Variables

Key

Value

id*

Samples

---

Get the count of records for a set of filters

POST

/api/v2/export-profile/count

Authorizations

bearerAuth

Type

HTTP (bearer)

Request Body

application/json

"string"

Responses

POST

/api/v2/export-profile/count

Playground

Authorization

bearerAuth

Body

Samples

---

Generate a report using an export profile

POST

/api/v2/export-profile/{id}/generate-report

Generates a report using an export profile

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

id*

ID of export profile to use

Type

integer

Required

Format

"int64"

Request Body

application/json

"string"

Responses

POST

/api/v2/export-profile/{id}/generate-report

Playground

Authorization

bearerAuth

Variables

Key

Value

id*

Body

Samples

---

Powered by VitePress OpenAPI