Jump to

• Request
• Response

Creates Out Of Office Record

post

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

Creates an Out Of Office record.

Request

Header Parameters

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

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• endDate(required): string
  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.
• startDate(required): string
  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(required): array taskAction
  Minimum Number of Items: 1

  Maximum Number of Items: 1

  Currently one action is supported.
• user-id: string
  The id of the user for whom Out Of Office need to be created. Its an optional property. It gets honoured only when Admin user try to create Out Of Office for other user.

{
    "type":"object",
    "required":[
        "startDate",
        "endDate",
        "taskAction"
    ],
    "properties":{
        "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."
        },
        "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."
        },
        "user-id":{
            "type":"string",
            "description":"The id of the user for whom Out Of Office need to be created. Its an optional property. It gets honoured only when Admin user try to create Out Of Office for other user."
        },
        "taskAction":{
            "type":"array",
            "description":"Currently 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

Currently one action is supported.

Show Source

• Array of: object OutOfOfficeTaskAction

{
    "type":"array",
    "description":"Currently 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"
            ]
        }
    }
}

Examples

Select an example Create Out of Office Configuration

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root 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 : User

Match All

Show Source

• object IdentityCommon

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

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 : CommonModel

Type: object

Show Source

• links: array links

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

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 : 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 : Identity-allOf[1]

Type: object

Show Source

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

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

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

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