API - Administrator | Linker Studio

🔗

Linker Studio

get

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/admin/device-app-versions/history' \
  --header 'Authorization: Bearer JWT'

200

401

403

422

{
  "statusCode": 200,
  "data": {
    "appVersions": [
      {
        "id": "7d484e87-d3ce-4139-ba5d-32c5225f0cc5",
        "device": "ANDROID",
        "version": "1.0.0",
        "createdAt": "2022-12-08 16:13:59.499068"
      }
    ]
  }
}

Successful Operation

get

Authorizations

Path parameters

devicestring · enumrequiredAvailable options:

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/admin/device-app-versions/{device}' \
  --header 'Authorization: Bearer JWT'

200

401

403

404

422

{
  "statusCode": 200,
  "data": {
    "id": "7d484e87-d3ce-4139-ba5d-32c5225f0cc5",
    "device": "ANDROID",
    "version": "1.0.0",
    "actionLink": "myActionLinkUrl",
    "iconType": "IMAGE",
    "icon": "myIconUrl",
    "title": "Title 1",
    "AppMessage": "loremp ipsum",
    "createdAt": "2022-12-08 16:13:59.499068"
  }
}

Successful Operation

delete

Authorizations

Path parameters

idstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/admin/device-app-versions/{id}' \
  --header 'Authorization: Bearer JWT'

200

400

401

403

422

{
  "statusCode": 200
}

Successful Operation

get

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/admin/device-app-versions' \
  --header 'Authorization: Bearer JWT'

200

401

403

422

{
  "statusCode": 200,
  "data": {
    "appVersions": [
      {
        "device": "ANDROID",
        "version": "1"
      }
    ]
  }
}

Successful Operation

post

Authorizations

Body

devicestring · enumrequiredExample: IOSAvailable options:

versionstring · 0.0.0requiredExample: 1.0.0

iconTypestring · enumrequiredExample: IMAGEAvailable options:

iconstringrequiredExample: myUrlIcon

titlestringrequiredExample: Title 1

messagestringrequiredExample: loremp ipsum

actionLinkstringrequiredExample: myActionLink

isMinimumVersionbooleanrequiredExample: true

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/admin/device-app-versions' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "device": "IOS",
    "version": "1.0.0",
    "iconType": "IMAGE",
    "icon": "myUrlIcon",
    "title": "Title 1",
    "message": "loremp ipsum",
    "actionLink": "myActionLink",
    "isMinimumVersion": true
  }'

201

400

401

403

422

{
  "statusCode": 201
}

Successful Operation

patch

Authorizations

Path parameters

idstringrequired

Body

devicestring · enumoptionalExample: IOSAvailable options:

versionstring · 0.0.0optionalExample: 1.0.0

iconstringoptionalExample: myUrlIcon

iconTypestring · enumoptionalExample: IMAGEAvailable options:

titlestringoptionalExample: Title 1

messagestringoptionalExample: loremp ipsum

actionLinkstringoptionalExample: myActionLink

isMinimumVersionbooleanoptionalExample: true

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PATCH \
  --url '/admin/device-app-versions/{id}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "device": "IOS",
    "version": "1.0.0",
    "icon": "myUrlIcon",
    "iconType": "IMAGE",
    "title": "Title 1",
    "message": "loremp ipsum",
    "actionLink": "myActionLink",
    "isMinimumVersion": true
  }'

200

400

401

403

422

{
  "statusCode": 200
}

Successful Operation