REST API for Oracle Analytics Server

Run a sequence

post

/api/20210901/catalog/sequences/{sequenceId}/actions/run

Run an existing sequence with a given id. Returns an oa-work-request-id so you can monitor progress.

Request

Path Parameters

sequenceId(required): string(byte)

The object ID of the sequence with Base64URL encoding. For example, if your sequence has the object ID 'User1'.'sequence1', enter the Base64URL encoded value, J1VzZXIxJy4nc2VxdWVuY2UxJw==.

There's no request body for this operation.

Response

202 Response

Asynchronous operation started.

Headers

oa-work-request-id:

400 Response

Bad Request (invalid query parameters, malformed headers, and so on).

Root Schema : Error

Type: object

Show Source

code(required): string

Short error code that defines the error, meant for programmatic parsing.
message(required): string

Human-readable error string.

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Short error code that defines the error, meant for programmatic parsing.\n"
        },
        "message":{
            "type":"string",
            "description":"Human-readable error string.\n"
        }
    },
    "required":[
        "code",
        "message"
    ]
}

403 Response

Forbidden (missing permissions for operation, request denied for unspecified reason, and so on).

Root Schema : Error

Type: object

Show Source

code(required): string

Short error code that defines the error, meant for programmatic parsing.
message(required): string

Human-readable error string.

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Short error code that defines the error, meant for programmatic parsing.\n"
        },
        "message":{
            "type":"string",
            "description":"Human-readable error string.\n"
        }
    },
    "required":[
        "code",
        "message"
    ]
}

404 Response

Not Found. The requested resource was not found.

Root Schema : Error

Type: object

Show Source

code(required): string

Short error code that defines the error, meant for programmatic parsing.
message(required): string

Human-readable error string.

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Short error code that defines the error, meant for programmatic parsing.\n"
        },
        "message":{
            "type":"string",
            "description":"Human-readable error string.\n"
        }
    },
    "required":[
        "code",
        "message"
    ]
}

409 Response

Conflict (operation results in constraint violation, the operation is incompatible with the current state, and so on).

Root Schema : Error

Type: object

Show Source

code(required): string

Short error code that defines the error, meant for programmatic parsing.
message(required): string

Human-readable error string.

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Short error code that defines the error, meant for programmatic parsing.\n"
        },
        "message":{
            "type":"string",
            "description":"Human-readable error string.\n"
        }
    },
    "required":[
        "code",
        "message"
    ]
}

500 Response

Internal Server Error. The server encountered an unexpected condition preventing fulfilment of the request.

Root Schema : Error

Type: object

Show Source

code(required): string

Short error code that defines the error, meant for programmatic parsing.
message(required): string

Human-readable error string.

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Short error code that defines the error, meant for programmatic parsing.\n"
        },
        "message":{
            "type":"string",
            "description":"Human-readable error string.\n"
        }
    },
    "required":[
        "code",
        "message"
    ]
}

Examples

In this example, you run a sequence with a given sequenceID. The object ID of the sequence is 'adminuser'.'mySequence' which has the Base64URL-safe encoded sequenceID value: J2FkbWludXNlcicuJ215U2VxdWVuY2Un

cURL Example:

First, obtain the object ID of the data flow you want to run and Base64URL-safe encode this value to determine the dataFlowID. You can obtain the Object ID value from the Inspect dialog for data flow in your Oracle Analytics instance.

Run the cURL command with the required sequenceID:

curl -i \
     --header 'Authorization: Bearer <token>' \
     --header 'Content-Type: application/json' \
     --request POST 'https://<hostname>/api/20210901/catalog/sequences/J2FkbWludXNlcicuJ215U2VxdWVuY2Un/actions/run' \

Example of Request Body

Not applicable.

Example of Response Body

Status 200: