Jump to

• Request
• Response

List Out Of Office Records

get

/process/api/v1/user-configurations/out-of-office

Lists all the Out Of Office records for the current user sorted by start date and descending.

Request

Query Parameters

• limit: integer(int32)
  Maximum Value: 25

  The number of items to return. If parameter is omitted default value 25 is set. If limit <=0 or limit> 25 then upto 25 records are returned

  Default Value: 25
• offset: integer(int32)
  0 based index. The number of items to skip before starting to collect the result set.

  Default Value: 0
• totalResults: boolean
  If true return total count of records for given query with filters

  Default Value: false
• userId: string
  The id of the user for whom Out Of Office configurations needs to be fetched. An optional paramater, can be used by admin user to get the Out Of Office configuration of other users.

Header Parameters

• Accept-Language:
  Accept-Language header in IETF BCP 47
• oci-original-url:
  Actual endpoint which customer requested

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : OutOfOfficeConfigurations

Type: object

Match All

Show Source

• object CommonModel
• object PaginationResponse
  Pagination details
• object OutOfOfficeConfigurations-allOf[2]

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/CommonModel"
        },
        {
            "$ref":"#/components/schemas/PaginationResponse"
        },
        {
            "properties":{
                "user":{
                    "$ref":"#/components/schemas/User"
                },
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/OutOfOfficeConfiguration"
                    }
                }
            }
        }
    ]
}

Nested Schema : CommonModel

Type: object

Show Source

• links: array links

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

Nested Schema : PaginationResponse

Type: object

Pagination details

Show Source

• count: integer
  count of items returned in current result
• hasMore: boolean
  whether there are more pages to fetch
• limit: integer
  max size for the paginated response
• offset: integer
  offset for the paginated response
• totalResults: integer
  total count with the applied filter criteria

{
    "description":"Pagination details",
    "properties":{
        "count":{
            "type":"integer",
            "description":"count of items returned in current result"
        },
        "totalResults":{
            "type":"integer",
            "description":"total count with the applied filter criteria"
        },
        "limit":{
            "type":"integer",
            "description":"max size for the paginated response"
        },
        "offset":{
            "type":"integer",
            "description":"offset for the paginated response"
        },
        "hasMore":{
            "type":"boolean",
            "description":"whether there are more pages to fetch"
        }
    }
}

Nested Schema : OutOfOfficeConfigurations-allOf[2]

Type: object

Show Source

• items: array items
• user: User

{
    "properties":{
        "user":{
            "$ref":"#/components/schemas/User"
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/OutOfOfficeConfiguration"
            }
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link
  Defines Link

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

Nested Schema : Link

Type: object

Defines Link

Show Source

• code: integer
  Minimum Value: 100

  Maximum Value: 600
• href(required): string
• hreflang: string
• length: integer (int32)
• mediaType: string
• message: string
• rel(required): string
• title: string
• type: string

{
    "type":"object",
    "description":"Defines Link",
    "additionalProperties":false,
    "required":[
        "href",
        "rel"
    ],
    "properties":{
        "href":{
            "type":"string"
        },
        "hreflang":{
            "type":"string"
        },
        "length":{
            "type":"integer",
            "format":"int32"
        },
        "rel":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "type":{
            "type":"string"
        },
        "mediaType":{
            "type":"string"
        },
        "message":{
            "type":"string"
        },
        "code":{
            "type":"integer",
            "minimum":100,
            "maximum":600
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object OutOfOfficeConfiguration

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

Nested Schema : User

Match All

Show Source

• object IdentityCommon

{
    "allOf":[
        {
            "$ref":"#/components/schemas/IdentityCommon"
        }
    ]
}

Nested Schema : OutOfOfficeConfiguration

Type: object

Show Source

• createdBy: User
• createdDate: string (date)
  The time the Out Of Office was created in the format yyyy-MM-dd'T'HH:mm:ss.
• endDate: string (date)
  The end date of the Out Of Office in the format yyyy-MM-dd'T'HH:mm:ss, Note - Hours, Minutes and Seconds are not supported.
• id: string
• lastUpdatedBy: User
• lastUpdatedDate: string (date)
  The time the Out Of Office was last updated in the format yyyy-MM-dd'T'HH:mm:ss.
• startDate: string (date)
  The start date of the Out Of Office in the format yyyy-MM-dd'T'HH:mm:ss, Note - Hours, Minutes and Seconds are not supported.
• taskAction: array taskAction
  Minimum Number of Items: 1

  Maximum Number of Items: 1

  Current one action is supported.
• user: User

{
    "allOf":[
        {
            "$ref":"#/components/schemas/CommonModel"
        }
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "startDate":{
            "type":"string",
            "description":"The start date of the Out Of Office in the format yyyy-MM-dd'T'HH:mm:ss, Note - Hours, Minutes and Seconds are not supported.",
            "format":"date"
        },
        "endDate":{
            "type":"string",
            "description":"The end date of the Out Of Office in the format yyyy-MM-dd'T'HH:mm:ss, Note - Hours, Minutes and Seconds are not supported.",
            "format":"date"
        },
        "user":{
            "$ref":"#/components/schemas/User"
        },
        "createdBy":{
            "$ref":"#/components/schemas/User"
        },
        "createdDate":{
            "type":"string",
            "description":"The time the Out Of Office was created in the format yyyy-MM-dd'T'HH:mm:ss.",
            "format":"date"
        },
        "lastUpdatedBy":{
            "$ref":"#/components/schemas/User"
        },
        "lastUpdatedDate":{
            "type":"string",
            "description":"The time the Out Of Office was last updated in the format yyyy-MM-dd'T'HH:mm:ss.",
            "format":"date"
        },
        "taskAction":{
            "type":"array",
            "description":"Current one action is supported.",
            "items":{
                "$ref":"#/components/schemas/OutOfOfficeTaskAction"
            },
            "minItems":1,
            "maxItems":1
        }
    }
}

Match All

Show Source

• object CommonModel

{
    "allOf":[
        {
            "$ref":"#/components/schemas/CommonModel"
        }
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "startDate":{
            "type":"string",
            "description":"The start date of the Out Of Office in the format yyyy-MM-dd'T'HH:mm:ss, Note - Hours, Minutes and Seconds are not supported.",
            "format":"date"
        },
        "endDate":{
            "type":"string",
            "description":"The end date of the Out Of Office in the format yyyy-MM-dd'T'HH:mm:ss, Note - Hours, Minutes and Seconds are not supported.",
            "format":"date"
        },
        "user":{
            "$ref":"#/components/schemas/User"
        },
        "createdBy":{
            "$ref":"#/components/schemas/User"
        },
        "createdDate":{
            "type":"string",
            "description":"The time the Out Of Office was created in the format yyyy-MM-dd'T'HH:mm:ss.",
            "format":"date"
        },
        "lastUpdatedBy":{
            "$ref":"#/components/schemas/User"
        },
        "lastUpdatedDate":{
            "type":"string",
            "description":"The time the Out Of Office was last updated in the format yyyy-MM-dd'T'HH:mm:ss.",
            "format":"date"
        },
        "taskAction":{
            "type":"array",
            "description":"Current one action is supported.",
            "items":{
                "$ref":"#/components/schemas/OutOfOfficeTaskAction"
            },
            "minItems":1,
            "maxItems":1
        }
    }
}

Nested Schema : taskAction

Type: array

Minimum Number of Items: 1

Maximum Number of Items: 1

Current one action is supported.

Show Source

• Array of: object OutOfOfficeTaskAction

{
    "type":"array",
    "description":"Current one action is supported.",
    "items":{
        "$ref":"#/components/schemas/OutOfOfficeTaskAction"
    },
    "minItems":1,
    "maxItems":1
}

Nested Schema : OutOfOfficeTaskAction

Type: object

Show Source

• actionType(required): string
  Allowed Values: [ "REASSIGN" ]

  The action needs to be performed during Out Of Office.
• comment(required): string
  The comment for this Out Of Office configuration which will be used for the task action operation at runtime.
• identities(required): array identities
  Minimum Number of Items: 1

  Maximum Number of Items: 1

{
    "type":"object",
    "required":[
        "actionType",
        "comment",
        "identities"
    ],
    "properties":{
        "actionType":{
            "type":"string",
            "enum":[
                "REASSIGN"
            ],
            "description":"The action needs to be performed during Out Of Office."
        },
        "comment":{
            "type":"string",
            "description":"The comment for this Out Of Office configuration which will be used for the task action operation at runtime."
        },
        "identities":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Identity"
            },
            "minItems":1,
            "maxItems":1
        }
    }
}

Nested Schema : identities

Type: array

Minimum Number of Items: 1

Maximum Number of Items: 1

Show Source

• Array of: Identity

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Identity"
    },
    "minItems":1,
    "maxItems":1
}

Nested Schema : Identity

Match All

Show Source

• object IdentityCommon
• object Identity-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/IdentityCommon"
        },
        {
            "type":"object",
            "properties":{
                "type":{
                    "type":"string",
                    "enum":[
                        "USER",
                        "GROUP",
                        "ROLE"
                    ]
                }
            }
        }
    ]
}

Nested Schema : IdentityCommon

Type: object

Show Source

• displayName: string
• id: string
• name: string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "displayName":{
            "type":"string"
        }
    }
}

Nested Schema : Identity-allOf[1]

Type: object

Show Source

• type: string
  Allowed Values: [ "USER", "GROUP", "ROLE" ]

{
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "enum":[
                "USER",
                "GROUP",
                "ROLE"
            ]
        }
    }
}

400 Response

Returned if some of the query parameters are invalid

401 Response

Unauthorized

429 Response

Too Many Requests

500 Response

Internal Server Error

503 Response

Too Many Exceptions or Too Slow Requests

Back to Top