Jump to

• Request
• Response

Get project assignments.

get

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

This operation retrieves employee-project assignments within the given 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

Project assignments were successfully retrieved.

Body ()

Root Schema : ProjectAssignments

Type: object

Show Source

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

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

Nested Schema : items

Type: array

Show Source

• Array of: object Discriminator: role
  Discriminator: { "propertyName":"role" }

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

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 : Discriminator: role

Type: object

{
    "required":[
        "employeeId",
        "role"
    ],
    "type":"object",
    "properties":{
        "employeeId":{
            "type":"string",
            "description":"Identifier of the employee within the project assignment",
            "example":"johnSmith"
        },
        "role":{
            "type":"string",
            "enum":[
                "PROJECT_MANAGER",
                "SUPERVISOR",
                "WORKER"
            ]
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            }
        }
    },
    "discriminator":{
        "propertyName":"role"
    }
}

Show Source

• employeeId: string
  Identifier of the employee within the project assignment

  Example: johnSmith
• links(optional): array links
• role: string
  Allowed Values: [ "PROJECT_MANAGER", "SUPERVISOR", "WORKER" ]

{
    "required":[
        "employeeId",
        "role"
    ],
    "type":"object",
    "properties":{
        "employeeId":{
            "type":"string",
            "description":"Identifier of the employee within the project assignment",
            "example":"johnSmith"
        },
        "role":{
            "type":"string",
            "enum":[
                "PROJECT_MANAGER",
                "SUPERVISOR",
                "WORKER"
            ]
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            }
        }
    },
    "discriminator":{
        "propertyName":"role"
    }
}

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