COconnexcs
Setup Prefix Set

Read

Changed on

Retrieve a single Setup Prefix Set record by ID.

get/api/cp/setup/prefix-set/{id}

Request

  • Base URL
    https://app.connexcs.com
  • Auth
    • OAuth 2
      Authorization code: https://auth.connexcs.com/authorize
      Token URL: https://auth.connexcs.com/token
    • or HTTP bearer

Path parameters

idinteger required

Id identifier

Response

Successful response

idinteger

Id

account_idinteger

Account Id (references account.id)

company_idinteger

Company Id

namestring

Name

datastring

Data

querystring

Query

flagsstring[]

Flags

Example response

{
  "id": 12345,
  "account_id": 1,
  "company_id": 1,
  "name": "Example Name",
  "data": "Sample data text content",
  "query": "Sample query text content",
  "flags": "GLOBAL_DN"
}

Changes

  • 6a3b5409bd66Revision changes
    • warning

      added the new COMPANY_READ enum value to the / response property for the response status

    • warning

      added the new COMPANY_WRITE enum value to the / response property for the response status

    • info

      added the optional property to the response with the status

  • f5199a70325aRevision changes
    • warning

      added the new DATABASE enum value to the / response property for the response status