Execute action

v1.0.0

Executes a registered service action and returns any output from the action. The data returned in the POST response body may be:

the raw action output,
a URL encapsulating the action request which executes the action when dereferenced (only for actions using GET),
RDF generated from the action output,
a URL to an RDF viewer's display of the generated RDF.

Any parameters required by the action are supplied as a JSON object in the POST body. The parameter types supported are: "query", "header", "uri", "path" and "body". The parameter type determines where a supplied parameter value is inserted into the HTTP request constructed by OSDB to invoke the target service action. In addition to native parameters required by the service action, 'Execute action' accepts some OSDB-specific parameters.

Examples

curl -ik -X POST -d '{ "latitude":"37.7759792", "longitude":"-122.41823" }' -H 'Content-Type: application/json' https://osdb.openlinksw.com/osdb/api/v1/actions/uber/products/exec
curl -ikL -X POST -d '{ "latitude":"37.7759792", "longitude":"-122.41823", "osdb:output_type":"generate_rdf", "osdb:response_format":"application/rdf+xml" }' -H 'Content-Type: application/json' https://osdb.openlinksw.com/osdb/api/v1/actions/uber/products/exec
curl -ikL -X POST -d '{ "latitude":"37.7759792", "longitude":"-122.41823", "osdb:output_type":"display_rdf" }' -H 'Content-Type: application/json' https://osdb.openlinksw.com/osdb/api/v1/actions/uber/products/exec
curl -ik -X POST -d '{ "q":"skiing", "osdb:response_format": "application/rdf+xml" }' -H 'Content-Type: application/json' https://osdb.openlinksw.com/osdb/api/v1/actions/facet/search/exec
curl -ik -X POST -d '{ "q":"skiing", "osdb:output_type": "url_only" }' -H 'Content-Type: application/json' https://osdb.openlinksw.com/osdb/api/v1/actions/facet/search/exec
curl -ik -X POST -d '{ "Content-Location": "http://demo.openlinksw.co.uk/pubs", "osdb:body_data_src_url": "http://ods-qa.openlinksw.com/DAV/home/osdb/pubs.csv", "extractor": "csv", "osdb:response_format": "application/rdf+xml", "osdb:body_data_encoding": "text/csv" }' -H 'Content-Type: application/json' https://osdb.openlinksw.com/osdb/api/v1/actions/csv_transformer/transform/exec

Input

{
  "type": "object",
  "properties": {
    "actionId": {
      "type": "string"
    },
    "action_specific_property1": {
      "type": "string",
      "description": "An example action specific property. There may be 0, 1 or more action specific properties, each holding an action specific parameter value."
    },
    "action_specific_property2": {
      "type": "string",
      "description": "An example action specific property. There may be 0, 1 or more action specific properties, each holding an action specific parameter value."
    },
    "osdb:body_data_encoding": {
      "type": "string",
      "description": "The media type of the data associated with osdb:body_data_raw or osdb:body_data_src_url. In the case of osdb:body_data_raw, this is the media type before base64 encoding."
    },
    "osdb:body_data_raw": {
      "type": "string",
      "format": "byte",
      "description": "Input data for the action (e.g. CSV data). The data must be base64 encoded by the client. Alternatively, clients can use osdb:body_data_src_url to supply the input data via a web-accessible document."
    },
    "osdb:body_data_src_url": {
      "type": "string",
      "format": "uri",
      "description": "URL of a resource containing input data for the action (e.g. CSV data). Clients can instead use osdb:body_data_raw to supply the input data directly."
    },
    "osdb:output_type": {
      "type": "string",
      "description": "An OSDB-specific parameter controlling the action output type. If omitted, the native action output is returned.",
      "enum": [
        "url_only",
        "generate_rdf",
        "display_rdf"
      ]
    },
    "osdb:response_format": {
      "type": "string",
      "description": "Preferred response MIME type. This must be an output MIME type supported natively by the action or, if 'osdb:output_type' is set to 'generate_rdf', a Virtuoso Sponger output format. i.e. 'application/ld+json', 'text/turtle' or 'application/rdf+xml'."
    },
    "serviceId": {
      "type": "string"
    }
  },
  "required": [
    "actionId",
    "serviceId"
  ],
  "additionalProperties": false
}

Output

{
  "type": "object",
  "additionalProperties": true
}