Jump to

• Request
• Response
• Examples

Retrieve metadata of available versions

get

/py-scripts

Returns metadata describing all available versions of the Script Execution APIs.

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

200 Response

A list of all available versions.

Body ()

Root Schema : EmbedScriptApiMetadata

Type: object

Show Source

• items: array items
  Collection of version resources.
• links: array links
  List of related resource links.

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "description":"Collection of version resources.",
            "items":{
                "$ref":"#/components/schemas/EmbedScriptApiVersion"
            }
        },
        "links":{
            "type":"array",
            "description":"List of related resource links.",
            "items":{
                "$ref":"#/components/schemas/EmbedScriptResourceLink"
            }
        }
    }
}

Nested Schema : items

Type: array

Collection of version resources.

Show Source

• Array of: object EmbedScriptApiVersion

{
    "type":"array",
    "description":"Collection of version resources.",
    "items":{
        "$ref":"#/components/schemas/EmbedScriptApiVersion"
    }
}

Nested Schema : links

Type: array

List of related resource links.

Show Source

• Array of: object EmbedScriptResourceLink
  List of related resource links.

{
    "type":"array",
    "description":"List of related resource links.",
    "items":{
        "$ref":"#/components/schemas/EmbedScriptResourceLink"
    }
}

Nested Schema : EmbedScriptApiVersion

Type: object

Show Source

• isLatest: boolean
  True if this is the latest version of the API.
• lifecycle: string
  Allowed Values: [ "ACTIVE,DEPRECATED" ]

  Lifecycle of the version.
• links: array links
  List of related resource links.
• version: string
  Version of this API.

{
    "type":"object",
    "properties":{
        "version":{
            "type":"string",
            "description":"Version of this API."
        },
        "isLatest":{
            "type":"boolean",
            "description":"True if this is the latest version of the API."
        },
        "lifecycle":{
            "type":"string",
            "description":"Lifecycle of the version.",
            "enum":[
                "ACTIVE,DEPRECATED"
            ]
        },
        "links":{
            "type":"array",
            "description":"List of related resource links.",
            "items":{
                "$ref":"#/components/schemas/EmbedScriptResourceLink"
            }
        }
    }
}

Nested Schema : links

Type: array

List of related resource links.

Show Source

• Array of: object EmbedScriptResourceLink
  List of related resource links.

{
    "type":"array",
    "description":"List of related resource links.",
    "items":{
        "$ref":"#/components/schemas/EmbedScriptResourceLink"
    }
}

Nested Schema : EmbedScriptResourceLink

Type: object

List of related resource links.

Show Source

• href(required): string
  URL of the resource.
• rel(required): string
  Relationship of the link to the current resource.

{
    "required":[
        "href",
        "rel"
    ],
    "type":"object",
    "properties":{
        "rel":{
            "type":"string",
            "description":"Relationship of the link to the current resource."
        },
        "href":{
            "type":"string",
            "description":"URL of the resource."
        }
    },
    "description":"List of related resource links."
}

Back to Top

Examples

The following example gets information about the available versions of the REST API for Embedded Python Execution.

curl -i -X GET --header "Authorization: Bearer ${token}" \
--header 'Accept: application/json' \
"<oml-cloud-service-location-url>/oml/api/py-scripts"

Response Headers

The response headers are the following:

HTTP/1.1 200 OK
Date: Thu, 20 Aug 2020 14:49:43 GMT
Content-Type: application/json
Content-Length: 1774
Connection: keep-alive
Cache-Control: no-cache, no-store, private
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1;mode=block
Strict-Transport-Security: max-age=31536000; includeSubDomains
X-Content-Type-Options: nosniff

Response Body

The response body in JSON format is the following:

{"items":[
{"isLatest":true,
"lifecycle":"ACTIVE",
"links":[
  {"href":"https://<oml-cloud-service-location-url>/oml/tenants/MYTENANT/databases/MYADW/api/py-scripts/v1","rel":"self"},
  {"href":"https://<oml-cloud-service-location-url>/oml/tenants/MYTENANT/databases/MYADW/api/py-scripts/v1/scripts","rel":"child"},
  {"href":"https://<oml-cloud-service-location-url>/oml/tenants/MYTENANT/databases/MYADW/api/py-scripts/v1/do-eval/{scriptName}","rel":"child"},
  {"href":"https://<oml-cloud-service-location-url>/oml/tenants/MYTENANT/databases/MYADW/api/py-scripts/v1/do-eval/{scriptName}/{ownerName}","rel":"child"},
  {"href":"https://<oml-cloud-service-location-url>/oml/tenants/MYTENANT/databases/MYADW/api/py-scripts/v1/table-apply/{scriptName}","rel":"child"},
  {"href":"https://<oml-cloud-service-location-url>/oml/tenants/MYTENANT/databases/MYADW/api/py-scripts/v1/table-apply/{scriptName}/{ownerName}","rel":"child"},
  {"href":"https://<oml-cloud-service-location-url>/oml/tenants/MYTENANT/databases/MYADW/api/py-scripts/v1/row-apply/{scriptName}","rel":"child"},
  {"href":"https://<oml-cloud-service-location-url>/oml/tenants/MYTENANT/databases/MYADW/api/py-scripts/v1/row-apply/{scriptName}/{ownerName}","rel":"child"},
  {"href":"https://<oml-cloud-service-location-url>/oml/tenants/MYTENANT/databases/MYADW/api/py-scripts/v1/index-apply/{scriptName}","rel":"child"},
  {"href":"https://<oml-cloud-service-location-url>/oml/tenants/MYTENANT/databases/MYADW/api/py-scripts/v1/index-apply/{scriptName}/{ownerName}","rel":"child"},
  {"href":"https://<oml-cloud-service-location-url>/oml/tenants/MYTENANT/databases/MYADW/api/py-scripts/v1/group-apply/{scriptName}","rel":"child"},
  {"href":"https://<oml-cloud-service-location-url>/oml/tenants/MYTENANT/databases/MYADW/api/py-scripts/v1/group-apply/{scriptName}/{ownerName}","rel":"child"}],
"version":"v1"}],
"links":[
  {"href":"https://<oml-cloud-service-location-url>/oml/tenants/MYTENANT/databases/MYADW/api/py-scripts","rel":"self"},
  {"href":"https://<oml-cloud-service-location-url>/oml/tenants/MYTENANT/databases/MYADW/api/py-scripts/v1","rel":"current"}]}

Back to Top