Relesys API Docs

v1.3

https://api.relesysapp.net/api/v1.3

Welcome

Introduction Getting access

Concepts

Scopes HTTP Status Codes Request Throttling Pagination Filtering Sorting Patch Requests

Endpoints

DataListCustomFields

Get Custom Fields
GET /dataLists/{dataListId}/customFields 
https://api.relesysapp.net/api/v1.3/dataLists/{dataListId}/customFields
Get a list of custom fields for a data list with ID dataListId.
Default sort is by sortOrder in ascending order.

type - This field displays the type of the data list. Currently, the available types are:
  • Text
  • Multiline Text
  • Date
  • Data List
  • Media
  • Number
  • Barcode
  • Color
barcodeType - This field is only set when the type is barcode.
referencingDataList - This field is only set when the type is data list.

This is a reference list of the barcode types.
  • code_128_reader ↔ Code 128
  • ean_reader ↔ EAN
  • ean_8_reader ↔ EAN 8
  • code_39_reader ↔ Code 39
  • code_39_vin_reader ↔ Code 39 VIN
  • codabar_reader ↔ CODABAR
  • upc_reader ↔ UPC
  • upc_e_reader ↔ UPC-E
  • i2of5_reader ↔ ITF-14
  • 2of5_reader ↔ Two-out-of-five
  • code_93_reader ↔ Code 93
Scopes: relesys.api, relesys.api:read, relesys.api.datalists, relesys.api.datalists:read
URL Path
dataListId string / guid required
Query String
barcodeType string Filterable Sortable optional
creationDateTime datetimeoffset Filterable Sortable optional
externalId string Filterable Sortable optional
id string / guid Filterable optional
isEnabled boolean Filterable optional
isRequired boolean Filterable optional
lastModifiedDateTime datetimeoffset Filterable Sortable optional
sortOrder integer Filterable Sortable optional
type string Filterable Sortable optional
sort string Comma separated sort order based on sortable properties optional
offset integer Offset value for use in pagination Default: 0 optional
limit integer Total objects to fetch (max 1000) Default: 200 optional
Responses
application/json
200
Schema Example
JSON
{"count":2,"data":[{"id":"8a1a0a8c-dce6-48be-8cba-3c8896b8c6a3","url":null,"type":"Text","isRequired":true,"sortOrder":0,"isEnabled":true,"externalId":"Data list custom field externalId example 1","barcodeType":null,"referencingDataList":null,"creationDateTime":"2024-11-20T06:23:24.8058143+00:00","lastModifiedDateTime":"2024-11-21T06:23:24.8058143+00:00","locales":[{"culture":"da-DK","title":"Data list locale title example 1"}]},{"id":"62e36193-98a7-4dcf-9e54-d031f646d958","url":null,"type":"Data List","isRequired":false,"sortOrder":1,"isEnabled":false,"externalId":"Data list custom field externalId example 2","barcodeType":null,"referencingDataList":null,"creationDateTime":"2024-11-20T06:23:24.8058143+00:00","lastModifiedDateTime":null,"locales":[{"culture":"da-DK","title":"Data list locale title example 2"},{"culture":"da-DK","title":"Data list locale title example 3"}]}]}
object
  count integer      
  ⯈ data array[object]      
   barcodeType string      
   creationDateTime datetimeoffset      
   externalId string      
   id string / guid      
   isEnabled boolean      
   isRequired boolean      
   lastModifiedDateTime datetimeoffset      
   ⯈ locales array[object]      
    culture string      
    title string      
   ⯈ referencingDataList object      
    id string / guid      
    url string      
   sortOrder integer      
   type string      
   url string      
  nextUrl string      
  previousUrl string