Jump to

• Request
• Response
• Examples

Update a service business unit profile value

patch

/api/boss/data/objects/ora/cxServiceCore/common/v1/serviceBusinessUnits/{serviceBusinessUnits_id}

Request

Path Parameters

• serviceBusinessUnits_id(required): string
  This path parameter maps to the following field defined in the Service Business Units REST resource:
  

  1. optionId: Unique identifier of the service business unit profile value.

Query Parameters

• $effectiveDate: string(date)
  Effective date value in the ISO 8601 date format 'YYYY-MM-DD'. This date is required by business logic to search for effective-dated business objects.

Header Parameters

• If-Match(required): string
  If-Match header is required for PATCH requests if the business object definition has fields with historyType:versionNumber.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Match All

Show Source

• object allOf oraCxServiceCoreCommon.ServiceBusinessUnit_patch-item
• object __busObj_context

{
    "allOf":[
        {
            "$ref":"#/components/schemas/oraCxServiceCoreCommon.ServiceBusinessUnit_patch-item"
        },
        {
            "$ref":"#/components/schemas/__busObj_context"
        }
    ]
}

Nested Schema : oraCxServiceCoreCommon.ServiceBusinessUnit_patch-item

Type: object

Show Source

• enterpriseIdentifier:
• optionId:
• optionShortName:
• profileOptionName:

{
    "allOf":[
        {
            "$ref":"#/components/schemas/oraCxServiceCoreCommon.ServiceBusinessUnit_item"
        },
        {
            "type":"object",
            "properties":{
                "businessUnit":{
                    "oneOf":[
                        {
                            "type":"object",
                            "properties":{
                                "id":{
                                    "$ref":"#/components/schemas/oraErpCoreStructure.BusinessUnit_item-fields/allOf/0/properties/id"
                                },
                                "effectiveStartDate":{
                                    "$ref":"#/components/schemas/oraErpCoreStructure.BusinessUnit_item-fields/allOf/0/properties/effectiveStartDate"
                                },
                                "effectiveEndDate":{
                                    "$ref":"#/components/schemas/oraErpCoreStructure.BusinessUnit_item-fields/allOf/0/properties/effectiveEndDate"
                                }
                            }
                        },
                        {
                            "type":"object",
                            "properties":{
                                "id":{
                                    "$ref":"#/components/schemas/oraErpCoreStructure.BusinessUnit_item-fields/allOf/0/properties/id"
                                }
                            }
                        },
                        {
                            "$ref":"#/components/schemas/__busObj_context"
                        }
                    ]
                }
            }
        }
    ],
    "properties":{
        "optionId":{
            "not":{
            }
        },
        "profileOptionName":{
            "not":{
            }
        },
        "enterpriseIdentifier":{
            "not":{
            }
        },
        "optionShortName":{
            "not":{
            }
        }
    }
}

Match All

Show Source

• allOf oraCxServiceCoreCommon.ServiceBusinessUnit_item
• object oraCxServiceCoreCommon.ServiceBusinessUnit_patch-item-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/oraCxServiceCoreCommon.ServiceBusinessUnit_item"
        },
        {
            "type":"object",
            "properties":{
                "businessUnit":{
                    "oneOf":[
                        {
                            "type":"object",
                            "properties":{
                                "id":{
                                    "$ref":"#/components/schemas/oraErpCoreStructure.BusinessUnit_item-fields/allOf/0/properties/id"
                                },
                                "effectiveStartDate":{
                                    "$ref":"#/components/schemas/oraErpCoreStructure.BusinessUnit_item-fields/allOf/0/properties/effectiveStartDate"
                                },
                                "effectiveEndDate":{
                                    "$ref":"#/components/schemas/oraErpCoreStructure.BusinessUnit_item-fields/allOf/0/properties/effectiveEndDate"
                                }
                            }
                        },
                        {
                            "type":"object",
                            "properties":{
                                "id":{
                                    "$ref":"#/components/schemas/oraErpCoreStructure.BusinessUnit_item-fields/allOf/0/properties/id"
                                }
                            }
                        },
                        {
                            "$ref":"#/components/schemas/__busObj_context"
                        }
                    ]
                }
            }
        }
    ],
    "properties":{
        "optionId":{
            "not":{
            }
        },
        "profileOptionName":{
            "not":{
            }
        },
        "enterpriseIdentifier":{
            "not":{
            }
        },
        "optionShortName":{
            "not":{
            }
        }
    }
}

Nested Schema : oraCxServiceCoreCommon.ServiceBusinessUnit_item

Match All

The service business units resource is used to view, create, and update business unit profile values for service.

Show Source

• object oraCxServiceCoreCommon.ServiceBusinessUnit_item-fields
• object Service Business Unit
  Title: Service Business Unit

  The service business units resource is used to view, create, and update business unit profile values for service.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/oraCxServiceCoreCommon.ServiceBusinessUnit_item-fields"
        },
        {
            "type":"object",
            "title":"Service Business Unit",
            "x-hints":{
                "titlePlural":"Service Business Units",
                "qualifiedTitle":"Service Business Unit",
                "qualifiedTitlePlural":"Service Business Units"
            },
            "description":"The service business units resource is used to view, create, and update business unit profile values for service."
        }
    ]
}

Nested Schema : oraCxServiceCoreCommon.ServiceBusinessUnit_item-fields

Type: object

Show Source

• businessUnit: businessUnit
• createdBy: string
  Title: Created By

  Read Only: true

  The user who created the record.
• enterpriseIdentifier: string (big-integer)
  Title: Enterprise ID

  Identifier of the enterprise for the profile value.
• optionId: string (big-integer)
  Title: Option ID

  Unique identifier of the service business unit profile value.
• optionShortName: string
  Title: Option Short Name

  Short name of the service business unit profile option.
• profileOptionName: profileOptionName
• profileOptionValue: string
  Title: Profile Option Value

  Value assigned to the service business unit profile option.
• siteLevelValueFlag: boolean
  Title: Use Site Level Value

  Indicates whether the site level value should be used.
• timeCreated: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time when the record was created.
• timeUpdated: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time when the record was last updated.
• updatedBy: string
  Title: Last Updated By

  Read Only: true

  The user who last updated the record.

{
    "type":"object",
    "properties":{
        "optionId":{
            "type":"string",
            "format":"big-integer",
            "x-searchable":true,
            "x-sortable":true,
            "title":"Option ID",
            "description":"Unique identifier of the service business unit profile value."
        },
        "profileOptionName":{
            "allOf":[
                {
                    "type":"string",
                    "x-searchable":true,
                    "x-sortable":true,
                    "x-oj":{
                        "transform":{
                            "path":"/cdn/boss/2604.926.260350027/js/transforms/metadata-transformer-jet-plugin.js",
                            "name":"transformEnumExtensions"
                        }
                    },
                    "title":"Profile Option Name",
                    "description":"Name of the service business unit profile option."
                },
                {
                    "$ref":"#/components/schemas/oraCxServiceCoreCommon.ServiceProfileOptionName_enum"
                }
            ]
        },
        "enterpriseIdentifier":{
            "type":"string",
            "format":"big-integer",
            "x-searchable":true,
            "x-sortable":true,
            "title":"Enterprise ID",
            "description":"Identifier of the enterprise for the profile value."
        },
        "profileOptionValue":{
            "type":"string",
            "nullable":true,
            "title":"Profile Option Value",
            "description":"Value assigned to the service business unit profile option."
        },
        "siteLevelValueFlag":{
            "type":"boolean",
            "title":"Use Site Level Value",
            "description":"Indicates whether the site level value should be used."
        },
        "timeCreated":{
            "type":"string",
            "format":"date-time",
            "x-searchable":true,
            "readOnly":true,
            "title":"Creation Date",
            "description":"The date and time when the record was created."
        },
        "createdBy":{
            "type":"string",
            "x-searchable":true,
            "readOnly":true,
            "title":"Created By",
            "description":"The user who created the record."
        },
        "timeUpdated":{
            "type":"string",
            "format":"date-time",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true,
            "title":"Last Updated Date",
            "description":"The date and time when the record was last updated."
        },
        "updatedBy":{
            "type":"string",
            "x-searchable":true,
            "readOnly":true,
            "title":"Last Updated By",
            "description":"The user who last updated the record."
        },
        "optionShortName":{
            "type":"string",
            "title":"Option Short Name",
            "description":"Short name of the service business unit profile option."
        },
        "businessUnit":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/oraErpCoreStructure.BusinessUnit_item-fields"
                },
                {
                    "$ref":"#/components/schemas/__busObj_context"
                },
                {
                    "type":"object",
                    "title":"Business Unit",
                    "description":"Business unit associated with the service business unit profile value.",
                    "x-searchable":true
                }
            ]
        }
    },
    "x-primaryKey":[
        "optionId"
    ]
}

Nested Schema : Service Business Unit

Type: object

Title: Service Business Unit

The service business units resource is used to view, create, and update business unit profile values for service.

Nested Schema : oraCxServiceCoreCommon.ServiceBusinessUnit_patch-item-allOf[1]

Type: object

Show Source

• businessUnit: businessUnit

{
    "type":"object",
    "properties":{
        "businessUnit":{
            "oneOf":[
                {
                    "type":"object",
                    "properties":{
                        "id":{
                            "$ref":"#/components/schemas/oraErpCoreStructure.BusinessUnit_item-fields/allOf/0/properties/id"
                        },
                        "effectiveStartDate":{
                            "$ref":"#/components/schemas/oraErpCoreStructure.BusinessUnit_item-fields/allOf/0/properties/effectiveStartDate"
                        },
                        "effectiveEndDate":{
                            "$ref":"#/components/schemas/oraErpCoreStructure.BusinessUnit_item-fields/allOf/0/properties/effectiveEndDate"
                        }
                    }
                },
                {
                    "type":"object",
                    "properties":{
                        "id":{
                            "$ref":"#/components/schemas/oraErpCoreStructure.BusinessUnit_item-fields/allOf/0/properties/id"
                        }
                    }
                },
                {
                    "$ref":"#/components/schemas/__busObj_context"
                }
            ]
        }
    }
}

Nested Schema : __busObj_context

Type: object

Show Source

• $context: object $context
• $id: string

{
    "type":"object",
    "properties":{
        "$id":{
            "type":"string",
            "x-searchable":true
        },
        "$context":{
            "type":"object",
            "properties":{
                "etag":{
                    "type":"string"
                },
                "links":{
                    "type":"object",
                    "properties":{
                        "$self":{
                            "type":"object",
                            "properties":{
                                "href":{
                                    "type":"string"
                                }
                            }
                        }
                    },
                    "readOnly":true
                }
            }
        }
    }
}

Nested Schema : businessUnit

Match All

Business unit associated with the service business unit profile value.

Show Source

• allOf oraErpCoreStructure.BusinessUnit_item-fields
• object __busObj_context
• object Business Unit
  Title: Business Unit

  Business unit associated with the service business unit profile value.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/oraErpCoreStructure.BusinessUnit_item-fields"
        },
        {
            "$ref":"#/components/schemas/__busObj_context"
        },
        {
            "type":"object",
            "title":"Business Unit",
            "description":"Business unit associated with the service business unit profile value.",
            "x-searchable":true
        }
    ]
}

Nested Schema : profileOptionName

Match All

Name of the service business unit profile option.

Show Source

• string
  Title: Profile Option Name

  Name of the service business unit profile option.
• string
  Allowed Values: [ "ORA_SVC_SR_RESPONSE_TEMPLATE_NAME_ISR", "ORA_SVC_SR_SYSTEM_RESPONSE_TEMPLATE_NAME_ISR", "SVC_HCM_PROD_CATALOG_USAGE", "SVC_ISR_PROD_CATALOG_USAGE", "SVC_OUTBOUND_EMAIL_FROM", "SVC_PROD_CATALOG_USAGE", "SVC_SR_FORWARD_TEMPLATE_NAME", "SVC_SR_RESPONSE_TEMPLATE_NAME", "SVC_SR_RESPONSE_TEMPLATE_NAME_HRD", "SVC_SR_SYSTEM_RESPONSE_TEMPLATE_NAME", "SVC_SR_SYSTEM_RESPONSE_TEMPLATE_NAME_HRD", "SVC_SR_FORWARD_TEMPLATE_NAME_HRD" ]

{
    "allOf":[
        {
            "type":"string",
            "x-searchable":true,
            "x-sortable":true,
            "x-oj":{
                "transform":{
                    "path":"/cdn/boss/2604.926.260350027/js/transforms/metadata-transformer-jet-plugin.js",
                    "name":"transformEnumExtensions"
                }
            },
            "title":"Profile Option Name",
            "description":"Name of the service business unit profile option."
        },
        {
            "$ref":"#/components/schemas/oraCxServiceCoreCommon.ServiceProfileOptionName_enum"
        }
    ]
}

Nested Schema : oraErpCoreStructure.BusinessUnit_item-fields

Match All

Show Source

• object oraErpCoreStructure.BusinessUnit_item-fields-allOf[0]
• allOf oraHcmHrCoreWorkStructures.Organization_abstract-item
• object oraErpCoreStructure.BusinessUnit_item-fields-allOf[2]
• object oraErpCoreStructure.BusinessUnit_item-fields-allOf[3]

{
    "allOf":[
        {
            "type":"object",
            "properties":{
                "id":{
                    "type":"string",
                    "format":"big-integer",
                    "x-searchable":true,
                    "x-sortable":true,
                    "readOnly":true,
                    "title":"Business Unit ID",
                    "description":"The unique identifier of the business unit."
                },
                "effectiveStartDate":{
                    "type":"string",
                    "format":"date",
                    "x-searchable":true,
                    "x-sortable":true,
                    "readOnly":true,
                    "title":"Start Date",
                    "description":"The start date of the date range within which the business unit is effective."
                },
                "effectiveEndDate":{
                    "type":"string",
                    "format":"date",
                    "x-searchable":true,
                    "x-sortable":true,
                    "readOnly":true,
                    "title":"End Date",
                    "description":"The end date of the date range within which the business unit is effective."
                },
                "name":{
                    "type":"string",
                    "x-searchable":true,
                    "x-sortable":true,
                    "readOnly":true,
                    "title":"Business Unit",
                    "description":"The translated name for the business unit."
                }
            }
        },
        {
            "$ref":"#/components/schemas/oraHcmHrCoreWorkStructures.Organization_abstract-item"
        },
        {
            "type":"object",
            "properties":{
                "createdBy":{
                    "title":"Created By",
                    "description":"The user who created the record.",
                    "type":"string"
                },
                "timeCreated":{
                    "title":"Creation Date",
                    "description":"The date and time when the record was created.",
                    "type":"string"
                },
                "updatedBy":{
                    "title":"Last Updated By",
                    "description":"The user who last updated the record.",
                    "type":"string"
                },
                "timeUpdated":{
                    "title":"Last Updated Date",
                    "description":"The date and time when the record was last updated.",
                    "type":"string"
                },
                "code":{
                    "title":"Organization Code",
                    "description":"Code of the organization.",
                    "type":"string"
                },
                "title":{
                    "title":"Title",
                    "description":"Title of the organization.",
                    "type":"string"
                }
            }
        },
        {
            "type":"object",
            "x-documentation":{
                "publishFlag":false
            }
        }
    ]
}

Nested Schema : oraHcmHrCoreWorkStructures.Organization_abstract-item

Match All

Show Source

• object oraHcmHrCoreWorkStructures.Organization_abstract-item-allOf[0]
• object oraHcmHrCoreWorkStructures.OrganizationBase_abstract-item

{
    "allOf":[
        {
            "type":"object",
            "properties":{
            },
            "x-alternateKeys":{
                "altKey":[
                    "id"
                ]
            }
        },
        {
            "$ref":"#/components/schemas/oraHcmHrCoreWorkStructures.OrganizationBase_abstract-item"
        }
    ]
}

Nested Schema : oraErpCoreStructure.BusinessUnit_item-fields-allOf[0]

Type: object

Show Source

• effectiveEndDate: string (date)
  Title: End Date

  Read Only: true

  The end date of the date range within which the business unit is effective.
• effectiveStartDate: string (date)
  Title: Start Date

  Read Only: true

  The start date of the date range within which the business unit is effective.
• id: string (big-integer)
  Title: Business Unit ID

  Read Only: true

  The unique identifier of the business unit.
• name: string
  Title: Business Unit

  Read Only: true

  The translated name for the business unit.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "format":"big-integer",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true,
            "title":"Business Unit ID",
            "description":"The unique identifier of the business unit."
        },
        "effectiveStartDate":{
            "type":"string",
            "format":"date",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true,
            "title":"Start Date",
            "description":"The start date of the date range within which the business unit is effective."
        },
        "effectiveEndDate":{
            "type":"string",
            "format":"date",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true,
            "title":"End Date",
            "description":"The end date of the date range within which the business unit is effective."
        },
        "name":{
            "type":"string",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true,
            "title":"Business Unit",
            "description":"The translated name for the business unit."
        }
    }
}

Nested Schema : oraHcmHrCoreWorkStructures.Organization_abstract-item-allOf[0]

Type: object

Show Source

{
    "type":"object",
    "properties":{
    },
    "x-alternateKeys":{
        "altKey":[
            "id"
        ]
    }
}

Nested Schema : oraHcmHrCoreWorkStructures.OrganizationBase_abstract-item

Type: object

Show Source

• actionOccurrence: actionOccurrence
• code: string
  Read Only: true
• createdBy: string
  Read Only: true
• effectiveEndDate: string (date)
  Read Only: true
• effectiveStartDate: string (date)
  Read Only: true
• id: string (big-integer)
  Read Only: true
• location: location
• name: string
  Read Only: true
• timeCreated: string (date-time)
  Read Only: true
• timeUpdated: string (date-time)
  Read Only: true
• title: string
  Read Only: true
• updatedBy: string
  Read Only: true

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "format":"big-integer",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true
        },
        "effectiveStartDate":{
            "type":"string",
            "format":"date",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true
        },
        "effectiveEndDate":{
            "type":"string",
            "format":"date",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true
        },
        "createdBy":{
            "type":"string",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true
        },
        "timeCreated":{
            "type":"string",
            "format":"date-time",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true
        },
        "updatedBy":{
            "type":"string",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true
        },
        "timeUpdated":{
            "type":"string",
            "format":"date-time",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true
        },
        "code":{
            "type":"string",
            "nullable":true,
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true
        },
        "name":{
            "type":"string",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true
        },
        "title":{
            "type":"string",
            "nullable":true,
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true
        },
        "location":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/oraHcmHrCoreWorkStructures.Location_item-fields"
                },
                {
                    "$ref":"#/components/schemas/__busObj_context"
                },
                {
                    "type":"object",
                    "title":"Location",
                    "description":"Location accessor for the organization.",
                    "x-searchable":true
                }
            ]
        },
        "actionOccurrence":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/oraHcmHrCoreEmployment.ActionOccurrence_item-fields"
                },
                {
                    "$ref":"#/components/schemas/__busObj_context"
                },
                {
                    "type":"object",
                    "title":"Action Occurrence",
                    "description":"Action Occurrence accessor for the organization.",
                    "x-searchable":true
                }
            ]
        }
    },
    "x-primaryKey":[
        "id",
        "effectiveStartDate",
        "effectiveEndDate"
    ]
}

Nested Schema : oraErpCoreStructure.BusinessUnit_item-fields-allOf[2]

Type: object

Show Source

• code: string
  Title: Organization Code

  Code of the organization.
• createdBy: string
  Title: Created By

  The user who created the record.
• timeCreated: string
  Title: Creation Date

  The date and time when the record was created.
• timeUpdated: string
  Title: Last Updated Date

  The date and time when the record was last updated.
• title: string
  Title: Title

  Title of the organization.
• updatedBy: string
  Title: Last Updated By

  The user who last updated the record.

{
    "type":"object",
    "properties":{
        "createdBy":{
            "title":"Created By",
            "description":"The user who created the record.",
            "type":"string"
        },
        "timeCreated":{
            "title":"Creation Date",
            "description":"The date and time when the record was created.",
            "type":"string"
        },
        "updatedBy":{
            "title":"Last Updated By",
            "description":"The user who last updated the record.",
            "type":"string"
        },
        "timeUpdated":{
            "title":"Last Updated Date",
            "description":"The date and time when the record was last updated.",
            "type":"string"
        },
        "code":{
            "title":"Organization Code",
            "description":"Code of the organization.",
            "type":"string"
        },
        "title":{
            "title":"Title",
            "description":"Title of the organization.",
            "type":"string"
        }
    }
}

Nested Schema : oraErpCoreStructure.BusinessUnit_item-fields-allOf[3]

Type: object

Nested Schema : Business Unit

Type: object

Title: Business Unit

Business unit associated with the service business unit profile value.

Nested Schema : actionOccurrence

Match All

Action Occurrence accessor for the organization.

Show Source

• object oraHcmHrCoreEmployment.ActionOccurrence_item-fields
• object __busObj_context
• object Action Occurrence
  Title: Action Occurrence

  Action Occurrence accessor for the organization.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/oraHcmHrCoreEmployment.ActionOccurrence_item-fields"
        },
        {
            "$ref":"#/components/schemas/__busObj_context"
        },
        {
            "type":"object",
            "title":"Action Occurrence",
            "description":"Action Occurrence accessor for the organization.",
            "x-searchable":true
        }
    ]
}

Nested Schema : location

Match All

Location accessor for the organization.

Show Source

• allOf oraHcmHrCoreWorkStructures.Location_item-fields
• object __busObj_context
• object Location
  Title: Location

  Location accessor for the organization.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/oraHcmHrCoreWorkStructures.Location_item-fields"
        },
        {
            "$ref":"#/components/schemas/__busObj_context"
        },
        {
            "type":"object",
            "title":"Location",
            "description":"Location accessor for the organization.",
            "x-searchable":true
        }
    ]
}

Nested Schema : oraHcmHrCoreEmployment.ActionOccurrence_item-fields

Type: object

Show Source

• action: action
• actionDate: string (date)
  Title: Action Date

  Read Only: true

  Action date for action occurrence record.
• actionReason: actionReason
• actionTypeCode: string
  Title: Action Type Code

  Read Only: true

  Action type code for action occurrence record.
• categoryCode: string
  Title: Category Code

  Read Only: true

  Category code for action occurrence record.
• createdBy: string
  Title: Created By

  Read Only: true

  The user who created the record.
• entityType: string
  Title: Entity Type

  Read Only: true

  Entity type for action occurrence record.
• freezeStartDate: string (date)
  Title: Freeze Start Date

  Read Only: true

  Freeze start date in when and why section of employment flows.
• freezeUntilDate: string (date)
  Title: Freeze Until Date

  Read Only: true

  Freeze until date in when and why section of employment flows.
• howToProcess: string
  Title: How to Process?

  Read Only: true

  Specifies whether to use an existing position or a new position in when and why section of employment flows.
• id: string (big-integer)
  Title: Action Occurrence ID

  Read Only: true

  Unique identifier for the action occurrence in the action occurrence record.
• parentEntityType: string
  Title: Parent Entity Type

  Read Only: true

  Parent entity type for action occurrence record.
• proposedActionType: string
  Title: Proposed Action Type

  Read Only: true

  Proposed action type for the action occurrence record.
• proposedStartDate: string (date)
  Title: Proposed Start Date

  Read Only: true

  Proposed start date of the action occurrence record.
• proposedWorkerType: string
  Title: Proposed Worker Type

  Read Only: true

  Proposed worker type for action occurrence record.
• submittedBy: string (big-integer)
  Title: Submitted By

  Read Only: true

  Submitted by in when and why section of employment flows.
• timeCreated: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time when the record was created.
• timeUpdated: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time when the record was last updated.
• updatedBy: string
  Title: Last Updated By

  Read Only: true

  The user who last updated the record.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "format":"big-integer",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true,
            "title":"Action Occurrence ID",
            "description":"Unique identifier for the action occurrence in the action occurrence record."
        },
        "actionDate":{
            "type":"string",
            "format":"date",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true,
            "title":"Action Date",
            "description":"Action date for action occurrence record."
        },
        "actionTypeCode":{
            "type":"string",
            "nullable":true,
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true,
            "title":"Action Type Code",
            "description":"Action type code for action occurrence record."
        },
        "categoryCode":{
            "type":"string",
            "nullable":true,
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true,
            "title":"Category Code",
            "description":"Category code for action occurrence record."
        },
        "createdBy":{
            "type":"string",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true,
            "title":"Created By",
            "description":"The user who created the record."
        },
        "entityType":{
            "type":"string",
            "nullable":true,
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true,
            "title":"Entity Type",
            "description":"Entity type for action occurrence record."
        },
        "freezeStartDate":{
            "type":"string",
            "format":"date",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true,
            "title":"Freeze Start Date",
            "description":"Freeze start date in when and why section of employment flows."
        },
        "freezeUntilDate":{
            "type":"string",
            "format":"date",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true,
            "title":"Freeze Until Date",
            "description":"Freeze until date in when and why section of employment flows."
        },
        "howToProcess":{
            "type":"string",
            "nullable":true,
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true,
            "title":"How to Process?",
            "description":"Specifies whether to use an existing position or a new position in when and why section of employment flows."
        },
        "parentEntityType":{
            "type":"string",
            "nullable":true,
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true,
            "title":"Parent Entity Type",
            "description":"Parent entity type for action occurrence record."
        },
        "proposedActionType":{
            "type":"string",
            "nullable":true,
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true,
            "title":"Proposed Action Type",
            "description":"Proposed action type for the action occurrence record."
        },
        "proposedStartDate":{
            "type":"string",
            "format":"date",
            "nullable":true,
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true,
            "title":"Proposed Start Date",
            "description":"Proposed start date of the action occurrence record."
        },
        "proposedWorkerType":{
            "type":"string",
            "nullable":true,
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true,
            "title":"Proposed Worker Type",
            "description":"Proposed worker type for action occurrence record."
        },
        "submittedBy":{
            "type":"string",
            "format":"big-integer",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true,
            "title":"Submitted By",
            "description":"Submitted by in when and why section of employment flows."
        },
        "timeCreated":{
            "type":"string",
            "format":"date-time",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true,
            "title":"Creation Date",
            "description":"The date and time when the record was created."
        },
        "timeUpdated":{
            "type":"string",
            "format":"date-time",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true,
            "title":"Last Updated Date",
            "description":"The date and time when the record was last updated."
        },
        "updatedBy":{
            "type":"string",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true,
            "title":"Last Updated By",
            "description":"The user who last updated the record."
        },
        "action":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/oraHcmHrCoreEmployment.Action_item-fields"
                },
                {
                    "$ref":"#/components/schemas/__busObj_context"
                },
                {
                    "type":"object",
                    "title":"Action",
                    "description":"Action accessor for action occurrence item.",
                    "x-searchable":true
                }
            ]
        },
        "actionReason":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/oraHcmHrCoreEmployment.ActionReason_item-fields"
                },
                {
                    "$ref":"#/components/schemas/__busObj_context"
                },
                {
                    "type":"object",
                    "title":"Action Reason",
                    "description":"Action reason accessor for action occurrence item.",
                    "x-searchable":true
                }
            ]
        }
    },
    "x-primaryKey":[
        "id"
    ]
}

Nested Schema : Action Occurrence

Type: object

Title: Action Occurrence

Action Occurrence accessor for the organization.

Nested Schema : action

Match All

Action accessor for action occurrence item.

Show Source

• object oraHcmHrCoreEmployment.Action_item-fields
• object __busObj_context
• object Action
  Title: Action

  Action accessor for action occurrence item.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/oraHcmHrCoreEmployment.Action_item-fields"
        },
        {
            "$ref":"#/components/schemas/__busObj_context"
        },
        {
            "type":"object",
            "title":"Action",
            "description":"Action accessor for action occurrence item.",
            "x-searchable":true
        }
    ]
}

Nested Schema : actionReason

Match All

Action reason accessor for action occurrence item.

Show Source

• object oraHcmHrCoreEmployment.ActionReason_item-fields
• object __busObj_context
• object Action Reason
  Title: Action Reason

  Action reason accessor for action occurrence item.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/oraHcmHrCoreEmployment.ActionReason_item-fields"
        },
        {
            "$ref":"#/components/schemas/__busObj_context"
        },
        {
            "type":"object",
            "title":"Action Reason",
            "description":"Action reason accessor for action occurrence item.",
            "x-searchable":true
        }
    ]
}

Nested Schema : oraHcmHrCoreEmployment.Action_item-fields

Type: object

Show Source

• $sourceLang: string
  Title: Source Language

  Read Only: true

  The language in which the values of the translatable columns were created, updated, or copied from.
• code: string
  Title: Action Code

  Read Only: true

  Code for the action.
• contractUsageFlag: boolean
  Title: Contract Usage Flag

  Read Only: true

  Contract usage flag for action item.
• createdBy: string
  Title: Created By

  Read Only: true

  The user who created the record.
• description: string
  Title: Description

  Description for action item.
• endDate: string (date)
  Title: End Date

  Read Only: true

  Date and time when the action ended.
• id: string (big-integer)
  Title: Action ID

  Read Only: true

  Unique identifier for the action.
• name: string
  Title: Action Name

  Name for the action, such as Hire or Promote.
• startDate: string (date)
  Title: Start Date

  Read Only: true

  Date and time when the action started.
• timeCreated: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time when the record was created.
• timeUpdated: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time when the record was last updated.
• updatedBy: string
  Title: Last Updated By

  Read Only: true

  The user who last updated the record.

{
    "type":"object",
    "properties":{
        "$sourceLang":{
            "type":"string",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true,
            "title":"Source Language",
            "description":"The language in which the values of the translatable columns were created, updated, or copied from."
        },
        "code":{
            "type":"string",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true,
            "title":"Action Code",
            "description":"Code for the action."
        },
        "id":{
            "type":"string",
            "format":"big-integer",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true,
            "title":"Action ID",
            "description":"Unique identifier for the action."
        },
        "name":{
            "type":"string",
            "nullable":true,
            "x-searchable":true,
            "x-sortable":true,
            "title":"Action Name",
            "description":"Name for the action, such as Hire or Promote."
        },
        "createdBy":{
            "type":"string",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true,
            "title":"Created By",
            "description":"The user who created the record."
        },
        "description":{
            "type":"string",
            "nullable":true,
            "x-searchable":true,
            "x-sortable":true,
            "title":"Description",
            "description":"Description for action item."
        },
        "endDate":{
            "type":"string",
            "format":"date",
            "nullable":true,
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true,
            "title":"End Date",
            "description":"Date and time when the action ended."
        },
        "startDate":{
            "type":"string",
            "format":"date",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true,
            "title":"Start Date",
            "description":"Date and time when the action started."
        },
        "timeCreated":{
            "type":"string",
            "format":"date-time",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true,
            "title":"Creation Date",
            "description":"The date and time when the record was created."
        },
        "timeUpdated":{
            "type":"string",
            "format":"date-time",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true,
            "title":"Last Updated Date",
            "description":"The date and time when the record was last updated."
        },
        "updatedBy":{
            "type":"string",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true,
            "title":"Last Updated By",
            "description":"The user who last updated the record."
        },
        "contractUsageFlag":{
            "type":"boolean",
            "nullable":true,
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true,
            "title":"Contract Usage Flag",
            "description":"Contract usage flag for action item."
        }
    },
    "x-primaryKey":[
        "id"
    ]
}

Nested Schema : Action

Type: object

Title: Action

Action accessor for action occurrence item.

Nested Schema : $context

Type: object

Show Source

• etag: string
• links: object links
  Read Only: true

{
    "type":"object",
    "properties":{
        "etag":{
            "type":"string"
        },
        "links":{
            "type":"object",
            "properties":{
                "$self":{
                    "type":"object",
                    "properties":{
                        "href":{
                            "type":"string"
                        }
                    }
                }
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: object

Read Only: true

Show Source

• $self: object $self

{
    "type":"object",
    "properties":{
        "$self":{
            "type":"object",
            "properties":{
                "href":{
                    "type":"string"
                }
            }
        }
    },
    "readOnly":true
}

Nested Schema : $self

Type: object

Show Source

• href: string

{
    "type":"object",
    "properties":{
        "href":{
            "type":"string"
        }
    }
}

Nested Schema : oraHcmHrCoreEmployment.ActionReason_item-fields

Type: object

Show Source

• $sourceLang: string
  Title: Source Language

  Read Only: true

  The language in which the values of the translatable columns were created, updated, or copied from.
• code: string
  Title: Action Reason Code

  Read Only: true

  Code of the action reason.
• createdBy: string
  Title: Created By

  Read Only: true

  The user who created the record.
• description: string
  Title: Description

  Meaning of the action reason item.
• endDate: string (date)
  Title: Reason End Date

  Read Only: true

  Date and time when the action reason was ended.
• id: string (big-integer)
  Title: Action Reason ID

  Read Only: true

  Unique identifier for the action reason.
• name: string
  Title: Action Reason

  Name of the action reason.
• startDate: string (date)
  Title: Reason Start Date

  Read Only: true

  Date and time when the action reason was created.
• timeCreated: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time when the record was created.
• timeUpdated: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time when the record was last updated.
• updatedBy: string
  Title: Last Updated By

  Read Only: true

  The user who last updated the record.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "format":"big-integer",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true,
            "title":"Action Reason ID",
            "description":"Unique identifier for the action reason."
        },
        "$sourceLang":{
            "type":"string",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true,
            "title":"Source Language",
            "description":"The language in which the values of the translatable columns were created, updated, or copied from."
        },
        "code":{
            "type":"string",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true,
            "title":"Action Reason Code",
            "description":"Code of the action reason."
        },
        "name":{
            "type":"string",
            "nullable":true,
            "x-searchable":true,
            "x-sortable":true,
            "title":"Action Reason",
            "description":"Name of the action reason."
        },
        "createdBy":{
            "type":"string",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true,
            "title":"Created By",
            "description":"The user who created the record."
        },
        "description":{
            "type":"string",
            "nullable":true,
            "x-searchable":true,
            "x-sortable":true,
            "title":"Description",
            "description":"Meaning of the action reason item."
        },
        "endDate":{
            "type":"string",
            "format":"date",
            "nullable":true,
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true,
            "title":"Reason End Date",
            "description":"Date and time when the action reason was ended."
        },
        "startDate":{
            "type":"string",
            "format":"date",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true,
            "title":"Reason Start Date",
            "description":"Date and time when the action reason was created."
        },
        "timeCreated":{
            "type":"string",
            "format":"date-time",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true,
            "title":"Creation Date",
            "description":"The date and time when the record was created."
        },
        "timeUpdated":{
            "type":"string",
            "format":"date-time",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true,
            "title":"Last Updated Date",
            "description":"The date and time when the record was last updated."
        },
        "updatedBy":{
            "type":"string",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true,
            "title":"Last Updated By",
            "description":"The user who last updated the record."
        }
    },
    "x-primaryKey":[
        "id"
    ]
}

Nested Schema : Action Reason

Type: object

Title: Action Reason

Action reason accessor for action occurrence item.

Nested Schema : oraHcmHrCoreWorkStructures.Location_item-fields

Match All

Show Source

• allOf oraHcmHrCoreWorkStructures.Location_abstract-item
• object oraHcmHrCoreWorkStructures.Location_item-fields-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/oraHcmHrCoreWorkStructures.Location_abstract-item"
        },
        {
            "type":"object",
            "properties":{
                "id":{
                    "title":"Location Identifier",
                    "description":"Surrogate identifier for the location.",
                    "type":"string"
                },
                "code":{
                    "title":"Location Code",
                    "description":"Code that uniquely references the location within the set.",
                    "type":"string"
                },
                "createdBy":{
                    "title":"Created By",
                    "description":"The user who created the record.",
                    "type":"string"
                },
                "timeCreated":{
                    "title":"Creation Date",
                    "description":"The date and time when the record was created.",
                    "type":"string"
                },
                "updatedBy":{
                    "title":"Last Updated By",
                    "description":"The user who last updated the record.",
                    "type":"string"
                },
                "timeUpdated":{
                    "title":"Last Updated Date",
                    "description":"The date and time when the record was last updated.",
                    "type":"string"
                },
                "employeeLocationFlag":{
                    "title":"Employee Location",
                    "description":"Indicates whether the location is an employee location.",
                    "type":"boolean"
                },
                "effectiveStartDate":{
                    "title":"Effective Start Date",
                    "description":"Date at the beginning of the period within which the department's location is effective.",
                    "type":"string"
                },
                "effectiveEndDate":{
                    "title":"Effective End Date",
                    "description":"Date at the end of the period within which the department's location is effective.",
                    "type":"string"
                },
                "countryCode":{
                    "title":"Country",
                    "description":"Country name for the location address.",
                    "type":"string"
                },
                "status":{
                    "title":"Status",
                    "description":"Status of the location such as active or inactive.",
                    "type":"string"
                },
                "shipToSiteFlag":{
                    "title":"Ship-to Site",
                    "description":"Indicates whether the location is a ship to site. The default value is true.",
                    "type":"boolean"
                },
                "receivingSiteFlag":{
                    "title":"Receiving Site",
                    "description":"Indicates whether the location is a receiving site. The default value is true.",
                    "type":"boolean"
                },
                "billToSiteFlag":{
                    "title":"Bill-to Site",
                    "description":"Indicates whether the location is a bill to site. The default value is true.",
                    "type":"boolean"
                },
                "officeSiteFlag":{
                    "title":"Office Site",
                    "description":"Indicates whether the location is an office site. The default value is true.",
                    "type":"boolean"
                },
                "detailCreatedBy":{
                    "title":"Created By",
                    "description":"User who created the location details.",
                    "type":"string"
                },
                "detailTimeCreated":{
                    "title":"Creation Date",
                    "description":"Date and time of the creation of the location details.",
                    "type":"string"
                },
                "detailUpdatedBy":{
                    "title":"Last Updated By",
                    "description":"User who last updated the location details.",
                    "type":"string"
                },
                "detailTimeUpdated":{
                    "title":"Last Update Date",
                    "description":"Date and time of the last update of the location details.",
                    "type":"string"
                },
                "timezoneCode":{
                    "title":"Time Zone",
                    "description":"Time zone code for the location address.",
                    "type":"string"
                },
                "description":{
                    "title":"Location",
                    "description":"Description of the location.",
                    "type":"string"
                },
                "name":{
                    "title":"Name",
                    "description":"Name of the location.",
                    "type":"string"
                }
            }
        }
    ]
}

Nested Schema : oraHcmHrCoreWorkStructures.Location_abstract-item

Match All

Show Source

• object oraHcmHrCoreWorkStructures.Location_abstract-item-allOf[0]
• object oraHcmHrCoreWorkStructures.LocationBase_abstract-item

{
    "allOf":[
        {
            "type":"object",
            "properties":{
            },
            "x-alternateKeys":{
                "altKey":[
                    "id"
                ]
            }
        },
        {
            "$ref":"#/components/schemas/oraHcmHrCoreWorkStructures.LocationBase_abstract-item"
        }
    ]
}

Nested Schema : oraHcmHrCoreWorkStructures.Location_abstract-item-allOf[0]

Type: object

Show Source

{
    "type":"object",
    "properties":{
    },
    "x-alternateKeys":{
        "altKey":[
            "id"
        ]
    }
}

Nested Schema : oraHcmHrCoreWorkStructures.LocationBase_abstract-item

Type: object

Show Source

• actionOccurrence: actionOccurrence
• billToSiteFlag: boolean
  Read Only: true
• code: string
  Read Only: true
• country: country
• countryCode: string
  Read Only: true
• createdBy: string
  Read Only: true
• description: string
  Read Only: true
• detailCreatedBy: string
  Read Only: true
• detailTimeCreated: string (date-time)
  Read Only: true
• detailTimeUpdated: string (date-time)
  Read Only: true
• detailUpdatedBy: string
  Read Only: true
• effectiveEndDate: string (date)
  Read Only: true
• effectiveStartDate: string (date)
  Read Only: true
• employeeLocationFlag: boolean
  Read Only: true
• id: string (big-integer)
  Read Only: true
• mainAddress: mainAddress
• name: string
  Read Only: true
• officeSiteFlag: boolean
  Read Only: true
• receivingSiteFlag: boolean
  Read Only: true
• setIdSet: setIdSet
• shipToSiteFlag: boolean
  Read Only: true
• status: status
• timeCreated: string (date-time)
  Read Only: true
• timeUpdated: string (date-time)
  Read Only: true
• timezone: timezone
• timezoneCode: string
  Read Only: true
• updatedBy: string
  Read Only: true

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "format":"big-integer",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true
        },
        "code":{
            "type":"string",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true
        },
        "createdBy":{
            "type":"string",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true
        },
        "timeCreated":{
            "type":"string",
            "format":"date-time",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true
        },
        "updatedBy":{
            "type":"string",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true
        },
        "timeUpdated":{
            "type":"string",
            "format":"date-time",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true
        },
        "employeeLocationFlag":{
            "type":"boolean",
            "nullable":true,
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true
        },
        "effectiveStartDate":{
            "type":"string",
            "format":"date",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true
        },
        "effectiveEndDate":{
            "type":"string",
            "format":"date",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true
        },
        "countryCode":{
            "type":"string",
            "nullable":true,
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true
        },
        "status":{
            "allOf":[
                {
                    "type":"string",
                    "x-searchable":true,
                    "x-sortable":true,
                    "readOnly":true,
                    "x-oj":{
                        "transform":{
                            "path":"boss/EnumMetadataTransforms",
                            "name":"transformEnumExtensions"
                        }
                    }
                },
                {
                    "$ref":"#/components/schemas/oraHcmHrCoreWorkStructures.ActiveStatus_enum"
                }
            ]
        },
        "shipToSiteFlag":{
            "type":"boolean",
            "nullable":true,
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true
        },
        "receivingSiteFlag":{
            "type":"boolean",
            "nullable":true,
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true
        },
        "billToSiteFlag":{
            "type":"boolean",
            "nullable":true,
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true
        },
        "officeSiteFlag":{
            "type":"boolean",
            "nullable":true,
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true
        },
        "detailCreatedBy":{
            "type":"string",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true
        },
        "detailTimeCreated":{
            "type":"string",
            "format":"date-time",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true
        },
        "detailUpdatedBy":{
            "type":"string",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true
        },
        "detailTimeUpdated":{
            "type":"string",
            "format":"date-time",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true
        },
        "timezoneCode":{
            "type":"string",
            "nullable":true,
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true
        },
        "description":{
            "type":"string",
            "nullable":true,
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true
        },
        "name":{
            "type":"string",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true
        },
        "timezone":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/oraCommonAppsInfraObjects.Timezone_item-fields"
                },
                {
                    "$ref":"#/components/schemas/__busObj_context"
                },
                {
                    "type":"object",
                    "title":"Time Zone",
                    "description":"Time zone code for the location address.",
                    "x-searchable":true
                }
            ]
        },
        "setIdSet":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/oraCommonAppsInfraObjects.SetIdSet_item-fields"
                },
                {
                    "$ref":"#/components/schemas/__busObj_context"
                },
                {
                    "type":"object",
                    "title":"Set Id Set",
                    "description":"Set Id set accessor for the location.",
                    "x-searchable":true
                }
            ]
        },
        "country":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/oraCommonAppsInfraObjects.Territory_item-fields"
                },
                {
                    "$ref":"#/components/schemas/__busObj_context"
                },
                {
                    "type":"object",
                    "title":"Country",
                    "description":"Country name for the location address.",
                    "x-searchable":true
                }
            ]
        },
        "mainAddress":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/oraHcmHrCoreWorkStructures.LocationAddress_item-fields"
                },
                {
                    "$ref":"#/components/schemas/__busObj_context"
                },
                {
                    "type":"object",
                    "title":"Main Address",
                    "description":"Main address accessor for the location.",
                    "x-searchable":true
                }
            ]
        },
        "actionOccurrence":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/oraHcmHrCoreEmployment.ActionOccurrence_item-fields"
                },
                {
                    "$ref":"#/components/schemas/__busObj_context"
                },
                {
                    "type":"object",
                    "title":"Action Occurrence",
                    "description":"Action Occurrence accessor for the location.",
                    "x-searchable":true
                }
            ]
        }
    },
    "x-primaryKey":[
        "id",
        "effectiveStartDate",
        "effectiveEndDate"
    ]
}

Nested Schema : oraHcmHrCoreWorkStructures.Location_item-fields-allOf[1]

Type: object

Show Source

• billToSiteFlag: boolean
  Title: Bill-to Site

  Indicates whether the location is a bill to site. The default value is true.
• code: string
  Title: Location Code

  Code that uniquely references the location within the set.
• countryCode: string
  Title: Country

  Country name for the location address.
• createdBy: string
  Title: Created By

  The user who created the record.
• description: string
  Title: Location

  Description of the location.
• detailCreatedBy: string
  Title: Created By

  User who created the location details.
• detailTimeCreated: string
  Title: Creation Date

  Date and time of the creation of the location details.
• detailTimeUpdated: string
  Title: Last Update Date

  Date and time of the last update of the location details.
• detailUpdatedBy: string
  Title: Last Updated By

  User who last updated the location details.
• effectiveEndDate: string
  Title: Effective End Date

  Date at the end of the period within which the department's location is effective.
• effectiveStartDate: string
  Title: Effective Start Date

  Date at the beginning of the period within which the department's location is effective.
• employeeLocationFlag: boolean
  Title: Employee Location

  Indicates whether the location is an employee location.
• id: string
  Title: Location Identifier

  Surrogate identifier for the location.
• name: string
  Title: Name

  Name of the location.
• officeSiteFlag: boolean
  Title: Office Site

  Indicates whether the location is an office site. The default value is true.
• receivingSiteFlag: boolean
  Title: Receiving Site

  Indicates whether the location is a receiving site. The default value is true.
• shipToSiteFlag: boolean
  Title: Ship-to Site

  Indicates whether the location is a ship to site. The default value is true.
• status: string
  Title: Status

  Status of the location such as active or inactive.
• timeCreated: string
  Title: Creation Date

  The date and time when the record was created.
• timeUpdated: string
  Title: Last Updated Date

  The date and time when the record was last updated.
• timezoneCode: string
  Title: Time Zone

  Time zone code for the location address.
• updatedBy: string
  Title: Last Updated By

  The user who last updated the record.

{
    "type":"object",
    "properties":{
        "id":{
            "title":"Location Identifier",
            "description":"Surrogate identifier for the location.",
            "type":"string"
        },
        "code":{
            "title":"Location Code",
            "description":"Code that uniquely references the location within the set.",
            "type":"string"
        },
        "createdBy":{
            "title":"Created By",
            "description":"The user who created the record.",
            "type":"string"
        },
        "timeCreated":{
            "title":"Creation Date",
            "description":"The date and time when the record was created.",
            "type":"string"
        },
        "updatedBy":{
            "title":"Last Updated By",
            "description":"The user who last updated the record.",
            "type":"string"
        },
        "timeUpdated":{
            "title":"Last Updated Date",
            "description":"The date and time when the record was last updated.",
            "type":"string"
        },
        "employeeLocationFlag":{
            "title":"Employee Location",
            "description":"Indicates whether the location is an employee location.",
            "type":"boolean"
        },
        "effectiveStartDate":{
            "title":"Effective Start Date",
            "description":"Date at the beginning of the period within which the department's location is effective.",
            "type":"string"
        },
        "effectiveEndDate":{
            "title":"Effective End Date",
            "description":"Date at the end of the period within which the department's location is effective.",
            "type":"string"
        },
        "countryCode":{
            "title":"Country",
            "description":"Country name for the location address.",
            "type":"string"
        },
        "status":{
            "title":"Status",
            "description":"Status of the location such as active or inactive.",
            "type":"string"
        },
        "shipToSiteFlag":{
            "title":"Ship-to Site",
            "description":"Indicates whether the location is a ship to site. The default value is true.",
            "type":"boolean"
        },
        "receivingSiteFlag":{
            "title":"Receiving Site",
            "description":"Indicates whether the location is a receiving site. The default value is true.",
            "type":"boolean"
        },
        "billToSiteFlag":{
            "title":"Bill-to Site",
            "description":"Indicates whether the location is a bill to site. The default value is true.",
            "type":"boolean"
        },
        "officeSiteFlag":{
            "title":"Office Site",
            "description":"Indicates whether the location is an office site. The default value is true.",
            "type":"boolean"
        },
        "detailCreatedBy":{
            "title":"Created By",
            "description":"User who created the location details.",
            "type":"string"
        },
        "detailTimeCreated":{
            "title":"Creation Date",
            "description":"Date and time of the creation of the location details.",
            "type":"string"
        },
        "detailUpdatedBy":{
            "title":"Last Updated By",
            "description":"User who last updated the location details.",
            "type":"string"
        },
        "detailTimeUpdated":{
            "title":"Last Update Date",
            "description":"Date and time of the last update of the location details.",
            "type":"string"
        },
        "timezoneCode":{
            "title":"Time Zone",
            "description":"Time zone code for the location address.",
            "type":"string"
        },
        "description":{
            "title":"Location",
            "description":"Description of the location.",
            "type":"string"
        },
        "name":{
            "title":"Name",
            "description":"Name of the location.",
            "type":"string"
        }
    }
}

Nested Schema : Location

Type: object

Title: Location

Location accessor for the organization.

Nested Schema : actionOccurrence

Match All

Action Occurrence accessor for the location.

Show Source

• object oraHcmHrCoreEmployment.ActionOccurrence_item-fields
• object __busObj_context
• object Action Occurrence
  Title: Action Occurrence

  Action Occurrence accessor for the location.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/oraHcmHrCoreEmployment.ActionOccurrence_item-fields"
        },
        {
            "$ref":"#/components/schemas/__busObj_context"
        },
        {
            "type":"object",
            "title":"Action Occurrence",
            "description":"Action Occurrence accessor for the location.",
            "x-searchable":true
        }
    ]
}

Nested Schema : country

Match All

Country name for the location address.

Show Source

• allOf oraCommonAppsInfraObjects.Territory_item-fields
• object __busObj_context
• object Country
  Title: Country

  Country name for the location address.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/oraCommonAppsInfraObjects.Territory_item-fields"
        },
        {
            "$ref":"#/components/schemas/__busObj_context"
        },
        {
            "type":"object",
            "title":"Country",
            "description":"Country name for the location address.",
            "x-searchable":true
        }
    ]
}

Nested Schema : mainAddress

Match All

Main address accessor for the location.

Show Source

• allOf oraHcmHrCoreWorkStructures.LocationAddress_item-fields
• object __busObj_context
• object Main Address
  Title: Main Address

  Main address accessor for the location.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/oraHcmHrCoreWorkStructures.LocationAddress_item-fields"
        },
        {
            "$ref":"#/components/schemas/__busObj_context"
        },
        {
            "type":"object",
            "title":"Main Address",
            "description":"Main address accessor for the location.",
            "x-searchable":true
        }
    ]
}

Nested Schema : setIdSet

Match All

Set Id set accessor for the location.

Show Source

• allOf oraCommonAppsInfraObjects.SetIdSet_item-fields
• object __busObj_context
• object Set Id Set
  Title: Set Id Set

  Set Id set accessor for the location.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/oraCommonAppsInfraObjects.SetIdSet_item-fields"
        },
        {
            "$ref":"#/components/schemas/__busObj_context"
        },
        {
            "type":"object",
            "title":"Set Id Set",
            "description":"Set Id set accessor for the location.",
            "x-searchable":true
        }
    ]
}

Nested Schema : status

Match All

Show Source

• string
  Read Only: true
• string
  Allowed Values: [ "A", "I" ]

{
    "allOf":[
        {
            "type":"string",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true,
            "x-oj":{
                "transform":{
                    "path":"boss/EnumMetadataTransforms",
                    "name":"transformEnumExtensions"
                }
            }
        },
        {
            "$ref":"#/components/schemas/oraHcmHrCoreWorkStructures.ActiveStatus_enum"
        }
    ]
}

Nested Schema : timezone

Match All

Time zone code for the location address.

Show Source

• object oraCommonAppsInfraObjects.Timezone_item-fields
• object __busObj_context
• object Time Zone
  Title: Time Zone

  Time zone code for the location address.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/oraCommonAppsInfraObjects.Timezone_item-fields"
        },
        {
            "$ref":"#/components/schemas/__busObj_context"
        },
        {
            "type":"object",
            "title":"Time Zone",
            "description":"Time zone code for the location address.",
            "x-searchable":true
        }
    ]
}

Nested Schema : Action Occurrence

Type: object

Title: Action Occurrence

Action Occurrence accessor for the location.

Nested Schema : oraCommonAppsInfraObjects.Territory_item-fields

Match All

Show Source

• object oraCommonAppsInfraObjects.Territory_abstract-item
• object oraCommonAppsInfraObjects.Territory_item-fields-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/oraCommonAppsInfraObjects.Territory_abstract-item"
        },
        {
            "type":"object",
            "properties":{
                "territoryCode":{
                    "title":"Territory Code",
                    "description":"The unique code of the territory.",
                    "type":"string"
                },
                "euCode":{
                    "title":"EU Code",
                    "description":"The EU code of the territory. For example, for Germany this would be 004.",
                    "type":"string"
                },
                "isoNumericCode":{
                    "title":"ISO Numeric Code",
                    "description":"The ISO numeric code of the territory. For example, for Australia this would be 036.",
                    "type":"string"
                },
                "alternateTerritoryCode":{
                    "title":"Alternate Territory Code",
                    "description":"The alternate code of the territory. For example, for Germany this would be de-DE.",
                    "type":"string"
                },
                "nlsTerritory":{
                    "title":"NLS Territory",
                    "description":"The NLS territory value. For example, for Germany this would be GERMANY.",
                    "type":"string"
                },
                "isoTerritoryCode":{
                    "title":"ISO Territory Code",
                    "description":"The ISO territory code. For example, for Germany this would be DEU.",
                    "type":"string"
                },
                "obsoleteFlag":{
                    "title":"Territory Obsolete",
                    "description":"Indicates if a territory is obsolete.",
                    "type":"boolean"
                },
                "enabledFlag":{
                    "title":"Territory Enabled",
                    "description":"Indicates if a territory is enabled.",
                    "type":"boolean"
                },
                "timeCreated":{
                    "title":"Created On",
                    "description":"The date and time when the record was created.",
                    "type":"string"
                },
                "createdBy":{
                    "title":"Created By",
                    "description":"The user who created the record.",
                    "type":"string"
                },
                "timeUpdated":{
                    "title":"Last Updated Date",
                    "description":"The date and time when the record was last updated.",
                    "type":"string"
                },
                "updatedBy":{
                    "title":"Last Updated By",
                    "description":"The user who last updated the record.",
                    "type":"string"
                },
                "description":{
                    "title":"Territory Description",
                    "description":"The description of the territory.",
                    "type":"string"
                },
                "$sourceLang":{
                    "title":"Source Language",
                    "description":"The language in which the values of the translatable columns were created, updated, or copied from.",
                    "type":"string"
                },
                "territoryShortName":{
                    "title":"Territory Short Name",
                    "description":"The name of the territory.",
                    "type":"string"
                }
            }
        }
    ]
}

Nested Schema : oraCommonAppsInfraObjects.Territory_abstract-item

Type: object

Show Source

• $sourceLang: string
  Read Only: true
• alternateTerritoryCode: string
  Read Only: true

  Maximum Length: 30
• createdBy: string
  Read Only: true
• description: string
  Maximum Length: 4000
• enabledFlag: boolean
  Default Value: true
• euCode: string
  Maximum Length: 3
• isoNumericCode: string
  Minimum Length: 3

  Maximum Length: 3
• isoTerritoryCode: string
  Minimum Length: 3

  Maximum Length: 3
• nlsTerritory: string
  Maximum Length: 30
• obsoleteFlag: boolean
  Default Value: false
• territoryCode: string
  Minimum Length: 2

  Maximum Length: 2
• territoryShortName: string
  Maximum Length: 80
• timeCreated: string (date-time)
  Read Only: true
• timeUpdated: string (date-time)
  Read Only: true
• updatedBy: string
  Read Only: true

{
    "type":"object",
    "properties":{
        "territoryCode":{
            "type":"string",
            "x-searchable":true,
            "x-sortable":true,
            "minLength":2,
            "maxLength":2
        },
        "euCode":{
            "type":"string",
            "nullable":true,
            "x-searchable":true,
            "x-sortable":true,
            "maxLength":3
        },
        "isoNumericCode":{
            "type":"string",
            "nullable":true,
            "x-searchable":true,
            "x-sortable":true,
            "minLength":3,
            "maxLength":3
        },
        "alternateTerritoryCode":{
            "type":"string",
            "nullable":true,
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true,
            "maxLength":30
        },
        "nlsTerritory":{
            "type":"string",
            "nullable":true,
            "x-searchable":true,
            "x-sortable":true,
            "maxLength":30
        },
        "isoTerritoryCode":{
            "type":"string",
            "nullable":true,
            "x-searchable":true,
            "x-sortable":true,
            "minLength":3,
            "maxLength":3
        },
        "obsoleteFlag":{
            "type":"boolean",
            "default":false,
            "x-searchable":true,
            "x-sortable":true
        },
        "enabledFlag":{
            "type":"boolean",
            "default":true,
            "x-searchable":true,
            "x-sortable":true
        },
        "timeCreated":{
            "type":"string",
            "format":"date-time",
            "x-searchable":true,
            "readOnly":true
        },
        "createdBy":{
            "type":"string",
            "readOnly":true
        },
        "timeUpdated":{
            "type":"string",
            "format":"date-time",
            "x-searchable":true,
            "readOnly":true
        },
        "updatedBy":{
            "type":"string",
            "readOnly":true
        },
        "description":{
            "type":"string",
            "nullable":true,
            "x-searchable":true,
            "x-sortable":true,
            "maxLength":4000
        },
        "$sourceLang":{
            "type":"string",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true
        },
        "territoryShortName":{
            "type":"string",
            "x-searchable":true,
            "x-sortable":true,
            "maxLength":80
        }
    },
    "x-primaryKey":[
        "territoryCode"
    ],
    "x-alternateKeys":{
        "altKey":[
            "territoryShortName"
        ]
    }
}

Nested Schema : oraCommonAppsInfraObjects.Territory_item-fields-allOf[1]

Type: object

Show Source

• $sourceLang: string
  Title: Source Language

  The language in which the values of the translatable columns were created, updated, or copied from.
• alternateTerritoryCode: string
  Title: Alternate Territory Code

  The alternate code of the territory. For example, for Germany this would be de-DE.
• createdBy: string
  Title: Created By

  The user who created the record.
• description: string
  Title: Territory Description

  The description of the territory.
• enabledFlag: boolean
  Title: Territory Enabled

  Indicates if a territory is enabled.
• euCode: string
  Title: EU Code

  The EU code of the territory. For example, for Germany this would be 004.
• isoNumericCode: string
  Title: ISO Numeric Code

  The ISO numeric code of the territory. For example, for Australia this would be 036.
• isoTerritoryCode: string
  Title: ISO Territory Code

  The ISO territory code. For example, for Germany this would be DEU.
• nlsTerritory: string
  Title: NLS Territory

  The NLS territory value. For example, for Germany this would be GERMANY.
• obsoleteFlag: boolean
  Title: Territory Obsolete

  Indicates if a territory is obsolete.
• territoryCode: string
  Title: Territory Code

  The unique code of the territory.
• territoryShortName: string
  Title: Territory Short Name

  The name of the territory.
• timeCreated: string
  Title: Created On

  The date and time when the record was created.
• timeUpdated: string
  Title: Last Updated Date

  The date and time when the record was last updated.
• updatedBy: string
  Title: Last Updated By

  The user who last updated the record.

{
    "type":"object",
    "properties":{
        "territoryCode":{
            "title":"Territory Code",
            "description":"The unique code of the territory.",
            "type":"string"
        },
        "euCode":{
            "title":"EU Code",
            "description":"The EU code of the territory. For example, for Germany this would be 004.",
            "type":"string"
        },
        "isoNumericCode":{
            "title":"ISO Numeric Code",
            "description":"The ISO numeric code of the territory. For example, for Australia this would be 036.",
            "type":"string"
        },
        "alternateTerritoryCode":{
            "title":"Alternate Territory Code",
            "description":"The alternate code of the territory. For example, for Germany this would be de-DE.",
            "type":"string"
        },
        "nlsTerritory":{
            "title":"NLS Territory",
            "description":"The NLS territory value. For example, for Germany this would be GERMANY.",
            "type":"string"
        },
        "isoTerritoryCode":{
            "title":"ISO Territory Code",
            "description":"The ISO territory code. For example, for Germany this would be DEU.",
            "type":"string"
        },
        "obsoleteFlag":{
            "title":"Territory Obsolete",
            "description":"Indicates if a territory is obsolete.",
            "type":"boolean"
        },
        "enabledFlag":{
            "title":"Territory Enabled",
            "description":"Indicates if a territory is enabled.",
            "type":"boolean"
        },
        "timeCreated":{
            "title":"Created On",
            "description":"The date and time when the record was created.",
            "type":"string"
        },
        "createdBy":{
            "title":"Created By",
            "description":"The user who created the record.",
            "type":"string"
        },
        "timeUpdated":{
            "title":"Last Updated Date",
            "description":"The date and time when the record was last updated.",
            "type":"string"
        },
        "updatedBy":{
            "title":"Last Updated By",
            "description":"The user who last updated the record.",
            "type":"string"
        },
        "description":{
            "title":"Territory Description",
            "description":"The description of the territory.",
            "type":"string"
        },
        "$sourceLang":{
            "title":"Source Language",
            "description":"The language in which the values of the translatable columns were created, updated, or copied from.",
            "type":"string"
        },
        "territoryShortName":{
            "title":"Territory Short Name",
            "description":"The name of the territory.",
            "type":"string"
        }
    }
}

Nested Schema : Country

Type: object

Title: Country

Country name for the location address.

Nested Schema : oraHcmHrCoreWorkStructures.LocationAddress_item-fields

Match All

Show Source

• object oraHcmHrCoreWorkStructures.LocationAddressBase_abstract-item
• object oraHcmHrCoreWorkStructures.LocationAddress_item-fields-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/oraHcmHrCoreWorkStructures.LocationAddress_abstract-item"
        },
        {
            "type":"object",
            "properties":{
                "effectiveStartDate":{
                    "title":"Effective Start Date",
                    "description":"Effective start date for the location address.",
                    "type":"string"
                },
                "effectiveEndDate":{
                    "title":"Effective End Date",
                    "description":"Effective end date for the location address.",
                    "type":"string"
                },
                "type":{
                    "title":"Type",
                    "description":"Type of the address usage.",
                    "type":"string"
                },
                "id":{
                    "title":"Address ID",
                    "description":"Surrogate identifier for the address of a person.",
                    "type":"string"
                },
                "createdBy":{
                    "title":"Created By",
                    "description":"The user who created the record.",
                    "type":"string"
                },
                "timeCreated":{
                    "title":"Creation Date",
                    "description":"The date and time when the record was created.",
                    "type":"string"
                },
                "updatedBy":{
                    "title":"Last Updated By",
                    "description":"The user who last updated the record.",
                    "type":"string"
                },
                "timeUpdated":{
                    "title":"Last Updated Date",
                    "description":"The date and time when the record was last updated.",
                    "type":"string"
                },
                "building":{
                    "title":"Building",
                    "description":"Building name of the address.",
                    "type":"string"
                },
                "floorNumber":{
                    "title":"Floor Number",
                    "description":"Floor number of the address.",
                    "type":"string"
                },
                "townOrCity":{
                    "title":"Town or City",
                    "description":"Town or city of the location address. This value may be required depending on the country specified.",
                    "type":"string"
                },
                "countryCode":{
                    "title":"Country",
                    "description":"Subregion within the secondary region.",
                    "type":"string"
                },
                "postalCode":{
                    "title":"Postal Code",
                    "description":"Postal code for the location address.",
                    "type":"string"
                },
                "longPostalCode":{
                    "title":"Long Postal Code",
                    "description":"Long postal code for the location address. Long postal codes are used in some countries in addition to the short postal codes.",
                    "type":"string"
                },
                "addressCreatedBy":{
                    "title":"Created By",
                    "description":"User who created the person's address.",
                    "type":"string"
                },
                "addressTimeCreated":{
                    "title":"Creation Date",
                    "description":"Date and time when the person's address was created.",
                    "type":"string"
                },
                "addressTimeUpdated":{
                    "title":"Last Updated Date",
                    "description":"Date and time when the person's address was last updated.",
                    "type":"string"
                },
                "addressUpdatedBy":{
                    "title":"Last Updated By",
                    "description":"User who last updated the person's address.",
                    "type":"string"
                },
                "addressLine1":{
                    "title":"Address Line 1",
                    "description":"First line of the location address.",
                    "type":"string"
                },
                "addressLine2":{
                    "title":"Address Line 2",
                    "description":"Second line of the location address.",
                    "type":"string"
                },
                "addressLine3":{
                    "title":"Address Line 3",
                    "description":"Third line of the location address.",
                    "type":"string"
                },
                "addressLine4":{
                    "title":"Address Line 4",
                    "description":"Fourth line of the location address.",
                    "type":"string"
                },
                "county":{
                    "title":"Region 1",
                    "description":"Primary region in which the person's address is located.",
                    "type":"string"
                },
                "state":{
                    "title":"Region 2",
                    "description":"Secondary region within the primary region in which the person's address is located.",
                    "type":"string"
                },
                "province":{
                    "title":"Region 3",
                    "description":"Additional secondary region within the primary region in which the person's address is located.",
                    "type":"string"
                },
                "singleLineAddress":{
                    "title":"Single Line Address",
                    "description":"Single line address accessor for the location address.",
                    "type":"string"
                },
                "multiLineAddress":{
                    "title":"Multiline Address",
                    "description":"Multiline accessor for the location address.",
                    "type":"string"
                }
            }
        }
    ]
}

Nested Schema : oraHcmHrCoreWorkStructures.LocationAddressBase_abstract-item

Type: object

Show Source

• addressCreatedBy: string
  Read Only: true
• addressLine1: string
  Read Only: true
• addressLine2: string
  Read Only: true
• addressLine3: string
  Read Only: true
• addressLine4: string
  Read Only: true
• addressTimeCreated: string (date-time)
  Read Only: true
• addressTimeUpdated: string (date-time)
  Read Only: true
• addressUpdatedBy: string
  Read Only: true
• building: string
  Read Only: true
• country: country
• countryCode: string
  Read Only: true
• county: string
  Read Only: true
• createdBy: string
  Read Only: true
• effectiveEndDate: string (date)
  Read Only: true
• effectiveStartDate: string (date)
  Read Only: true
• floorNumber: string
  Read Only: true
• id: string (big-integer)
  Read Only: true
• location: location
• longPostalCode: string
  Read Only: true
• multiLineAddress: string
  Read Only: true
• postalCode: string
  Read Only: true
• province: string
  Read Only: true
• singleLineAddress: string
  Read Only: true
• state: string
  Read Only: true
• timeCreated: string (date-time)
  Read Only: true
• timeUpdated: string (date-time)
  Read Only: true
• townOrCity: string
  Read Only: true
• type: type
• updatedBy: string
  Read Only: true

{
    "type":"object",
    "properties":{
        "effectiveStartDate":{
            "type":"string",
            "format":"date",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true
        },
        "effectiveEndDate":{
            "type":"string",
            "format":"date",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true
        },
        "type":{
            "allOf":[
                {
                    "type":"string",
                    "x-searchable":true,
                    "x-sortable":true,
                    "readOnly":true,
                    "x-oj":{
                        "transform":{
                            "path":"boss/EnumMetadataTransforms",
                            "name":"transformEnumExtensions"
                        }
                    }
                },
                {
                    "$ref":"#/components/schemas/oraHcmHrCoreWorkStructures.LocationAddressUsageType_enum"
                }
            ]
        },
        "id":{
            "type":"string",
            "format":"big-integer",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true
        },
        "createdBy":{
            "type":"string",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true
        },
        "timeCreated":{
            "type":"string",
            "format":"date-time",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true
        },
        "updatedBy":{
            "type":"string",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true
        },
        "timeUpdated":{
            "type":"string",
            "format":"date-time",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true
        },
        "building":{
            "type":"string",
            "nullable":true,
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true
        },
        "floorNumber":{
            "type":"string",
            "nullable":true,
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true
        },
        "townOrCity":{
            "type":"string",
            "nullable":true,
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true
        },
        "countryCode":{
            "type":"string",
            "nullable":true,
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true
        },
        "postalCode":{
            "type":"string",
            "nullable":true,
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true
        },
        "longPostalCode":{
            "type":"string",
            "nullable":true,
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true
        },
        "addressCreatedBy":{
            "type":"string",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true
        },
        "addressTimeCreated":{
            "type":"string",
            "format":"date-time",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true
        },
        "addressTimeUpdated":{
            "type":"string",
            "format":"date-time",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true
        },
        "addressUpdatedBy":{
            "type":"string",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true
        },
        "addressLine1":{
            "type":"string",
            "nullable":true,
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true
        },
        "addressLine2":{
            "type":"string",
            "nullable":true,
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true
        },
        "addressLine3":{
            "type":"string",
            "nullable":true,
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true
        },
        "addressLine4":{
            "type":"string",
            "nullable":true,
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true
        },
        "county":{
            "type":"string",
            "nullable":true,
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true
        },
        "state":{
            "type":"string",
            "nullable":true,
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true
        },
        "province":{
            "type":"string",
            "nullable":true,
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true
        },
        "singleLineAddress":{
            "type":"string",
            "readOnly":true
        },
        "multiLineAddress":{
            "type":"string",
            "readOnly":true
        },
        "location":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/oraHcmHrCoreWorkStructures.Location_item-fields"
                },
                {
                    "$ref":"#/components/schemas/__busObj_context"
                },
                {
                    "type":"object",
                    "title":"Location",
                    "description":"Location accessor for the location address.",
                    "x-searchable":true
                }
            ]
        },
        "country":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/oraCommonAppsInfraObjects.Territory_item-fields"
                },
                {
                    "$ref":"#/components/schemas/__busObj_context"
                },
                {
                    "type":"object",
                    "title":"Country",
                    "description":"Country accessor for the location address.",
                    "x-searchable":true
                }
            ]
        }
    },
    "x-primaryKey":[
        "id",
        "effectiveStartDate",
        "effectiveEndDate"
    ]
}

Nested Schema : oraHcmHrCoreWorkStructures.LocationAddress_item-fields-allOf[1]

Type: object

Show Source

• addressCreatedBy: string
  Title: Created By

  User who created the person's address.
• addressLine1: string
  Title: Address Line 1

  First line of the location address.
• addressLine2: string
  Title: Address Line 2

  Second line of the location address.
• addressLine3: string
  Title: Address Line 3

  Third line of the location address.
• addressLine4: string
  Title: Address Line 4

  Fourth line of the location address.
• addressTimeCreated: string
  Title: Creation Date

  Date and time when the person's address was created.
• addressTimeUpdated: string
  Title: Last Updated Date

  Date and time when the person's address was last updated.
• addressUpdatedBy: string
  Title: Last Updated By

  User who last updated the person's address.
• building: string
  Title: Building

  Building name of the address.
• countryCode: string
  Title: Country

  Subregion within the secondary region.
• county: string
  Title: Region 1

  Primary region in which the person's address is located.
• createdBy: string
  Title: Created By

  The user who created the record.
• effectiveEndDate: string
  Title: Effective End Date

  Effective end date for the location address.
• effectiveStartDate: string
  Title: Effective Start Date

  Effective start date for the location address.
• floorNumber: string
  Title: Floor Number

  Floor number of the address.
• id: string
  Title: Address ID

  Surrogate identifier for the address of a person.
• longPostalCode: string
  Title: Long Postal Code

  Long postal code for the location address. Long postal codes are used in some countries in addition to the short postal codes.
• multiLineAddress: string
  Title: Multiline Address

  Multiline accessor for the location address.
• postalCode: string
  Title: Postal Code

  Postal code for the location address.
• province: string
  Title: Region 3

  Additional secondary region within the primary region in which the person's address is located.
• singleLineAddress: string
  Title: Single Line Address

  Single line address accessor for the location address.
• state: string
  Title: Region 2

  Secondary region within the primary region in which the person's address is located.
• timeCreated: string
  Title: Creation Date

  The date and time when the record was created.
• timeUpdated: string
  Title: Last Updated Date

  The date and time when the record was last updated.
• townOrCity: string
  Title: Town or City

  Town or city of the location address. This value may be required depending on the country specified.
• type: string
  Title: Type

  Type of the address usage.
• updatedBy: string
  Title: Last Updated By

  The user who last updated the record.

{
    "type":"object",
    "properties":{
        "effectiveStartDate":{
            "title":"Effective Start Date",
            "description":"Effective start date for the location address.",
            "type":"string"
        },
        "effectiveEndDate":{
            "title":"Effective End Date",
            "description":"Effective end date for the location address.",
            "type":"string"
        },
        "type":{
            "title":"Type",
            "description":"Type of the address usage.",
            "type":"string"
        },
        "id":{
            "title":"Address ID",
            "description":"Surrogate identifier for the address of a person.",
            "type":"string"
        },
        "createdBy":{
            "title":"Created By",
            "description":"The user who created the record.",
            "type":"string"
        },
        "timeCreated":{
            "title":"Creation Date",
            "description":"The date and time when the record was created.",
            "type":"string"
        },
        "updatedBy":{
            "title":"Last Updated By",
            "description":"The user who last updated the record.",
            "type":"string"
        },
        "timeUpdated":{
            "title":"Last Updated Date",
            "description":"The date and time when the record was last updated.",
            "type":"string"
        },
        "building":{
            "title":"Building",
            "description":"Building name of the address.",
            "type":"string"
        },
        "floorNumber":{
            "title":"Floor Number",
            "description":"Floor number of the address.",
            "type":"string"
        },
        "townOrCity":{
            "title":"Town or City",
            "description":"Town or city of the location address. This value may be required depending on the country specified.",
            "type":"string"
        },
        "countryCode":{
            "title":"Country",
            "description":"Subregion within the secondary region.",
            "type":"string"
        },
        "postalCode":{
            "title":"Postal Code",
            "description":"Postal code for the location address.",
            "type":"string"
        },
        "longPostalCode":{
            "title":"Long Postal Code",
            "description":"Long postal code for the location address. Long postal codes are used in some countries in addition to the short postal codes.",
            "type":"string"
        },
        "addressCreatedBy":{
            "title":"Created By",
            "description":"User who created the person's address.",
            "type":"string"
        },
        "addressTimeCreated":{
            "title":"Creation Date",
            "description":"Date and time when the person's address was created.",
            "type":"string"
        },
        "addressTimeUpdated":{
            "title":"Last Updated Date",
            "description":"Date and time when the person's address was last updated.",
            "type":"string"
        },
        "addressUpdatedBy":{
            "title":"Last Updated By",
            "description":"User who last updated the person's address.",
            "type":"string"
        },
        "addressLine1":{
            "title":"Address Line 1",
            "description":"First line of the location address.",
            "type":"string"
        },
        "addressLine2":{
            "title":"Address Line 2",
            "description":"Second line of the location address.",
            "type":"string"
        },
        "addressLine3":{
            "title":"Address Line 3",
            "description":"Third line of the location address.",
            "type":"string"
        },
        "addressLine4":{
            "title":"Address Line 4",
            "description":"Fourth line of the location address.",
            "type":"string"
        },
        "county":{
            "title":"Region 1",
            "description":"Primary region in which the person's address is located.",
            "type":"string"
        },
        "state":{
            "title":"Region 2",
            "description":"Secondary region within the primary region in which the person's address is located.",
            "type":"string"
        },
        "province":{
            "title":"Region 3",
            "description":"Additional secondary region within the primary region in which the person's address is located.",
            "type":"string"
        },
        "singleLineAddress":{
            "title":"Single Line Address",
            "description":"Single line address accessor for the location address.",
            "type":"string"
        },
        "multiLineAddress":{
            "title":"Multiline Address",
            "description":"Multiline accessor for the location address.",
            "type":"string"
        }
    }
}

Nested Schema : Main Address

Type: object

Title: Main Address

Main address accessor for the location.

Nested Schema : country

Match All

Country accessor for the location address.

Show Source

• allOf oraCommonAppsInfraObjects.Territory_item-fields
• object __busObj_context
• object Country
  Title: Country

  Country accessor for the location address.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/oraCommonAppsInfraObjects.Territory_item-fields"
        },
        {
            "$ref":"#/components/schemas/__busObj_context"
        },
        {
            "type":"object",
            "title":"Country",
            "description":"Country accessor for the location address.",
            "x-searchable":true
        }
    ]
}

Nested Schema : location

Match All

Location accessor for the location address.

Show Source

• allOf oraHcmHrCoreWorkStructures.Location_item-fields
• object __busObj_context
• object Location
  Title: Location

  Location accessor for the location address.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/oraHcmHrCoreWorkStructures.Location_item-fields"
        },
        {
            "$ref":"#/components/schemas/__busObj_context"
        },
        {
            "type":"object",
            "title":"Location",
            "description":"Location accessor for the location address.",
            "x-searchable":true
        }
    ]
}

Nested Schema : type

Match All

Show Source

• string
  Read Only: true
• string
  Allowed Values: [ "BILL", "BUSN", "CHK", "CODE", "H", "LEGL", "MAILING", "MAIN", "OTH", "T" ]

{
    "allOf":[
        {
            "type":"string",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true,
            "x-oj":{
                "transform":{
                    "path":"boss/EnumMetadataTransforms",
                    "name":"transformEnumExtensions"
                }
            }
        },
        {
            "$ref":"#/components/schemas/oraHcmHrCoreWorkStructures.LocationAddressUsageType_enum"
        }
    ]
}

Nested Schema : Country

Type: object

Title: Country

Country accessor for the location address.

Nested Schema : Location

Type: object

Title: Location

Location accessor for the location address.

Nested Schema : oraCommonAppsInfraObjects.SetIdSet_item-fields

Match All

Show Source

• object oraCommonAppsInfraObjects.SetIdSet_abstract-item
• object oraCommonAppsInfraObjects.SetIdSet_item-fields-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/oraCommonAppsInfraObjects.SetIdSet_abstract-item"
        },
        {
            "type":"object",
            "properties":{
                "setId":{
                    "title":"Set ID",
                    "description":"The unique identifier of the set ID set.",
                    "type":"string"
                },
                "setCode":{
                    "title":"Set Code",
                    "description":"The unique code that identifies the set ID set.",
                    "type":"string"
                },
                "createdBy":{
                    "title":"Created By",
                    "description":"The user who created the record.",
                    "type":"string"
                },
                "timeCreated":{
                    "title":"Created On",
                    "description":"The date and time when the record was created.",
                    "type":"string"
                },
                "updatedBy":{
                    "title":"Last Updated By",
                    "description":"The user who last updated the record.",
                    "type":"string"
                },
                "timeUpdated":{
                    "title":"Last Updated Date",
                    "description":"The date and time when the record was last updated.",
                    "type":"string"
                },
                "description":{
                    "title":"Set Description",
                    "description":"The description of the set ID set.",
                    "type":"string"
                },
                "$sourceLang":{
                    "title":"Source Language",
                    "description":"The language in which the values of the translatable columns were created, updated, or copied from.",
                    "type":"string"
                },
                "setName":{
                    "title":"Set Name",
                    "description":"The descriptive name of the Set ID Set.",
                    "type":"string"
                }
            }
        }
    ]
}

Nested Schema : oraCommonAppsInfraObjects.SetIdSet_abstract-item

Type: object

Show Source

• $sourceLang: string
  Read Only: true
• createdBy: string
  Read Only: true
• description: string
  Read Only: true
• setCode: string
  Read Only: true
• setId: string (big-integer)
  Read Only: true
• setName: string
  Read Only: true
• timeCreated: string (date-time)
  Read Only: true
• timeUpdated: string (date-time)
  Read Only: true
• updatedBy: string
  Read Only: true

{
    "type":"object",
    "properties":{
        "setId":{
            "type":"string",
            "format":"big-integer",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true
        },
        "setCode":{
            "type":"string",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true
        },
        "createdBy":{
            "type":"string",
            "readOnly":true
        },
        "timeCreated":{
            "type":"string",
            "format":"date-time",
            "x-searchable":true,
            "readOnly":true
        },
        "updatedBy":{
            "type":"string",
            "readOnly":true
        },
        "timeUpdated":{
            "type":"string",
            "format":"date-time",
            "x-searchable":true,
            "readOnly":true
        },
        "description":{
            "type":"string",
            "readOnly":true
        },
        "$sourceLang":{
            "type":"string",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true
        },
        "setName":{
            "type":"string",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true
        }
    },
    "x-primaryKey":[
        "setId"
    ]
}

Nested Schema : oraCommonAppsInfraObjects.SetIdSet_item-fields-allOf[1]

Type: object

Show Source

• $sourceLang: string
  Title: Source Language

  The language in which the values of the translatable columns were created, updated, or copied from.
• createdBy: string
  Title: Created By

  The user who created the record.
• description: string
  Title: Set Description

  The description of the set ID set.
• setCode: string
  Title: Set Code

  The unique code that identifies the set ID set.
• setId: string
  Title: Set ID

  The unique identifier of the set ID set.
• setName: string
  Title: Set Name

  The descriptive name of the Set ID Set.
• timeCreated: string
  Title: Created On

  The date and time when the record was created.
• timeUpdated: string
  Title: Last Updated Date

  The date and time when the record was last updated.
• updatedBy: string
  Title: Last Updated By

  The user who last updated the record.

{
    "type":"object",
    "properties":{
        "setId":{
            "title":"Set ID",
            "description":"The unique identifier of the set ID set.",
            "type":"string"
        },
        "setCode":{
            "title":"Set Code",
            "description":"The unique code that identifies the set ID set.",
            "type":"string"
        },
        "createdBy":{
            "title":"Created By",
            "description":"The user who created the record.",
            "type":"string"
        },
        "timeCreated":{
            "title":"Created On",
            "description":"The date and time when the record was created.",
            "type":"string"
        },
        "updatedBy":{
            "title":"Last Updated By",
            "description":"The user who last updated the record.",
            "type":"string"
        },
        "timeUpdated":{
            "title":"Last Updated Date",
            "description":"The date and time when the record was last updated.",
            "type":"string"
        },
        "description":{
            "title":"Set Description",
            "description":"The description of the set ID set.",
            "type":"string"
        },
        "$sourceLang":{
            "title":"Source Language",
            "description":"The language in which the values of the translatable columns were created, updated, or copied from.",
            "type":"string"
        },
        "setName":{
            "title":"Set Name",
            "description":"The descriptive name of the Set ID Set.",
            "type":"string"
        }
    }
}

Nested Schema : Set Id Set

Type: object

Title: Set Id Set

Set Id set accessor for the location.

Nested Schema : oraCommonAppsInfraObjects.Timezone_item-fields

Type: object

Show Source

• $sourceLang: string
  Title: Source Language

  Read Only: true

  The language in which the values of the translatable columns were created, updated, or copied from.
• createdBy: string
  Title: Created By

  Read Only: true

  The user who created the record.
• enabledFlag: boolean
  Title: Time Zone Enabled

  Read Only: true

  Indicates if the time zone is enabled.
• name: string
  Title: Time Zone Name

  Read Only: true

  The name of the time zone.
• timeCreated: string (date-time)
  Title: Created On

  Read Only: true

  The date and time when the record was created.
• timeUpdated: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time when the record was last updated.
• timezoneCode: string
  Title: Time Zone Code

  Read Only: true

  The unique code that identifies the time zone.
• updatedBy: string
  Title: Last Updated By

  Read Only: true

  The user who last updated the record.

{
    "type":"object",
    "properties":{
        "timezoneCode":{
            "type":"string",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true,
            "title":"Time Zone Code",
            "description":"The unique code that identifies the time zone."
        },
        "name":{
            "type":"string",
            "readOnly":true,
            "title":"Time Zone Name",
            "description":"The name of the time zone."
        },
        "enabledFlag":{
            "type":"boolean",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true,
            "title":"Time Zone Enabled",
            "description":"Indicates if the time zone is enabled."
        },
        "timeCreated":{
            "type":"string",
            "format":"date-time",
            "readOnly":true,
            "title":"Created On",
            "description":"The date and time when the record was created."
        },
        "createdBy":{
            "type":"string",
            "readOnly":true,
            "title":"Created By",
            "description":"The user who created the record."
        },
        "timeUpdated":{
            "type":"string",
            "format":"date-time",
            "readOnly":true,
            "title":"Last Updated Date",
            "description":"The date and time when the record was last updated."
        },
        "updatedBy":{
            "type":"string",
            "readOnly":true,
            "title":"Last Updated By",
            "description":"The user who last updated the record."
        },
        "$sourceLang":{
            "type":"string",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true,
            "title":"Source Language",
            "description":"The language in which the values of the translatable columns were created, updated, or copied from."
        }
    },
    "x-primaryKey":[
        "timezoneCode"
    ]
}

Nested Schema : Time Zone

Type: object

Title: Time Zone

Time zone code for the location address.

Nested Schema : businessUnit

Match One Schema

Show Source

• object businessUnit-oneOf[0]
• object businessUnit-oneOf[1]
• object __busObj_context

{
    "oneOf":[
        {
            "type":"object",
            "properties":{
                "id":{
                    "$ref":"#/components/schemas/oraErpCoreStructure.BusinessUnit_item-fields/allOf/0/properties/id"
                },
                "effectiveStartDate":{
                    "$ref":"#/components/schemas/oraErpCoreStructure.BusinessUnit_item-fields/allOf/0/properties/effectiveStartDate"
                },
                "effectiveEndDate":{
                    "$ref":"#/components/schemas/oraErpCoreStructure.BusinessUnit_item-fields/allOf/0/properties/effectiveEndDate"
                }
            }
        },
        {
            "type":"object",
            "properties":{
                "id":{
                    "$ref":"#/components/schemas/oraErpCoreStructure.BusinessUnit_item-fields/allOf/0/properties/id"
                }
            }
        },
        {
            "$ref":"#/components/schemas/__busObj_context"
        }
    ]
}

Nested Schema : businessUnit-oneOf[0]

Type: object

Show Source

• effectiveEndDate: string (date)
  Title: End Date

  Read Only: true

  The end date of the date range within which the business unit is effective.
• effectiveStartDate: string (date)
  Title: Start Date

  Read Only: true

  The start date of the date range within which the business unit is effective.
• id: string (big-integer)
  Title: Business Unit ID

  Read Only: true

  The unique identifier of the business unit.

{
    "type":"object",
    "properties":{
        "id":{
            "$ref":"#/components/schemas/oraErpCoreStructure.BusinessUnit_item-fields/allOf/0/properties/id"
        },
        "effectiveStartDate":{
            "$ref":"#/components/schemas/oraErpCoreStructure.BusinessUnit_item-fields/allOf/0/properties/effectiveStartDate"
        },
        "effectiveEndDate":{
            "$ref":"#/components/schemas/oraErpCoreStructure.BusinessUnit_item-fields/allOf/0/properties/effectiveEndDate"
        }
    }
}

Nested Schema : businessUnit-oneOf[1]

Type: object

Show Source

• id: string (big-integer)
  Title: Business Unit ID

  Read Only: true

  The unique identifier of the business unit.

{
    "type":"object",
    "properties":{
        "id":{
            "$ref":"#/components/schemas/oraErpCoreStructure.BusinessUnit_item-fields/allOf/0/properties/id"
        }
    }
}

Back to Top

Response

Default Response

no content

Back to Top

Examples

The following example shows how to update a service business profile unit by submitting a PATCH request on the REST resource using cURL.

cURL Command

curl --request PATCH --location 'https://servername.fa.us2.oraclecloud.com/api/boss/data/objects/ora/cxServiceCore/common/v1/$en-US/serviceBusinessUnits/<option_id>' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <token>' \
--header 'If-Match: <etag>' \

Example of Request Body

The following shows the contents of the request body in JSON format.

{
  "profileOptionValue": "[e-mail]",
  "siteLevelValueFlag": true
}

Example of Response Body

The following shows the contents of the response body in JSON format.

204 No Content

Back to Top