Maintenance Notice - PDF Generation
Dynamic PDF generation for web-based content is temporarily unavailable. This maintenance affects dynamic PDF files that are generated from either the HTML-based page or manual that you are viewing. Links that normally allow this functionality have been hidden, and will reappear as soon as the feature is restored.


Note: Access to static files, including PDF files that are not dynamically generated from our web-based content, is unaffected.

Jump to: navigation, search

Query State Extension Schema

ApiRef2.png GET /metadata/states/extensions
Available since: 8.0.200.00

Description

Retrieves one or more schema for state extensions. Information.png This operation is possible in either maintenance and production mode.

Operation

Query State Extension Schema
ID CV.WS.SRV.META.6
Method GET
URL
  1. All: /metadata/states/extensions
  2. /metadata/states/extensions/${extension-name}
Name   Type   Mandatory Description
URL Parameters
${extension-name} string no The unique name of the extension, to retrieve a single extension schema. If you do not specify this name, all the state extension schemas are returned.


Important.png Note: The name is not case-sensitive.

<references />

Response

The Context Management Service API answers with HTTP codes for every request. The following table shows the correct response for a successful request. See HTTP Response Codes and Errors for further details on the possible codes that this operation can return.

Response
HTTP code 200
HTTP message OK
Body
Extension Schema or Extension Schema[]

Examples

Several results

Operation

 GET /metadata/states/extensions
 

Result

 200 OK
 [{
  "attributes": [
      {"name":"FeedbackType","type":"string","length":"10","mandatory":"true"},
      {"name":"rating","type":"integer","mandatory":"true"},
      {"name":"notes","type":"string","length":256,"mandatory":"false"}
      ],
  "name":"Feedback",
  "type":"single-valued",  
 },
 {
  "attributes": [
      {"name":"priority","type":"integer","mandatory":"true"},
      {"name":"customerNotes","type":"string","length":256,"mandatory":"false"}
      ],
  "name":"PriorityFlag",
  "type":"single-valued",  
 }
]

Single result

Operation

 GET /metadata/states/extensions/feedback
 

Result

  200 OK
 {
  "attributes": [
      {"name":"FeedbackType","type":"string","length":"10","mandatory":"true"},
      {"name":"rating","type":"integer","mandatory":"true"},
      {"name":"notes","type":"string","length":256,"mandatory":"false"}
      ],
  "name":"Feedback",
  "type":"single-valued",  
 }
This page was last edited on November 23, 2017, at 16:01.

Feedback

Comment on this article:

blog comments powered by Disqus