Jump to

• Request
• Response
• Examples

Update a worker address

patch

/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/addresses/{addressesUniqID}

Request

Path Parameters

• addressesUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Addresses resource and used to uniquely identify an instance of Addresses. The client should not generate the hash key value. Instead, the client should query on the Addresses collection resource in order to navigate to a specific instance of Addresses to get the hash key.
• workersUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Workers resource and used to uniquely identify an instance of Workers. The client should not generate the hash key value. Instead, the client should query on the Workers collection resource in order to navigate to a specific instance of Workers to get the hash key.

Header Parameters

• Effective-Of:
  This header accepts a string value. The string is a semi-colon separated list of =. It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers.
• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• AddlAddressAttribute1: string
  Title: Additional Address Attribute 1

  Maximum Length: 150

  Additional address column used by localizations.
• AddlAddressAttribute2: string
  Title: Additional Address Attribute 2

  Maximum Length: 150

  Additional address column used by localizations.
• AddlAddressAttribute3: string
  Title: Additional Address Attribute 3

  Maximum Length: 150

  Additional address column used by localizations.
• AddlAddressAttribute4: string
  Title: Additional Address Attribute 4

  Maximum Length: 150

  Additional address column used by localizations.
• AddlAddressAttribute5: string
  Title: Additional Address Attribute 5

  Maximum Length: 150

  Additional address column used by localizations.
• addressesDFF: array addressesDFF
• AddressLine1: string
  Title: Address Line 1

  Maximum Length: 240

  First line of the primary mail address.
• AddressLine2: string
  Title: Address Line 2

  Maximum Length: 240

  Second line of the primary mail address.
• AddressLine3: string
  Title: Address Line 3

  Maximum Length: 240

  Third line of the primary mail address.
• AddressLine4: string
  Title: Address Line 4

  Maximum Length: 240

  Fourth line of the primary mail address.
• Building: string
  Title: Building

  Maximum Length: 240

  Building information associated with the address.
• EffectiveEndDate: string (date)
  Title: Effective End Date

  End date of the date-effective changes to the record.
• EffectiveStartDate: string (date)
  Title: Effective Start Date

  Start date of the date-effective changes to the record.
• FloorNumber: string
  Title: Floor Number

  Maximum Length: 40

  Floor number associated with the building.
• Latitude: number
  Title: Latitude

  Distance between the equator and an address located to its north or south, expressed in degrees and minutes.
• Longitude: number
  Title: Longitude

  Distance between the prime meridian and an address located to its east or west, expressed in degrees and minutes.
• LongPostalCode: string
  Title: Long Postal Code

  Maximum Length: 30

  Long postal code of the primary mail address.
• PostalCode: string
  Title: Postal Code

  Maximum Length: 30

  Postal code of the primary mail address.
• PrimaryFlag: boolean
  Title: Primary Mailing

  Indicates whether the address is the primary mailing address.
• Provider: string
  Title: Provider

  Maximum Length: 150

  Company that has validated the address.
• Region1: string
  Title: Region 1

  Maximum Length: 120

  Primary region in which the address is located.
• Region2: string
  Title: Region 2

  Maximum Length: 120

  Secondary region within the primary region.
• Region3: string
  Title: Region 3

  Maximum Length: 120

  Additional secondary region within the primary region.
• TownOrCity: string
  Title: Town or City

  Maximum Length: 60

  Town or city in which the address is located.
• ValidationStatusCode: string
  Title: Validation Status Code

  Maximum Length: 120

  Level of accuracy of an address, as determined by an address provider.

{
    "type":"object",
    "properties":{
        "Building":{
            "title":"Building",
            "maxLength":"240",
            "type":"string",
            "description":"Building information associated with the address.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "FloorNumber":{
            "title":"Floor Number",
            "maxLength":"40",
            "type":"string",
            "description":"Floor number associated with the building.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "PrimaryFlag":{
            "title":"Primary Mailing",
            "type":"boolean",
            "description":"Indicates whether the address is the primary mailing address.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "PostalCode":{
            "title":"Postal Code",
            "maxLength":"30",
            "type":"string",
            "description":"Postal code of the primary mail address.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "Latitude":{
            "title":"Latitude",
            "type":"number",
            "description":"Distance between the equator and an address located to its north or south, expressed in degrees and minutes.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "TownOrCity":{
            "title":"Town or City",
            "maxLength":"60",
            "type":"string",
            "description":"Town or city in which the address is located.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "AddlAddressAttribute5":{
            "title":"Additional Address Attribute 5",
            "maxLength":"150",
            "type":"string",
            "description":"Additional address column used by localizations.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "AddlAddressAttribute4":{
            "title":"Additional Address Attribute 4",
            "maxLength":"150",
            "type":"string",
            "description":"Additional address column used by localizations.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "AddlAddressAttribute3":{
            "title":"Additional Address Attribute 3",
            "maxLength":"150",
            "type":"string",
            "description":"Additional address column used by localizations.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "EffectiveEndDate":{
            "title":"Effective End Date",
            "type":"string",
            "description":"End date of the date-effective changes to the record.",
            "format":"date",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "ValidationStatusCode":{
            "title":"Validation Status Code",
            "maxLength":"120",
            "type":"string",
            "description":"Level of accuracy of an address, as determined by an address provider.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "LongPostalCode":{
            "title":"Long Postal Code",
            "maxLength":"30",
            "type":"string",
            "description":"Long postal code of the primary mail address.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "Region1":{
            "title":"Region 1",
            "maxLength":"120",
            "type":"string",
            "description":"Primary region in which the address is located.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "AddlAddressAttribute2":{
            "title":"Additional Address Attribute 2",
            "maxLength":"150",
            "type":"string",
            "description":"Additional address column used by localizations.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "AddlAddressAttribute1":{
            "title":"Additional Address Attribute 1",
            "maxLength":"150",
            "type":"string",
            "description":"Additional address column used by localizations.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "Region3":{
            "title":"Region 3",
            "maxLength":"120",
            "type":"string",
            "description":"Additional secondary region within the primary region.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "Region2":{
            "title":"Region 2",
            "maxLength":"120",
            "type":"string",
            "description":"Secondary region within the primary region.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "Longitude":{
            "title":"Longitude",
            "type":"number",
            "description":"Distance between the prime meridian and an address located to its east or west, expressed in degrees and minutes.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "Provider":{
            "title":"Provider",
            "maxLength":"150",
            "type":"string",
            "description":"Company that has validated the address.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "AddressLine3":{
            "title":"Address Line 3",
            "maxLength":"240",
            "type":"string",
            "description":"Third line of the primary mail address.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "AddressLine2":{
            "title":"Address Line 2",
            "maxLength":"240",
            "type":"string",
            "description":"Second line of the primary mail address.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "AddressLine1":{
            "title":"Address Line 1",
            "maxLength":"240",
            "type":"string",
            "description":"First line of the primary mail address.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "addressesDFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/workers-addresses-addressesDFF-item-patch-request"
            },
            "x-cardinality":"1"
        },
        "AddressLine4":{
            "title":"Address Line 4",
            "maxLength":"240",
            "type":"string",
            "description":"Fourth line of the primary mail address.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "EffectiveStartDate":{
            "title":"Effective Start Date",
            "type":"string",
            "description":"Start date of the date-effective changes to the record.",
            "format":"date",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        }
    }
}

Nested Schema : addressesDFF

Type: array

Show Source

• Array of: object workers-addresses-addressesDFF-item-patch-request

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/workers-addresses-addressesDFF-item-patch-request"
    },
    "x-cardinality":"1"
}

Nested Schema : workers-addresses-addressesDFF-item-patch-request

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Value

  Maximum Length: 30
• __FLEX_Context_DisplayValue: string
  Title: Context Value
• EffectiveEndDate: string (date)
  Title: Effective End Date
• EffectiveStartDate: string (date)
  Title: Effective Start Date

{
    "type":"object",
    "properties":{
        "EffectiveEndDate":{
            "title":"Effective End Date",
            "type":"string",
            "format":"date",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true
            }
        },
        "EffectiveStartDate":{
            "title":"Effective Start Date",
            "type":"string",
            "format":"date",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true
            }
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Value",
            "type":"string",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"HIDDEN"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "__FLEX_Context":{
            "title":"Context Value",
            "maxLength":"30",
            "type":"string",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"HIDDEN"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : workers-addresses-item-response

Type: object

Show Source

• AddlAddressAttribute1: string
  Title: Additional Address Attribute 1

  Maximum Length: 150

  Additional address column used by localizations.
• AddlAddressAttribute2: string
  Title: Additional Address Attribute 2

  Maximum Length: 150

  Additional address column used by localizations.
• AddlAddressAttribute3: string
  Title: Additional Address Attribute 3

  Maximum Length: 150

  Additional address column used by localizations.
• AddlAddressAttribute4: string
  Title: Additional Address Attribute 4

  Maximum Length: 150

  Additional address column used by localizations.
• AddlAddressAttribute5: string
  Title: Additional Address Attribute 5

  Maximum Length: 150

  Additional address column used by localizations.
• addressesDFF: array addressesDFF
• AddressId: integer (int64)
  Title: Address ID

  Surrogate identifier for the address record.
• AddressLine1: string
  Title: Address Line 1

  Maximum Length: 240

  First line of the primary mail address.
• AddressLine2: string
  Title: Address Line 2

  Maximum Length: 240

  Second line of the primary mail address.
• AddressLine3: string
  Title: Address Line 3

  Maximum Length: 240

  Third line of the primary mail address.
• AddressLine4: string
  Title: Address Line 4

  Maximum Length: 240

  Fourth line of the primary mail address.
• AddressType: string
  Title: Type

  Maximum Length: 30

  Type of address. Valid values are defined in the commonLookupsLOV.
• AddressTypeMeaning: string
  Title: Address Type

  Read Only: true

  Maximum Length: 80

  Meaning of the person's address type.
• Building: string
  Title: Building

  Maximum Length: 240

  Building information associated with the address.
• Country: string
  Title: Country

  Maximum Length: 60

  Country in which the address is located. Valid values are defined in the hcmCountriesLov.
• CountryName: string
  Title: Country

  Read Only: true

  Maximum Length: 80

  Name of the country in which the person's address is located.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  User who created the address.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  Date and time when the address was created.
• EffectiveEndDate: string (date)
  Title: Effective End Date

  End date of the date-effective changes to the record.
• EffectiveStartDate: string (date)
  Title: Effective Start Date

  Start date of the date-effective changes to the record.
• FloorNumber: string
  Title: Floor Number

  Maximum Length: 40

  Floor number associated with the building.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  Date and time when the address was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  User who last updated the address.
• Latitude: number
  Title: Latitude

  Distance between the equator and an address located to its north or south, expressed in degrees and minutes.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Longitude: number
  Title: Longitude

  Distance between the prime meridian and an address located to its east or west, expressed in degrees and minutes.
• LongPostalCode: string
  Title: Long Postal Code

  Maximum Length: 30

  Long postal code of the primary mail address.
• PersonAddrUsageId: integer (int64)
  Title: Person Address Usage ID

  Read Only: true

  Surrogate identifier for the address usage record.
• PostalCode: string
  Title: Postal Code

  Maximum Length: 30

  Postal code of the primary mail address.
• PrimaryFlag: boolean
  Title: Primary Mailing

  Indicates whether the address is the primary mailing address.
• Provider: string
  Title: Provider

  Maximum Length: 150

  Company that has validated the address.
• Region1: string
  Title: Region 1

  Maximum Length: 120

  Primary region in which the address is located.
• Region2: string
  Title: Region 2

  Maximum Length: 120

  Secondary region within the primary region.
• Region3: string
  Title: Region 3

  Maximum Length: 120

  Additional secondary region within the primary region.
• TownOrCity: string
  Title: Town or City

  Maximum Length: 60

  Town or city in which the address is located.
• ValidationStatusCode: string
  Title: Validation Status Code

  Maximum Length: 120

  Level of accuracy of an address, as determined by an address provider.

{
    "type":"object",
    "properties":{
        "Building":{
            "title":"Building",
            "maxLength":"240",
            "type":"string",
            "description":"Building information associated with the address.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date and time when the address was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "FloorNumber":{
            "title":"Floor Number",
            "maxLength":"40",
            "type":"string",
            "description":"Floor number associated with the building.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "PrimaryFlag":{
            "title":"Primary Mailing",
            "type":"boolean",
            "description":"Indicates whether the address is the primary mailing address.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "AddressTypeMeaning":{
            "title":"Address Type",
            "maxLength":"80",
            "type":"string",
            "description":"Meaning of the person's address type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CountryName":{
            "title":"Country",
            "maxLength":"80",
            "type":"string",
            "description":"Name of the country in which the person's address is located.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PostalCode":{
            "title":"Postal Code",
            "maxLength":"30",
            "type":"string",
            "description":"Postal code of the primary mail address.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "Latitude":{
            "title":"Latitude",
            "type":"number",
            "description":"Distance between the equator and an address located to its north or south, expressed in degrees and minutes.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "TownOrCity":{
            "title":"Town or City",
            "maxLength":"60",
            "type":"string",
            "description":"Town or city in which the address is located.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "AddlAddressAttribute5":{
            "title":"Additional Address Attribute 5",
            "maxLength":"150",
            "type":"string",
            "description":"Additional address column used by localizations.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "AddlAddressAttribute4":{
            "title":"Additional Address Attribute 4",
            "maxLength":"150",
            "type":"string",
            "description":"Additional address column used by localizations.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "AddlAddressAttribute3":{
            "title":"Additional Address Attribute 3",
            "maxLength":"150",
            "type":"string",
            "description":"Additional address column used by localizations.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AddressId":{
            "title":"Address ID",
            "type":"integer",
            "description":"Surrogate identifier for the address record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"User who last updated the address.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "PersonAddrUsageId":{
            "title":"Person Address Usage ID",
            "type":"integer",
            "description":"Surrogate identifier for the address usage record.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"User who created the address.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "EffectiveEndDate":{
            "title":"Effective End Date",
            "type":"string",
            "description":"End date of the date-effective changes to the record.",
            "format":"date",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ValidationStatusCode":{
            "title":"Validation Status Code",
            "maxLength":"120",
            "type":"string",
            "description":"Level of accuracy of an address, as determined by an address provider.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "LongPostalCode":{
            "title":"Long Postal Code",
            "maxLength":"30",
            "type":"string",
            "description":"Long postal code of the primary mail address.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "Region1":{
            "title":"Region 1",
            "maxLength":"120",
            "type":"string",
            "description":"Primary region in which the address is located.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "AddlAddressAttribute2":{
            "title":"Additional Address Attribute 2",
            "maxLength":"150",
            "type":"string",
            "description":"Additional address column used by localizations.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "AddlAddressAttribute1":{
            "title":"Additional Address Attribute 1",
            "maxLength":"150",
            "type":"string",
            "description":"Additional address column used by localizations.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "Region3":{
            "title":"Region 3",
            "maxLength":"120",
            "type":"string",
            "description":"Additional secondary region within the primary region.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "Region2":{
            "title":"Region 2",
            "maxLength":"120",
            "type":"string",
            "description":"Secondary region within the primary region.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "Longitude":{
            "title":"Longitude",
            "type":"number",
            "description":"Distance between the prime meridian and an address located to its east or west, expressed in degrees and minutes.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "Provider":{
            "title":"Provider",
            "maxLength":"150",
            "type":"string",
            "description":"Company that has validated the address.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "AddressLine3":{
            "title":"Address Line 3",
            "maxLength":"240",
            "type":"string",
            "description":"Third line of the primary mail address.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "AddressLine2":{
            "title":"Address Line 2",
            "maxLength":"240",
            "type":"string",
            "description":"Second line of the primary mail address.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "AddressLine1":{
            "title":"Address Line 1",
            "maxLength":"240",
            "type":"string",
            "description":"First line of the primary mail address.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "addressesDFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/workers-addresses-addressesDFF-item-response"
            },
            "x-cardinality":"1"
        },
        "AddressLine4":{
            "title":"Address Line 4",
            "maxLength":"240",
            "type":"string",
            "description":"Fourth line of the primary mail address.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "Country":{
            "title":"Country",
            "maxLength":"60",
            "type":"string",
            "description":"Country in which the address is located. Valid values are defined in the hcmCountriesLov.",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "AddressType":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"Type of address. Valid values are defined in the commonLookupsLOV.",
            "nullable":false,
            "x-hints":{
                "controlType":"default",
                "includeInCompactView":true,
                "dependencies":[
                    "Country"
                ]
            },
            "x-queryable":true
        },
        "EffectiveStartDate":{
            "title":"Effective Start Date",
            "type":"string",
            "description":"Start date of the date-effective changes to the record.",
            "format":"date",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"Date and time when the address was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        }
    }
}

Nested Schema : addressesDFF

Type: array

Show Source

• Array of: object workers-addresses-addressesDFF-item-response

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/workers-addresses-addressesDFF-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : workers-addresses-addressesDFF-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Value

  Maximum Length: 30
• __FLEX_Context_DisplayValue: string
  Title: Context Value
• EffectiveEndDate: string (date)
  Title: Effective End Date
• EffectiveStartDate: string (date)
  Title: Effective Start Date
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PersonAddrUsageId: integer (int64)
  Title: Person Address Usage ID

{
    "type":"object",
    "properties":{
        "PersonAddrUsageId":{
            "title":"Person Address Usage ID",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "EffectiveEndDate":{
            "title":"Effective End Date",
            "type":"string",
            "format":"date",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "EffectiveStartDate":{
            "title":"Effective Start Date",
            "type":"string",
            "format":"date",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Value",
            "type":"string",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"HIDDEN"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context Value",
            "maxLength":"30",
            "type":"string",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"HIDDEN"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Links

addressTypesLov

Operation: /fscmRestApi/resources/11.13.18.05/commonLookupsLOV

Parameters:

• finder: LegislationCodeFinder%3BLookupType%3DADDRESS_TYPE%2CLookupCode%3D{AddressType}

The following properties are defined on the LOV link relation:

• Source Attribute: AddressType; Target Attribute: LookupCode
• Display Attribute: Meaning

addressesDFF

Operation: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/addresses/{addressesUniqID}/child/addressesDFF

Parameters:

• addressesUniqID: $request.path.addressesUniqID
• workersUniqID: $request.path.workersUniqID

countriesLov

Operation: /hcmRestApi/resources/11.13.18.05/hcmCountriesLov

The following properties are defined on the LOV link relation:

• Source Attribute: Country; Target Attribute: TerritoryCode
• Display Attribute: TerritoryCode, CountryName

Back to Top

Examples

The following examples show how to update a worker address by submitting a PATCH request on the REST resource using cURL.

Correction

For a correction operation:

• RangeMode , RangeStartDate, and RangeEndDate are required parameters.
• RangeStartDate the same as the EffectiveStartDate of the record.
• RangeEndDate must be the same as the EffectiveEndDate of the record.

curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -H 'REST-Framework-Version: 4' -H "Effective-Of: RangeMode=CORRECTION;RangeStartDate=2015-06-01;RangeEndDate=4712-12-31" -X PATCH -d <payload> "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/workers/00020000000EACED0005770800005AF3116303090000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B59741903000078707708000001616343240078/child/addresses/00020000000EACED00057708000110F08509F3F40000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B59741903000078707708000001616343240078"

Example of Payload

The following is an example of the payload.

{
   "AddressLine1": "No. 3, Block 1"
}

Example of Response Header

The following is an example of the response header.

Status: HTTP/1.1 200 OK
Content-Type : application/vnd.oracle.adf.resourceitem+json

Example of Response Body

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

{
  "AddressId": 300100186928115,
  "EffectiveStartDate": "2015-06-01",
  "EffectiveEndDate": "4712-12-31",
  "AddressLine1": "No. 3, Block 1",
  "AddressLine2": null,
  "AddressLine3": null,
  "AddressLine4": null,
  "TownOrCity": "BRISBANE",
  "Region1": "SAN MATEO",
  "Region2": "CA",
  "Region3": null,
  "Country": "US",
  "PostalCode": "94506",
  "LongPostalCode": null,
  "AddlAddressAttribute1": null,
  "AddlAddressAttribute2": null,
  "AddlAddressAttribute3": null,
  "AddlAddressAttribute4": null,
  "AddlAddressAttribute5": null,
  "CreatedBy": "VMOSS",
  "CreationDate": "2019-05-16T09:18:00+00:00",
  "LastUpdatedBy": "VMOSS",
  "LastUpdateDate": "2019-05-16T09:46:26+00:00",
  "PersonAddrUsageId": 300100186928116,
  "AddressType": "MAIL",
  "PrimaryFlag": false,
  "links": [
      {...
          }
   ]
}

Update

For an update operation:

• RangeMode, RangeStartDate, and RangeEndDate are required parameters.
• RangeStartDate must be between EffectiveStartDate and EffectiveEndDate of the record.
• RangeEndDate must be the same as the EffectiveEndDate of the record.

curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -H 'REST-Framework-Version: 4' -H "Effective-Of: RangeMode=UPDATE;RangeStartDate=2019-02-05;RangeEndDate=4712-12-31" -X PATCH -d <payload> "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/workers/00020000000EACED0005770800005AF3116303090000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B59741903000078707708000001595753640078/child/addresses/00020000000EACED00057708000110F08509F3F40000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B59741903000078707708000001595753640078"

Example of Payload

The following is an example of the payload.

{
  "TownOrCity": "BRISBANE",
  "Region1": "SAN MATEO",
  "Region2": "CA",
  "Region3": null,
  "PostalCode": "94506"
 }

Example of Response Header

The following is an example of the response header.

Status: HTTP/1.1 200 OK
Content-Type : application/vnd.oracle.adf.resourceitem+json

Example of Response Body

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

{
  "AddressId": 300100186928115,
  "EffectiveStartDate": "2018-02-05",
  "EffectiveEndDate": "4712-12-31",
  "AddressLine1": null,
  "AddressLine2": null,
  "AddressLine3": null,
  "AddressLine4": null,
  "TownOrCity": "BRISBANE",
  "Region1": "SAN MATEO",
  "Region2": "CA",
  "Region3": null,
  "Country": "US",
  "PostalCode": "94506",
  "LongPostalCode": null,
  "AddlAddressAttribute1": null,
  "AddlAddressAttribute2": null,
  "AddlAddressAttribute3": null,
  "AddlAddressAttribute4": null,
  "AddlAddressAttribute5": null,
  "CreatedBy": "VMOSS",
  "CreationDate": "2019-05-16T09:18:00+00:00",
  "LastUpdatedBy": "VMOSS",
  "LastUpdateDate": "2019-05-16T09:28:49.605+00:00",
  "PersonAddrUsageId": 300100186928116,
  "AddressType": "MAIL",
  "PrimaryFlag": false,
  "links": [
      {...
          }
   ]
}

Back to Top