Helper REST APIs

About XPRESSO Helper REST APIs

XPRESSO provides the following (limited) public REST APIs to assist with gathering information to help you automate your workflow.

Get resource meta information

Retrieves the meta information of group restricted resources when queried by name.

• URL: /api/v1/resouces/<category>/<resource_id>
• Method: GET
• Permission Required: none
• Group: retrieved from headers

The available categories are:

• jobs
• profiles
• testbeds
• topologies
• engines
• harnesses

eg.

/api/v1/resouces/jobs/some_name

• Success Response

  • Condition: Data provided is valid and User is Authenticated
  • Code: 200 OK
  • Response example:

{
  "uuid": "0614ce73-3110-45ed-8d2f-e7831c226215",
  "name": "some_name",
  "group": "MyGroup",
  "category": "jobs",
  "owner": "some_cec",
  "date_created": "2019-09-20T17:06:47.541Z",
  "deleted": false
}

• Error Response
  • Condition: If provided data is invalid, eg. name not found in the specified group
  • Code: 404 Not Found
  • Response example:

{
  "detail": "Not Found"
}