Jump to

• Request
• Response

Get employees affected by the given incident.

get

/connectedWorker/clientapi/v2/orgs/{orgId}/incidents/{incidentId}/employees

This operation retrieves the details of employees affected by a specific incident.

Request

Path Parameters

• incidentId: string
  Incident identifier
• orgId: string
  Organization identifier

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Affected employees were successfully retrieved.

Body ()

Root Schema : Employees

Type: object

Show Source

• items: array items
• links(optional): array links

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

Nested Schema : items

Type: array

Show Source

• Array of: object Employee

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

Nested Schema : links

Type: array

Show Source

• Array of: object Link

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

Nested Schema : Employee

Type: object

Show Source

• activeOrganizationId(optional): string
  Read Only: true

  Id of an organization where employee has active project assignment

  Example: 50
• activeProjectId(optional): string
  Read Only: true

  Id of a project where employee is currently checked-in

  Example: 51
• deletedTime(optional): string(date-time)
  Read Only: true

  Date and time the employee wes deleted from IDCS. This field occurs only if not null.
• email: string
  Minimum Length: 5

  Maximum Length: 100

  Email of employee

  Example: [e-mail]
• firstName: string
  Minimum Length: 0

  Maximum Length: 100

  First name of employee, cannot be blank

  Example: John
• id(optional): string
  Read Only: true

  The gid of the employee

  Example: 1234
• idcsStatus(optional): string
  Read Only: true

  Status of the employee in IDCS

  Example: ACTIVE
• lastName: string
  Minimum Length: 0

  Maximum Length: 100

  Last name of employee, cannot be blank

  Example: Smith
• links(optional): array links
• role: string
  Allowed Values: [ "PROJECT_MANAGER", "SUPERVISOR", "WORKER" ]
• timeZone(optional): string
  Read Only: true

  Time zone where employee is currently in

  Example: Europe/Paris
• upCWRegisteredEmployee(optional): object Employee
• upIDCSFields(optional): object IDCSIoTUser
• username: string
  Minimum Length: 3

  Maximum Length: 100

  Username of employee, cannot be blank

  Example: jsmith
• workShiftId(optional): string
  Read Only: true

  Id of a work shift that employee is currently working on

  Example: 52

{
    "required":[
        "email",
        "firstName",
        "lastName",
        "role",
        "username"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The gid of the employee",
            "readOnly":true,
            "example":"1234"
        },
        "username":{
            "maxLength":100,
            "minLength":3,
            "type":"string",
            "description":"Username of employee, cannot be blank",
            "example":"jsmith"
        },
        "firstName":{
            "maxLength":100,
            "minLength":0,
            "type":"string",
            "description":"First name of employee, cannot be blank",
            "example":"John"
        },
        "lastName":{
            "maxLength":100,
            "minLength":0,
            "type":"string",
            "description":"Last name of employee, cannot be blank",
            "example":"Smith"
        },
        "email":{
            "maxLength":100,
            "minLength":5,
            "type":"string",
            "description":"Email of employee",
            "example":"[e-mail]"
        },
        "timeZone":{
            "type":"string",
            "description":"Time zone where employee is currently in",
            "readOnly":true,
            "example":"Europe/Paris"
        },
        "role":{
            "type":"string",
            "enum":[
                "PROJECT_MANAGER",
                "SUPERVISOR",
                "WORKER"
            ]
        },
        "idcsStatus":{
            "type":"string",
            "description":"Status of the employee in IDCS",
            "readOnly":true,
            "example":"ACTIVE"
        },
        "deletedTime":{
            "type":"string",
            "description":"Date and time the employee wes deleted from IDCS. This field occurs only if not null.",
            "format":"date-time",
            "readOnly":true
        },
        "activeProjectId":{
            "type":"string",
            "description":"Id of a project where employee is currently checked-in",
            "readOnly":true,
            "example":"51"
        },
        "activeOrganizationId":{
            "type":"string",
            "description":"Id of an organization where employee has active project assignment",
            "readOnly":true,
            "example":"50"
        },
        "workShiftId":{
            "type":"string",
            "description":"Id of a work shift that employee is currently working on",
            "readOnly":true,
            "example":"52"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            }
        },
        "upCWRegisteredEmployee":{
            "$ref":"#/components/schemas/Employee"
        },
        "upIDCSFields":{
            "$ref":"#/components/schemas/IDCSIoTUser"
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link

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

Nested Schema : IDCSIoTUser

Type: object

Show Source

• emailAddresses(optional): array emailAddresses
  Unique Items Required: true
• firstName(optional): string
• id(optional): string
• internalUser(optional): boolean
• lastName(optional): string
• name(optional): string
• phoneNumbers(optional): array phoneNumbers
  Unique Items Required: true
• roles(optional): array roles
  Unique Items Required: true

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "firstName":{
            "type":"string"
        },
        "lastName":{
            "type":"string"
        },
        "roles":{
            "uniqueItems":true,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "internalUser":{
            "type":"boolean"
        },
        "phoneNumbers":{
            "uniqueItems":true,
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/IDCSIoTUserPhone"
            }
        },
        "emailAddresses":{
            "uniqueItems":true,
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/IDCSIoTUserEmail"
            }
        },
        "name":{
            "type":"string"
        }
    }
}

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"
        }
    }
}

Nested Schema : emailAddresses

Type: array

Unique Items Required: true

Show Source

• Array of: object IDCSIoTUserEmail

{
    "uniqueItems":true,
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/IDCSIoTUserEmail"
    }
}

Nested Schema : phoneNumbers

Type: array

Unique Items Required: true

Show Source

• Array of: object IDCSIoTUserPhone

{
    "uniqueItems":true,
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/IDCSIoTUserPhone"
    }
}

Nested Schema : roles

Type: array

Unique Items Required: true

Show Source

• Array of: string

{
    "uniqueItems":true,
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : IDCSIoTUserEmail

Type: object

Show Source

• primary(optional): boolean
• type(optional): string
  Allowed Values: [ "WORK", "HOME", "RECOVERY", "OTHER" ]
• value(optional): string
• verified(optional): boolean

{
    "type":"object",
    "properties":{
        "primary":{
            "type":"boolean"
        },
        "verified":{
            "type":"boolean"
        },
        "value":{
            "type":"string"
        },
        "type":{
            "type":"string",
            "enum":[
                "WORK",
                "HOME",
                "RECOVERY",
                "OTHER"
            ]
        }
    }
}

Nested Schema : IDCSIoTUserPhone

Type: object

Show Source

• primary(optional): boolean
• type(optional): string
  Allowed Values: [ "WORK", "HOME", "RECOVERY", "OTHER", "MOBILE", "FAX", "PAGER" ]
• value(optional): string
• verified(optional): boolean

{
    "type":"object",
    "properties":{
        "primary":{
            "type":"boolean"
        },
        "verified":{
            "type":"boolean"
        },
        "value":{
            "type":"string"
        },
        "type":{
            "type":"string",
            "enum":[
                "WORK",
                "HOME",
                "RECOVERY",
                "OTHER",
                "MOBILE",
                "FAX",
                "PAGER"
            ]
        }
    }
}

Back to Top