Retrieve metadata of available versions
get
/api/r-scripts
Returns metadata describing all available versions of the Script Execution APIs.
Request
There are no request parameters for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
A list of all available versions.
Root Schema : EmbedScriptApiMetadata
Type:
Show Source
object
-
items:
array items
Collection of version resources.
-
links:
array links
List of related resource links.
Nested Schema : EmbedScriptApiVersion
Type:
Show Source
object
-
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.
Nested Schema : EmbedScriptResourceLink
Type:
Show Source
object
-
href(required):
string
URL of the resource.
-
rel(required):
string
Relationship of the link to the current resource.
Examples
The following example gets information about the available versions of the REST API for Embedded R Execution.
curl -i -X GET --header "Authorization: Bearer ${token}" \
--header 'Accept: application/json' \
"<oml-cloud-service-location-url>/oml/api/r-scripts"
Response Headers
The response headers are the following:
HTTP/1.1 200 OK
Date: Thu, 28 Jul 2022 21:04:18 GMT
Content-Type: application/json
Content-Length: 1820
Connection: keep-alive
Cache-Control: no-cache, no-store, must-revalidate
Pragma: no-cache
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1;mode=block
Strict-Transport-Security: max-age=31536000; includeSubDomains
X-Content-Type-Options: nosniff
Content-Security-Policy: frame-ancestors 'none'
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/api/r-scripts/v1","rel":"self"},
{"href":"https://<oml-cloud-service-location-url>/oml/api/r-scripts/v1/scripts","rel":"child"},
{"href":"https://<oml-cloud-service-location-url>/oml/api/r-scripts/v1/do-eval/{scriptName}","rel":"child"},
{"href":"https://<oml-cloud-service-location-url>/oml/api/r-scripts/v1/do-eval/{scriptName}/{ownerName}","rel":"child"},
{"href":"https://<oml-cloud-service-location-url>/oml/api/r-scripts/v1/table-apply/{scriptName}","rel":"child"},
{"href":"https://<oml-cloud-service-location-url>/oml/api/r-scripts/v1/table-apply/{scriptName}/{ownerName}","rel":"child"},
{"href":"https://<oml-cloud-service-location-url>/oml/api/r-scripts/v1/row-apply/{scriptName}","rel":"child"},
{"href":"https://<oml-cloud-service-location-url>/oml/api/r-scripts/v1/row-apply/{scriptName}/{ownerName}","rel":"child"},
{"href":"https://<oml-cloud-service-location-url>/oml/api/r-scripts/v1/index-apply/{scriptName}","rel":"child"},
{"href":"https://<oml-cloud-service-location-url>/oml/api/r-scripts/v1/index-apply/{scriptName}/{ownerName}","rel":"child"},
{"href":"https://<oml-cloud-service-location-url>/oml/api/r-scripts/v1/group-apply/{scriptName}","rel":"child"},
{"href":"https://<oml-cloud-service-location-url>/oml/api/r-scripts/v1/group-apply/{scriptName}/{ownerName}","rel":"child"}],
"version":"v1"}],
"links":[
{"href":"https://<oml-cloud-service-location-url>/oml/api/r-scripts","rel":"self"},
{"href":"https://<oml-cloud-service-location-url>/oml/api/r-scripts/v1","rel":"current"}]}