Jump to

• Request
• Response
• Examples

Retrieve metadata of version 1

get

/api/py-scripts/v1

Returns metadata describing version 1 of the Script Execution APIs.

Request

There are no request parameters for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Metadata describing version 1 of the API.

Body ()

Root Schema : EmbedScriptApiVersion

Type: object

Show Source

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

  Lifecycle of the version.
• links(optional): array links
  List of related resource links.
• version(optional): 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":"#/definitions/EmbedScriptResourceLink"
            }
        }
    }
}

Nested Schema : links

Type: array

List of related resource links.

Show Source

• Array of: object EmbedScriptResourceLink

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

Nested Schema : EmbedScriptResourceLink

Type: object

Show Source

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

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

Back to Top

Examples

The following example gets information about version 1 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/v1"

Response Headers

The response headers are the following:

HTTP/1.1 200 OK
Date: Thu, 20 Aug 2020 14:52:38 GMT
Content-Type: application/json
Content-Length: 1556
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:

{"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"}

Back to Top