Find all the prompt objects of an application

GET

/prompt

Returns a list of the prompt objects of an application. There are some query parameters that can be used to narrow down the list.

Request

Authorization

Send your HTTP requests with an

Authorization

header that contains the word Basic followed by a space and a base64-encoded string username:password

Example:

Authorization: Basic *****************

Query Params

Header Params

Responses

🟢200OK

application/json

Bodyapplication/json

🟠401Unauthorised

🔴500Internal Server Error

Request Example

Shell

JavaScript

Java

Swift

curl --location '/prompt?reference=string&version=string' \
--header 'Accept: application/json' \
--header 'Authorization: Basic <encoded-value>'

Response Example

200 - OK

[
  {
    "promptTypeId": "prt84ff4-4435-4d2f-a20c-274595ab8cd4",
    "promptId": "pra24ff3-4435-4d2f-a20c-274595ab8cd4",
    "applicationId": "0537b17c-ab62-491c-8085-9ac2b6206346",
    "createdAt": "2018-07-05T16:00:25.075Z",
    "updatedAt": "2018-10-19T09:00:45.000Z",
    "reference": "HouseholdAtrributesNumberOfOccupants",
    "dataSourcePromptTypeInfo": {
      "savedAs": {
        "key": "numberOfOccupants"
      },
      "obj": "prompt",
      "system": "contentsvc",
      "type": "microservice"
    },
    "data": {
      "keys": [
        "title",
        "button"
      ],
      "values": {
        "title": {
          "type": "title",
          "value": "NUMBER_OF_OCCUPANTS_TITLE"
        },
        "button": {
          "type": "title",
          "value": "NUMBER_OF_OCCUPANTS_BUTTON",
          "operation": "SUBMIT_NUMBER_OF_OCCUPANTS"
        }
      }
    },
    "version": "1.0.1",
    "minimumVersion": "1.0.0",
    "status": "OK"
  },
  {
    "promptTypeId": "prt84ff4-4435-4d2f-a20c-274595ab8cd4",
    "promptId": "pra24ff3-4435-4d2f-a20c-274595ab8cd4",
    "applicationId": "0537b17c-ab62-491c-8085-9ac2b6206346",
    "createdAt": "2018-07-05T16:00:25.075Z",
    "updatedAt": "2018-10-19T09:00:45.000Z",
    "reference": "HouseholdAtrributesNumberOfOccupants",
    "dataSourcePromptTypeInfo": {
      "savedAs": {
        "key": "numberOfOccupants"
      },
      "obj": "prompt",
      "system": "contentsvc",
      "type": "microservice"
    },
    "data": {
      "keys": [
        "title",
        "button"
      ],
      "values": {
        "title": {
          "type": "title",
          "value": "NUMBER_OF_OCCUPANTS_TITLE"
        },
        "button": {
          "type": "title",
          "value": "NUMBER_OF_OCCUPANTS_BUTTON",
          "operation": "SUBMIT_NUMBER_OF_OCCUPANTS"
        }
      }
    },
    "version": "1.0.1",
    "minimumVersion": "1.0.0",
    "status": "OK"
  }
]

Modified at 2026-06-11 15:12:29

get a Prompt object

Add a Prompt object