Skip to main content

Get a production stream

GET 

/api/production-streams/{id}

warning

Requires Streams to be enabled in company settings.

Required permissions:

  • pipeline.view: allows view resources of projects where the user is the PM or the Account.
  • pipeline.view_other: allows view resources of projects where the user is not the PM nor the Account.

Request

Path Parameters

    id integerrequired

    Possible values: Value must match regular expression [0-9]+

    The ID of the production stream to view

Query Parameters

    deleted string

    Possible values: [exclude, include, only]

    Default value: exclude

    Filter items by deletion status.

    Examples:

    Exclude soft-deleted records.

    Example: exclude

Header Parameters

    Wethod-Company stringrequired

    The company you want to interact with

    Wethod-Version stringrequired

    The API version you want to use

Responses

Returns the requested production stream.

Schema

    id integerrequired

    Possible values: >= 1

    The unique identifier of the resource

    created_at date-timerequired

    The date and time when the resource was created

    updated_at date-timerequired

    The date and time when the resource was last updated

    date daterequired

    The first day of week of the production stream

    value floatrequired

    The value of production stream

    project_id integerrequired

    Possible values: >= 1

    ID of the project related to this production stream

    production_id integerrequired

    Possible values: >= 1

    ID of the production related to this production stream

    stream_id integerrequired

    Possible values: >= 1

    ID of the stream related to this production stream

    deleted_at date-time

    The date and time when the resource was deleted

Loading...