Jump to

• Request
• Response

Get work shifts associated with the project.

get

/connectedWorker/clientapi/v2/orgs/{orgId}/projects/{projectId}/workShifts

This operation retrieves work shifts associated with the project.

Request

Path Parameters

• orgId: string
  Organization identifier
• projectId: string
  Project identifier

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Work shifts associated with the project were successfully retrieved.

Body ()

Root Schema : ProjectWorkShifts

Type: object

Show Source

• items: array items
• links(optional): array links
  Read Only: true

{
    "required":[
        "items"
    ],
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ProjectWorkShift"
            }
        },
        "links":{
            "type":"array",
            "readOnly":true,
            "items":{
                "$ref":"#/components/schemas/Link"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object ProjectWorkShift

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ProjectWorkShift"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object Link

{
    "type":"array",
    "readOnly":true,
    "items":{
        "$ref":"#/components/schemas/Link"
    }
}

Nested Schema : ProjectWorkShift

Type: object

Show Source

• default(optional): boolean
  Read Only: true

  Flag indicating default work shift in the project

  Example: true
• links(optional): array links
• projectId: string
  Id of the project

  Example: 1
• workShiftId: string
  Id of the work shift

  Example: 2

{
    "required":[
        "projectId",
        "workShiftId"
    ],
    "type":"object",
    "properties":{
        "projectId":{
            "type":"string",
            "description":"Id of the project",
            "example":"1"
        },
        "workShiftId":{
            "type":"string",
            "description":"Id of the work shift",
            "example":"2"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            }
        },
        "default":{
            "type":"boolean",
            "description":"Flag indicating default work shift in the project",
            "readOnly":true,
            "example":true
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Link"
    }
}

Nested Schema : Link

Type: object

Show Source

• href: string
  The target resource's URI
• rel: string
  Relation type

{
    "required":[
        "href",
        "rel"
    ],
    "type":"object",
    "properties":{
        "rel":{
            "type":"string",
            "description":"Relation type"
        },
        "href":{
            "type":"string",
            "description":"The target resource's URI"
        }
    }
}

Back to Top