v2.84.0

TS Dev 108 API Documentation

Download OpenAPI Document

JSON

Download OpenAPI Document

YAML

---

FGL Template

Manages FGL templates and commands

Operations

GET/api/v2/fgl-templatePOST/api/v2/fgl-templateGET/api/v2/fgl-template/signingGET/api/v2/fgl-template/certificateDELETE/api/v2/fgl-template/{id}PATCH/api/v2/fgl-template/{id}GET/api/v2/fgl-template/{id}/commandGET/api/v2/fgl-template/{id}/command/{commandId}POST/api/v2/fgl-template/{id}/command/{commandId}DELETE/api/v2/fgl-template/{id}/command/{commandId}PATCH/api/v2/fgl-template/{id}/command/{commandId}

---

Get FGL templates

GET

/api/v2/fgl-template

Get FGL templates

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Query Parameters

_limit

Set the max number of fgl templates to return.

Type

number

Format

"integer"

_offset

Set the number of objects to ignore before starting.

Type

number

Format

"integer"

Responses

A list of fgl templates.

GET

/api/v2/fgl-template

Playground

Authorization

bearerAuth

Variables

Key

Value

_limit

_offset

Samples

---

Create a fgl template

POST

/api/v2/fgl-template

Create a fgl template

Authorizations

bearerAuth

Type

HTTP (bearer)

Request Body

application/json

{

  

"name": "string",

  

"includeReceipt": true

}

Responses

Create template Succeeded

POST

/api/v2/fgl-template

Playground

Authorization

bearerAuth

Body

Samples

---

Get FGL signature for FGL print

GET

/api/v2/fgl-template/signing

Get FGL signature for FGL print

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Query Parameters

request*

request to sign

Type

string

Required

Responses

fgl printing signature

GET

/api/v2/fgl-template/signing

Playground

Authorization

bearerAuth

Variables

Key

Value

request*

Samples

---

Get FGL certificate

GET

/api/v2/fgl-template/certificate

Get FGL certificate

Authorizations

bearerAuth

Type

HTTP (bearer)

Responses

fgl printing certificate

GET

/api/v2/fgl-template/certificate

Playground

Authorization

bearerAuth

Samples

---

Deletes an existing fgl template

DELETE

/api/v2/fgl-template/{id}

Deletes an existing fgl template

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

id*

The id of the fgl template

Type

string

Required

Responses

Deleted fgl template

DELETE

/api/v2/fgl-template/{id}

Playground

Authorization

bearerAuth

Variables

Key

Value

id*

Samples

---

Updates an existing fgl template

PATCH

/api/v2/fgl-template/{id}

Updates an existing custom dasbhboard

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

id*

The id of the fgl template

Type

string

Required

Request Body

application/json

"string"

Responses

Update template succeeded

PATCH

/api/v2/fgl-template/{id}

Playground

Authorization

bearerAuth

Variables

Key

Value

id*

Body

Samples

---

Get FGL template commands

GET

/api/v2/fgl-template/{id}/command

Get FGL template commands

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

id*

The id of the fgl template

Type

string

Required

Query Parameters

_limit

Set the max number of fgl commands to return.

Type

number

Format

"integer"

_offset

Set the number of objects to ignore before starting.

Type

number

Format

"integer"

Responses

A list of fgl commands.

GET

/api/v2/fgl-template/{id}/command

Playground

Authorization

bearerAuth

Variables

Key

Value

id*

_limit

_offset

Samples

---

Get an FGL template command

GET

/api/v2/fgl-template/{id}/command/{commandId}

Get an FGL template command

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

id*

The id of the fgl template

Type

string

Required

commandId*

The id of the fgl command

Type

string

Required

Responses

An fgl command.

GET

/api/v2/fgl-template/{id}/command/{commandId}

Playground

Authorization

bearerAuth

Variables

Key

Value

id*

commandId*

Samples

---

Create a command for an fgl template

POST

/api/v2/fgl-template/{id}/command/{commandId}

Create a command for an fgl template

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

id*

The id of the fgl template

Type

string

Required

commandId*

The id of the command

Type

string

Required

Request Body

application/json

{

  

"type": "string",

  

"data": "string",

  

"font": "string",

  

"orientation": "string",

  

"row": 0,

  

"column": 0,

  

"height": 0,

  

"width": 0

}

Responses

Create command Succeeded

POST

/api/v2/fgl-template/{id}/command/{commandId}

Playground

Authorization

bearerAuth

Variables

Key

Value

id*

commandId*

Body

Samples

---

Deletes an existing fgl command

DELETE

/api/v2/fgl-template/{id}/command/{commandId}

Deletes an existing fgl command

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

id*

The id of the fgl template

Type

string

Required

commandId*

The id of the fgl command

Type

string

Required

Responses

Deleted fgl command

DELETE

/api/v2/fgl-template/{id}/command/{commandId}

Playground

Authorization

bearerAuth

Variables

Key

Value

id*

commandId*

Samples

---

Updates an existing fgl command

PATCH

/api/v2/fgl-template/{id}/command/{commandId}

Updates an existing fgl command

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

id*

The id of the fgl template

Type

string

Required

commandId*

The id of the fgl command

Type

string

Required

Request Body

application/json

"string"

Responses

Update command succeeded

PATCH

/api/v2/fgl-template/{id}/command/{commandId}

Playground

Authorization

bearerAuth

Variables

Key

Value

id*

commandId*

Body

Samples

---

Powered by VitePress OpenAPI