How to use APIs: Custom data via Extension

Developer guide: Getting Started FSM

Introduction

This is a feature that allows to submit and retrieve additional, customized data to our APIs.

JSON

{
  "extension.myFieldName": "myValue"
}

The extension JSON object can be used in both a request and a response, meaning that custom data can either be added to the application, or retrieved from the application.

Same goes for extended QueryParameters:

Bash

curl "<https://api.overit.cloud/api/r1/work-order?code=myCode&extension.myFieldName=myValue&extension.myArray=1&extension.myArray=2>" \
  -H "Authorization: Bearer <personal_access_token>"

JSON

"content": [
  {
    "id": 0,
    "code": "string",
    "extension": {
      "myFieldName": "myValue",
      "myArray": 1,2
    }
  }
],
"_page": {
  "num": 0,
  "hasMore": false
}