Get text constant data details.
  • 17 Jan 2024
  • 1 Minute to read
  • Contributors
  • Dark
    Light
  • PDF

Get text constant data details.

  • Dark
    Light
  • PDF

Article summary

Get
/txt-constants/{id}/

Operation retrieves details of given id.

Security
API Key
Header parameter nameAuthorization

Token issued for API consumer.

Path parameters
id
integerRequired

Id of Text constant.

Responses
200

Text constant data details.

object

Text constant object. Flat version for patch and post methods

abbreviation
string

Abbreviation

additional_data
string

Additional details

availability_end_ts
string (date-time)

Ending date time for availability

availability_start_ts
string (date-time)

Beginning date time for availability

category
integer

Category of the constant

description
string

Description of the constant

groupname
string

Group name of constant. Group name must contain only uppercase letters separated by underscores.

id
integer

Unique id of constant

logical_abbreviation
string

Logical abbreviation

logical_txt
string

Logical textual value

num_value
number (float)

Numerical value of the constant

num_value2
number (float)

Second numerical value of the constant

num_value3
number (float)

Third numerical value of the constant

num_value4
number (float)

Fourth numerical value of the constant

orderno
integer

Order number

txt
string

Human readable textual representation (translated)

txt_value
string

Text value

value
string

Value

value2
string

Second value

value3
string

Third value

value4
string

Fourth value

401

Authentication credentials are missing or invalid

{
  "details": "Authentication credentials were not provided"
}
object
details
string

Detailed description of error

404

Object was not found

{
  "details": "Not found."
}
object
details
string

Detailed description of error


Was this article helpful?