Jump to

• Request
• Response
• Examples

Reload data for a dataset

post

/api/20210901/catalog/datasets/{datasetId}/actions/reload

Reload the data for an existing dataset with a given id. The dataset must be based on a connection and the data access mode of at least one table must be set to Automatic Caching. You can't use the reload dataset API to reload a file-based dataset (Excel, CSV, TXT); you must reload files manually. Returns an oa-work-request-id so you can monitor progress.

Request

Path Parameters

• datasetId(required): string(byte)
  The object ID of the dataset with Base64 encoding. For example, if your dataset has the object ID 'Admin'.'dataSet124', enter the Base64 encoded value, J0FkbWluJy4nZGF0YVNldDEyNCc.

There's no request body for this operation.

Back to Top

Response

202 Response

Asynchronous operation started.

Headers

• oa-work-request-id:

400 Response

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

Body ()

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).

Body ()

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.

Body ()

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).

Body ()

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.

Body ()

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

Back to Top

Examples

In this example, you reload data for a dataset with the object ID 'User1'.'Dataset1'. First, Base64 encode the object ID 'User1'.'Dataset1' and then use the encoded value J1VzZXIxJy4nRGF0YXNldDEn to specify the datasetId.

cURL Example

curl -i \
  --header 'Authorization: Bearer <token>' \
  --request POST 'https://<hostname>/api/20210901/catalog/datasets/J1VzZXIxJy4nRGF0YXNldDEn/actions/reload'

Example of Request Body

Not applicable.

Example of Response Status

202

Example of Response Header

Make a note of the oa-work-request-id in the response header. You can use this value to track the status of your operation.

oa-work-request-id: bidr-1E309E468A4518E149438E31294EB54

Example of Response Body

Not applicable.

Back to Top