Jump to: navigation, search

Get Metadata

Important
Prerequisites: You need to enable profiles in UCS.
GET ${content-type} /metadata

Description

Returns the location for the list of available metadata resources.

Operation

Get Metadata
ID CV.WS.META.1
Method GET
URL /metadata
HEADER ${content-type}
Parameter   Type   Mandatory Description
${content-type}
  • "Content-type:text/html"
  • "Content-type:application/json"
 yes The formatting for the returned result.

<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 GET "Content-type:text/html" /metadata
Returns an HTML page, containing a list of resource links as follows: 
<html><body><h1>Available Resources</h1><br/>
<a href="http://localhost:8080/metadata/${resource}">${resource-name}<br/>
</body></html>

where:

  • ${resource} is the location of the resource.
  • ${resource-name}, the name of the resource.
GET "Content-type:application/json" /metadata
Returns a JSON table, containing a list of resource links as follows: 
{${resource-name-1}:${resource-1}, ${resource-name-2}:${resource-2}, ..., ${resource-name-n}:${resource-n} }

where:

  • ${resource_i} is the location of the resource-i.
  • ${resource-name_i} is the name of the resource-i.

Example

Operation 

 GET "Content-type:text/html" /metadata

Result 

200 OK {
<html><body><h1>Available Resources</h1><br/>
<a href="http://localhost:8080/metadata/identification-keys">
identification-keys schemas<br/>
<a href="http://localhost:8080/metadata/tasks/extensions">Tasks Extensions<br/>
<a href="http://localhost:8080/metadata/states/extensions">States Extensions<br/>
<a href="http://localhost:8080/metadata/services/extensions">Services Extensions<br/>
<a href="http://localhost:8080/metadata/business-attributes">business-attributes mapping<br/>
</body></html>
}

Operation 

 GET "Content-type:application/json" /metadata

Result 

  
   200 OK
   {"identification-keys schemas":"http://localhost:8080/metadata/identification-keys",
	"Tasks Extensions":"http://localhost:8080/metadata/tasks/extensions",
	"Services Extensions":"http://localhost:8080/metadata/services/extensions",
	"States Extensions":"http://localhost:8080/metadata/states/extensions",
	"business-attributes mapping":"http://localhost:8080/metadata/business-attributes"}
This page was last edited on September 7, 2018, at 10:34.
Comments or questions about this documentation? Contact us for support!