Reports.get

Returns Report with given id

Responses

🟢200OK

application/json

Report data

Body

success

boolean

optional

True when response succeeded, false on error.

Example:

true

data

object (Report)

optional

is_delete_protected

boolean

read-onlyrequired

Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.

Example:

false

string <uuid>

read-onlyrequired

Unique identifier of entity.

Example:

01234567-abcd-dcba-ffff-000000000000

is_deleted

boolean

read-onlyoptional

Specifies if the entity is considered deleted.

Example:

false

modified

string <date-time>

read-onlyoptional

Last modification time.

Example:

2019-01-01T00:00:00

created

string <date-time>

read-onlyoptional

Creation time.

Example:

2019-01-01T00:00:00

owner

string <uri>

required

Relation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties.

reports_folder

string <uri>

required

Relation to ReportFolder. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ReportFolder' object for properties.

access_link

string

optional

Simple text input field.

Example:

string

ai_conversation

object

optional

Field containing json.

description

string

optional

Multi-line text input field.

Example:

string

name

string

required

Name of the entity and its default text representation.

Example:

string

owner_id

string <uuid>

required

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

reports_folder_id

string <uuid>

required

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

settings

object

required

Form definition in json format.

share_mode

enum<integer>

optional

Integer enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit

Allowed values:

0123

Example:

share_mode_params

enum<string>

optional

Bit Flag field, with limited combination of integer values.

Options:
ShareToUnitManagers = 1 (0b01)
ShareToIncludedUsers = 2 (0b10)

Allowed values:

Example:

type

enum<integer>

required

Integer enum value: 0 - TableReport, 1 - DashboardReport, 2 - ForecastReport, 3 - AdvancedReport

Allowed values:

0123

Example:

revision

integer <int32>

optional

Revision when entity was lastly changed.

Example:

schedule

string <uri>

optional

Relation to ReportSchedule. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ReportSchedule' object for properties.

is_favorite

boolean

required

Example:

false

sharing_units

array[string <uri>]

optional

Relations to SalesUnits.

sharing_clients

array[string <uri>]

optional

Relations to Clients.

Example

{
    "success": true,
    "data": {
        "is_delete_protected": false,
        "id": "01234567-abcd-dcba-ffff-000000000000",
        "is_deleted": false,
        "modified": "2019-01-01T00:00:00",
        "created": "2019-01-01T00:00:00",
        "owner": "http://example.com",
        "reports_folder": "http://example.com",
        "access_link": "string",
        "ai_conversation": {},
        "description": "string",
        "name": "string",
        "owner_id": "01234567-abcd-dcba-ffff-000000000000",
        "reports_folder_id": "01234567-abcd-dcba-ffff-000000000000",
        "settings": {},
        "share_mode": 0,
        "share_mode_params": 1,
        "type": 0,
        "revision": 1,
        "schedule": "http://example.com",
        "is_favorite": false,
        "sharing_units": [
            "http://example.com"
        ],
        "sharing_clients": [
            "http://example.com"
        ]
    }
}

🟠404Record Not Found

🔴500Server Error

Request

Request samples

Responses