TeamForge Orchestrate HTTP API for XDS Schema Creation and Viewing

• TeamForge Orchestrate HTTP API for XDS Schema provides a means to create an XDS schema or view a schema and its versions. The API supports both data retrieval and submission.
• Authentication: requires a valid TeamForge SOAP session id, passed with the 'X-Orchestrate-Session' header field. One way to acquire this session id is to programmatically log into TeamForge using TeamForge SOAP API.
• Authorization: requires the TeamForge Orchestrate "PIPELINE CREATE" permission, or site admin permissions for creating schema. No permission required for viewing schema.

API requests for viewing and creating schemas are constructed as detailed below.

• List all schemas
  • Request Type: GET
  • Request URL: https://<orchestrate_hostname>/api/1/schemas
  • Return Format: Array of JSON objects. Each of the JSON object is a schema.
• List all schemas with a same schema_id
  • Request Type: GET
  • Request URL: https://<orchestrate_hostname>/api/1/schemas/SCHEMA_ID
    Note: SCHEMA_ID needs to be encoded (escaped).
  • Requires Parameter: SCHEMA_ID
  • Return Format: Array of one or more JSON object(s). Each of the JSON object is a schema with the given schema_id and all the versions.
• Get one schema
  • Request Type: GET
  • Request URL: https://<orchestrate_hostname>/api/1/schemas/SCHEMA_ID/VERSION
    Note: SCHEMA_ID needs to be encoded (escaped).
  • Requires Parameter: SCHEMA_ID, VERSION
  • Return Format: Array with one JSON object. The JSON object is a schema with the given schema_id and given version.
• Create a schema
  • Request Type: POST
  • Request URL: https://<orchestrate_hostname>/api/1/schemas
  • Return Format: An encoded (escaped) URL. This URL can be used to view the schema once it has been processed and saved.