1. REST API for Embedded R Execution
  2. Tasks
  3. Get Version Metadata

Retrieve metadata of version 1

get

/r-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

200 Response

Metadata describing version 1 of the API.
Back to Top

Examples

The following example gets information about version 1 of the REST API for Embedded R Execution .

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

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:

{"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"}
Back to Top