Jump to: navigation, search

queryIdKeySchema

URL

  • GET /metadata/identification-keys/{key_name}

Request

URL Parameters

Key ValueType Value Description Mandatory Unique Default
key_name String key-name The name of the key. Must start with a letter, and can be followed with letters, numbers, or underscores. true true

HTTP Headers

Key ValueType Value Description Mandatory Unique Default
X-Genesys-TenantId Integer Integer value of tenant id false true
X-Genesys-Segment String Segment value (not to be provided by customer) false true

Sample

GET /metadata/identification-keys/idExtension

Responses

Body

Key ValueType Value Description Mandatory Unique Default
Body JsonObjectArray false false

Success

ReturnCode ReturnString Description
200 OK Request successful

Error

FaultCode FaultString Description
400 Bad Request General error which can be one of the following reasons:
  • Missing required parameter.
  • Parameter value of unexpected type.
  • Invalid object syntax.
  • Missing required attribute
401 Not Authorized Credentials are missing or incorrect, or the given user is not allowed to execute a given service (such as an administrative service method that changes the profile schema).
403 Forbidden The operation is forbidden and the reason is specified in the error message. This error is returned in the following cases:
  • Attempt to alter an existing schema.
  • Attempt to add customer profiles prior to the definition of a profile schema.
404 Not Found The specified URI is invalid, or the requested resource (such as a customer, service, state, task, extension, or identification key) does not exist.
405 Method Not Allowed Returned when an unsupported operation is requested. For instance, if a resource supports only PUT and GET operations, a POST request on this resource returns this error.
415 Unsupported Media Type In the header of your request, Content-Type is not set to a valid value. Most operations of Context Services support only "application/json".

Sample

 
200 OK
{"name": "idExtension", "attributes": ["ext.code","ext.date"], "unique": true}}

Feedback

Comment on this article:

blog comments powered by Disqus
This page was last modified on May 18, 2018, at 07:05.