Jump to

• Request
• Response

List the resources

get

ess/rest/scheduler/v1

Lists the scheduler API resources

Request

There are no request parameters for this operation.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json
• application/vnd.oracle.resource+json

200 Response

OK

Body ()

Root Schema : RootResource

Collection resource describing a list of versions of an API.

Match All

Collection resource describing a list of versions of an API.

Show Source

• allOf Base Collection Resource
  Title: Base Collection Resource

  Oracle base collection resource schema definition.

{ "description":"Collection resource describing a list of versions of an API.", "allOf":[ { "$ref":"#/components/schemas/collectionBaseResource" } ] }

Nested Schema : Base Collection Resource

Title: Base Collection Resource

Oracle base collection resource schema definition.

Match All

Oracle base collection resource schema definition.

Show Source

• object Singular Resource
  Title: Singular Resource

  Oracle base singular resource schema definition.

{ "title":"Base Collection Resource", "description":"Oracle base collection resource schema definition. ", "allOf":[ { "$ref":"#/components/schemas/singularResource" } ] }

Nested Schema : Singular Resource

Type: object

Title: Singular Resource

Oracle base singular resource schema definition.

Show Source

• links: array links

{ "title":"Singular Resource", "type":"object", "properties":{ "links":{ "type":"array", "items":{ "$ref":"#/components/schemas/instanceLink" } } }, "description":"Oracle base singular resource schema definition." }

Nested Schema : links

Type: array

Show Source

• Array of: object instanceLink
  Metadata describing link description objects that MAY appear in the JSON instance representation.

{ "type":"array", "items":{ "$ref":"#/components/schemas/instanceLink" } }

Nested Schema : instanceLink

Type: object

Metadata describing link description objects that MAY appear in the JSON instance representation.

Show Source

• href(required): string
  URI [RFC3986] or URI Template [RFC6570]. If the value is set to URI Template, then the \"templated\" property must be set to true."
• mediaType: string
  Media type, as defined by RFC 2046, describing the link target.
• method: string
  HTTP method for requesting the target of the link.
• profile: string
  Link to the metadata of the resource, such as JSON-schema, that describes the resource expected when dereferencing the target resource..
• rel(required): string
  Name of the link relation that, in addition to the type property, can be used to retrieve link details. For example, href or profile.
• templated: boolean
  Boolean flag that specifies that \"href\" property is a URI or URI Template. If the property is a URI template, set this value to true. By default, this value is false.

{ "required":[ "href", "rel" ], "type":"object", "properties":{ "href":{ "type":"string", "description":"URI [RFC3986] or URI Template [RFC6570]. If the value is set to URI Template, then the \n\\\"templated\\\" property must be set to true.\"\n" }, "rel":{ "type":"string", "description":"Name of the link relation that, in addition to the type property, can be used to retrieve link details.\nFor example, href or profile.\n" }, "templated":{ "type":"boolean", "description":"Boolean flag that specifies that \\\"href\\\" property is a URI or URI Template.\nIf the property is a URI template, set this value to true. By default, this value is false.\n" }, "mediaType":{ "type":"string", "description":"Media type, as defined by RFC 2046, describing the link target.\n" }, "method":{ "type":"string", "description":"HTTP method for requesting the target of the link." }, "profile":{ "type":"string", "description":"Link to the metadata of the resource, such as JSON-schema, that describes the resource\nexpected when dereferencing the target resource..\n" } }, "description":"Metadata describing link description objects that MAY appear in the JSON instance representation." }

500 Response

server error

Body ()

Root Schema : SimpleExceptionDetail

Type: object

Show Source

• detail: string
  Detailed error message
• errorCode: string
  ESS-specific error code. For example ESS-00500.
• status: integer
  HTTP status code
• title(required): string
  Summary error message
• type(required): string
  URI. It will be beneficial if teams can provide application specific problem types. If not, at least we should link to HTTP error code page.

{ "required":[ "title", "type" ], "type":"object", "properties":{ "type":{ "type":"string", "description":"URI. It will be beneficial if teams can provide application specific problem types. If not, at least we should link to HTTP error code page." }, "title":{ "type":"string", "description":"Summary error message" }, "status":{ "type":"integer", "description":"HTTP status code" }, "detail":{ "type":"string", "description":"Detailed error message" }, "errorCode":{ "type":"string", "description":"ESS-specific error code. For example ESS-00500." } } }

Back to Top