Report extension

1

Actor(s):

User.

2

Preconditions:

User has a valid token to access the API.

3

Alternative Flow (Incorrect login attempt):

User provides the incorrect token in the authorization header and executes the API call.

The API returns 401 Unauthorized Error.

User contacts support to trouble shoot this error.

4

Postconditions:

Successful response in shown from the API.

Generate report extension package based on taxonomy metadata and taxonomy extension elements (extension linkroles, extension concepts, extension arcs, extension labels and extension references), instance data (language, entity identifier, entity scheme, unit, period, decimals and data rows) and package metadata (name, identifier, description, version, report package language, publisher, publisher uri, publisher country, report package name, report base64 content, report name, entrypoint, base64 zip files, base64 report package json). For each of the functionality where in our API is produced result file we produce hash of the file that identifies the contents of the file. User can validate the hash value in hash validation functionality and to know if any changes are applied. By default the file hash is disabled, but it can be controlled from the dropdown below.

Web Api V1

Web Api V2

Exceptions:

401 unauthorized

404 Bad Request

200 Success