Jump to

• Request
• Response

Get details of a project - work shift association

get

/connectedWorker/clientapi/v2/projects/{projectId}/workShifts/{workShiftId}

This operation retrieves the details of a project - work shift association

Request

Path Parameters

• projectId: integer(int64)
  Project identifier
• workShiftId: integer(int64)
  Work shift identifier

Back to Top

Response

Supported Media Types

• application/json

200 Response

Project - work shift association was successfully retrieved

Body ()

Root Schema : ProjectWorkShift

Type: object

Show Source

• is_default(optional): boolean
  Default Value: false

  Flag indicating default work shift in the project

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

  Example: 1
• workShiftId: integer(int64)
  Id of the work shift

  Example: 2

{
    "type":"object",
    "required":[
        "projectId",
        "workShiftId"
    ],
    "properties":{
        "projectId":{
            "type":"integer",
            "format":"int64",
            "example":1,
            "description":"Id of the project"
        },
        "workShiftId":{
            "type":"integer",
            "format":"int64",
            "example":2,
            "description":"Id of the work shift"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "is_default":{
            "type":"boolean",
            "example":true,
            "description":"Flag indicating default work shift in the project",
            "default":false
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link

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

Nested Schema : Link

Type: object

Show Source

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

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

Back to Top