Get a list of External Document types

29 Aug 2023
2 Minutes to read
Contributors

Print
Dark
Light
PDF

Get a list of External Document types

Updated on 29 Aug 2023
2 Minutes to read
Contributors

Print
Dark
Light
PDF

Article summary

Did you find this summary helpful?

Thank you for your feedback

Get

/doctypes/

Get a list of External Document types. Available from product version 3.2.8. External Document types can be filtered by giving filtering parameters at HTTP querystring (see parameters).

Query parameters

offset

integer

Offset to start returning results.

Min length0

limit

integer

Limit number of results returned. Set to -1 to use maximum limit set in the environment. Default limit will be used if parameter is not specified. Special value -1 is available from product version 3.2.18.

Min length1

__any of the object fields__

string

Filters list by selected object field value. Supports structured queries via ++++++ delimiter. Supports ending keywords via ++++++ delimiter:

For string fields: istartswith, startswith, iendswith, endswith, contains, icontains, isnull
For numerics: gt, lt, gte, lte, isnull
For spatial fields: contains, isnull, within, intersects, disjoint, touches, overlaps, covers, coveredby Examples: +++usage_state__txt__istartswith=in+++ , +++plan__state__txt__startswith=In+++ , +++creation_date__gte=2019-01-02T15:32:01+++, +++location__within=POLYGON ((641503.89 6944059.81, 641406.52 6943933.87, 641369.48 6943772.48, 641474.25 6943704.74, 641873.78 6943735.96, 641848.38 6943975.15, 641607.08 6944167.76, 641653.11 6944102.15, 641503.89 6944059.81))+++ Supports exclusive queries by field value using a not-operator preceeding the field lookup: Examples: +++not__type__txt__istartswith=Tie+++ , +++not__id=1390+++

Responses

200

A result response object.

[
  {
    "category": {
      "availability_end_ts": "2020-12-31T00:00:00Z",
      "availability_start_ts": "2020-01-01T00:00:00Z",
      "available": true,
      "groupname": "EXT_DOC_CATEGORY",
      "id": 413470,
      "list_url": "https://example.keycom.com/api/v2/txt_constants/groupname/EXT_DOC_CATEGORY/",
      "logical_txt": "General",
      "num_value": 10.1,
      "num_value2": 20.2,
      "num_value3": 30.3,
      "num_value4": 40.4,
      "txt": "Yleinen"
    },
    "description": "Linkit",
    "id": 210,
    "isDefault": null,
    "type": "Naamataulut"
  },
  {
    "category": {
      "availability_end_ts": "2020-12-31T00:00:00Z",
      "availability_start_ts": "2020-01-01T00:00:00Z",
      "available": true,
      "groupname": "EXT_DOC_CATEGORY",
      "id": 413470,
      "list_url": "https://example.keycom.com/api/v2/txt_constants/groupname/EXT_DOC_CATEGORY/",
      "logical_txt": "General",
      "num_value": 10.1,
      "num_value2": 20.2,
      "num_value3": 30.3,
      "num_value4": 40.4,
      "txt": "Yleinen"
    },
    "description": "Digikuvat",
    "id": 420,
    "isDefault": null,
    "type": "Tekstidokumentit"
  },
  {
    "category": {
      "availability_end_ts": "2020-12-31T00:00:00Z",
      "availability_start_ts": "2020-01-01T00:00:00Z",
      "available": true,
      "groupname": "EXT_DOC_CATEGORY",
      "id": 413470,
      "list_url": "https://example.keycom.com/api/v2/txt_constants/groupname/EXT_DOC_CATEGORY/",
      "logical_txt": "General",
      "num_value": 10.1,
      "num_value2": 20.2,
      "num_value3": 30.3,
      "num_value4": 40.4,
      "txt": "Yleinen"
    },
    "description": "Digikuvat",
    "id": 430,
    "isDefault": null,
    "type": "Sopimukset"
  }
]

Expand All

object

string

Url to next page of External Document types. Null if No next page exist

string

Url to previous page of External Documents. Null if No previous page exist

Results

Array of object (ExternalDocType)

object

category

object

External Document type category

availability_end_ts

string

Ending date time for availability

availability_start_ts

string

Beginning date time for availability

available

boolean

Is object deemed as available. Based on availability_start_ts and availability_end_ts values.

groupname

Group name of constant

Valid values["EXT_DOC_CATEGORY"]

integer

Unique id of constant

list_url

string

Url to fetch all contants from this group

logical_txt

string

Logical textual value

num_value

number

Numeric value

num_value2

number

Numeric value 2

num_value3

number

Numeric value 3

num_value4

number

Numeric value 4

txt

string

Human readable textual representation

description

string

Description of document type

integer

Primary key

isDefault

boolean

Is default type

listUrl

string

Url to fetch all external document types

type

string

Textual representation of document type

Total

integer

Total number of External Document types

401

Authentication credentials are missing or invalid

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

object

details

string

Detailed description of error

Was this article helpful?

What's Next

Get list of electrical cable types