Forecasts.get

Returns Forecast with given id

Responses

🟢200OK

application/json

Forecast data

Body

success

boolean

optional

True when response succeeded, false on error.

Example:

true

data

object (Forecast)

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

field

string <uri>

read-onlyrequired

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

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.

pipeline

string <uri>

read-onlyrequired

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

description

string

optional

Multi-line text input field.

Example:

string

end_date

string <date>

read-onlyrequired

Date information.

Example:

2019-01-01

field_id

string <uuid>

read-onlyrequired

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

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

pipeline_id

string <uuid>

read-onlyrequired

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

settings

object

required

Field containing json.

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:

start_date

string <date>

read-onlyrequired

Date information.

Example:

2019-01-01

type

object

read-onlyrequired

Field containing json.

revision

integer <int32>

optional

Revision when entity was lastly changed.

Example:

shared_clients

array[string <uri>]

required

shared_units

array[string <uri>]

required

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",
    "field": "http://example.com",
    "owner": "http://example.com",
    "pipeline": "http://example.com",
    "description": "string",
    "end_date": "2019-01-01",
    "field_id": "01234567-abcd-dcba-ffff-000000000000",
    "name": "string",
    "owner_id": "01234567-abcd-dcba-ffff-000000000000",
    "pipeline_id": "01234567-abcd-dcba-ffff-000000000000",
    "settings": {},
    "share_mode": 0,
    "share_mode_params": 1,
    "start_date": "2019-01-01",
    "type": {},
    "revision": 1,
    "shared_clients": [
      "http://example.com"
    ],
    "shared_units": [
      "http://example.com"
    ]
  }
}

🟠404Record Not Found

🔴500Server Error

Request

Request samples

Responses