Jump to

• Request
• Response

Update an address locale

patch

/crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/Address/{AddressNumber}/child/AddressLocale/{LocationLocaleId}

Request

Path Parameters

• AddressNumber(required): string
  The unique alternate identifier for the address. One of AddressId, AddressNumber or SourceSystem and SourceSystemReferenceValue keys is used to identify the address record during update. If not specified, then it is automatically generated. A list of accepted values is defined in the profile option ZCA_PUID_PREFIX concatenated with an internally generated unique sequence number.
• LocationLocaleId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
• PartyNumber(required): string
  The alternate key identifier for the contact party. The profile option HZ_GENERATE_PARTY_NUMBER controls whether the attribute value can be system generated or user-provided during create. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Profile Options task. Inactive records can't be updated.

Header Parameters

• 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

• AddrElementAttribute1: string
  Title: Address Element Attribute 1

  Maximum Length: 150

  The additional address element 1 to support flexible address format in local language.
• AddrElementAttribute2: string
  Title: Address Element Attribute 2

  Maximum Length: 150

  The additional address element 2 to support flexible address format in local language.
• AddrElementAttribute3: string
  Title: Address Element Attribute 3

  Maximum Length: 150

  The additional address element 3 to support flexible address format in local language.
• AddrElementAttribute4: string
  Title: Address Element Attribute 4

  Maximum Length: 150

  The additional address element 4 to support flexible address format in local language.
• AddrElementAttribute5: string
  Title: Address Element Attribute 5

  Maximum Length: 150

  The additional address element 5 to support flexible address format in local language.
• Address1: string
  Title: Address Line 1

  Maximum Length: 240

  The first line of the address in the local language.
• Address2: string
  Title: Address Line 2

  Maximum Length: 240

  The second line of the address in the local language.
• Address3: string
  Title: Address Line 3

  Maximum Length: 240

  The third line of the address in the local language.
• Address4: string
  Title: Address Line 4

  Maximum Length: 240

  The fourth line of the address in the local language.
• Building: string
  Title: Building

  Maximum Length: 240

  The specific building name or number at a given address in local language.
• City: string
  Title: City

  Maximum Length: 60

  The specific name of the city in local language.
• County: string
  Title: County

  Maximum Length: 60

  The specific name of the county in local language.
• FloorNumber: string
  Title: Floor

  Maximum Length: 240

  The specific floor number at a given address or a particular building when building number is provided in local language.
• PostalCode: string
  Title: Postal Code

  Maximum Length: 60

  The postal code of the locale. A postal code, known in various countries as a post code, postcode, or ZIP code, is a series of letters or digits appended to a postal address for the purpose of sorting mail in local language.
• PostalPlus4code: string
  Title: Postal Code Extension

  Maximum Length: 20

  The four digit extension to the United States Postal ZIP code in local language.
• Province: string
  Title: Province

  Maximum Length: 60

  The name of the province in local language.
• SiteSourceSystem: string
  The name of external source system for the parent address denoted by a code, which is defined by an administrator as part of system setup. The value for this attribute should be predefined in the lookup type HZ_ORIG_SYSTEMS_VL using the setup task Manage Trading Community Source Systems. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address.
• SiteSourceSystemReferenceValue: string
  The unique identifier for the parent address from the external source. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address.
• State: string
  Title: State

  Maximum Length: 60

  The name of the State in the local language.
• TransliterationLanguage: string
  Title: Transliteration Language

  Maximum Length: 4

  Transliteration Language helps people pronounce words and names in foreign languages. It's validated against FND_LANGUAGES.LANGUAGE_CODE. Sample values are US,NL, DK.

{
    "type":"object",
    "properties":{
        "Building":{
            "title":"Building",
            "maxLength":"240",
            "type":"string",
            "description":"The specific building name or number at a given address in local language.",
            "nullable":true
        },
        "SiteSourceSystem":{
            "type":"string",
            "description":"The name of external source system for the parent address denoted by a code, which is defined by an administrator as part of system setup. The value for this attribute should be predefined in the lookup type HZ_ORIG_SYSTEMS_VL using the setup task Manage Trading Community Source Systems. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address.",
            "nullable":true,
            "x-queryable":false
        },
        "PostalPlus4code":{
            "title":"Postal Code Extension",
            "maxLength":"20",
            "type":"string",
            "description":"The four digit extension to the United States Postal ZIP code in local language.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.PostalPlus4Code",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Postal Code Extension"
            }
        },
        "FloorNumber":{
            "title":"Floor",
            "maxLength":"240",
            "type":"string",
            "description":"The specific floor number at a given address or a particular building when building number is provided in local language.",
            "nullable":true
        },
        "SiteSourceSystemReferenceValue":{
            "type":"string",
            "description":"The unique identifier for the parent address from the external source. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address.",
            "nullable":true,
            "x-queryable":false
        },
        "Address2":{
            "title":"Address Line 2",
            "maxLength":"240",
            "type":"string",
            "description":"The second line of the address in the local language.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address2",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 2",
                "protectionTokenizationScheme":"WORD"
            }
        },
        "AddrElementAttribute5":{
            "title":"Address Element Attribute 5",
            "maxLength":"150",
            "type":"string",
            "description":"The additional address element 5 to support flexible address format in local language.",
            "nullable":true
        },
        "Address3":{
            "title":"Address Line 3",
            "maxLength":"240",
            "type":"string",
            "description":"The third line of the address in the local language.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address3",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 3",
                "protectionTokenizationScheme":"WORD"
            }
        },
        "PostalCode":{
            "title":"Postal Code",
            "maxLength":"60",
            "type":"string",
            "description":"The postal code of the locale. A postal code, known in various countries as a post code, postcode, or ZIP code, is a series of letters or digits appended to a postal address for the purpose of sorting mail in local language.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.PostalCode",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Postal Code"
            }
        },
        "Address1":{
            "title":"Address Line 1",
            "maxLength":"240",
            "type":"string",
            "description":"The first line of the address in the local language.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address1",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 1",
                "protectionTokenizationScheme":"WORD"
            }
        },
        "City":{
            "title":"City",
            "maxLength":"60",
            "type":"string",
            "description":"The specific name of the city in local language.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.City",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"City"
            }
        },
        "AddrElementAttribute1":{
            "title":"Address Element Attribute 1",
            "maxLength":"150",
            "type":"string",
            "description":"The additional address element 1 to support flexible address format in local language.",
            "nullable":true
        },
        "AddrElementAttribute2":{
            "title":"Address Element Attribute 2",
            "maxLength":"150",
            "type":"string",
            "description":"The additional address element 2 to support flexible address format in local language.",
            "nullable":true
        },
        "County":{
            "title":"County",
            "maxLength":"60",
            "type":"string",
            "description":"The specific name of the county in local language.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.County",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"County"
            }
        },
        "TransliterationLanguage":{
            "title":"Transliteration Language",
            "maxLength":"4",
            "type":"string",
            "description":"Transliteration Language helps people pronounce words and names in foreign languages. It's validated against FND_LANGUAGES.LANGUAGE_CODE. Sample values are US,NL, DK.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "AddrElementAttribute3":{
            "title":"Address Element Attribute 3",
            "maxLength":"150",
            "type":"string",
            "description":"The additional address element 3 to support flexible address format in local language.",
            "nullable":true
        },
        "Province":{
            "title":"Province",
            "maxLength":"60",
            "type":"string",
            "description":"The name of the province in local language.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Province",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Province"
            }
        },
        "AddrElementAttribute4":{
            "title":"Address Element Attribute 4",
            "maxLength":"150",
            "type":"string",
            "description":"The additional address element 4 to support flexible address format in local language.",
            "nullable":true
        },
        "Address4":{
            "title":"Address Line 4",
            "maxLength":"240",
            "type":"string",
            "description":"The fourth line of the address in the local language.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address4",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 4",
                "protectionTokenizationScheme":"WORD"
            }
        },
        "State":{
            "title":"State",
            "maxLength":"60",
            "type":"string",
            "description":"The name of the State in the local language.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.State",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"State"
            }
        }
    }
}

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 : contacts-Address-AddressLocale-item-response

Type: object

Show Source

• AddrElementAttribute1: string
  Title: Address Element Attribute 1

  Maximum Length: 150

  The additional address element 1 to support flexible address format in local language.
• AddrElementAttribute2: string
  Title: Address Element Attribute 2

  Maximum Length: 150

  The additional address element 2 to support flexible address format in local language.
• AddrElementAttribute3: string
  Title: Address Element Attribute 3

  Maximum Length: 150

  The additional address element 3 to support flexible address format in local language.
• AddrElementAttribute4: string
  Title: Address Element Attribute 4

  Maximum Length: 150

  The additional address element 4 to support flexible address format in local language.
• AddrElementAttribute5: string
  Title: Address Element Attribute 5

  Maximum Length: 150

  The additional address element 5 to support flexible address format in local language.
• Address1: string
  Title: Address Line 1

  Maximum Length: 240

  The first line of the address in the local language.
• Address2: string
  Title: Address Line 2

  Maximum Length: 240

  The second line of the address in the local language.
• Address3: string
  Title: Address Line 3

  Maximum Length: 240

  The third line of the address in the local language.
• Address4: string
  Title: Address Line 4

  Maximum Length: 240

  The fourth line of the address in the local language.
• AddressNumber: string
  Title: Site Number

  Read Only: true

  Maximum Length: 30

  The unique address identifier that's internally generated during create. One of the following keys is used to identify the address purpose record during update: AddressId, AddressNumber, or SourceSystem and SourceSystemReferenceValue.
• Building: string
  Title: Building

  Maximum Length: 240

  The specific building name or number at a given address in local language.
• City: string
  Title: City

  Maximum Length: 60

  The specific name of the city in local language.
• Country: string
  Title: Country

  Read Only: true

  Maximum Length: 2

  The specific name of the country in local language.
• County: string
  Title: County

  Maximum Length: 60

  The specific name of the county in local language.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the address locale record.
• CreationDate: string (date-time)
  Read Only: true

  The date and time when the address locale record was created.
• FloorNumber: string
  Title: Floor

  Maximum Length: 240

  The specific floor number at a given address or a particular building when building number is provided in local language.
• FormattedAddress: string
  Read Only: true

  The formatted read only version of the locale address.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date and time when the address locale was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the address locale record.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the address locale record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LocationId: integer (int64)
  The unique identifier of the location record.
• LocationLocaleId: integer (int64)
  Read Only: true

  The unique identifier of the location locale record.
• PostalCode: string
  Title: Postal Code

  Maximum Length: 60

  The postal code of the locale. A postal code, known in various countries as a post code, postcode, or ZIP code, is a series of letters or digits appended to a postal address for the purpose of sorting mail in local language.
• PostalPlus4code: string
  Title: Postal Code Extension

  Maximum Length: 20

  The four digit extension to the United States Postal ZIP code in local language.
• Province: string
  Title: Province

  Maximum Length: 60

  The name of the province in local language.
• SiteSourceSystem: string
  The name of external source system for the parent address denoted by a code, which is defined by an administrator as part of system setup. The value for this attribute should be predefined in the lookup type HZ_ORIG_SYSTEMS_VL using the setup task Manage Trading Community Source Systems. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address.
• SiteSourceSystemReferenceValue: string
  The unique identifier for the parent address from the external source. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address.
• State: string
  Title: State

  Maximum Length: 60

  The name of the State in the local language.
• TransliterationLanguage: string
  Title: Transliteration Language

  Maximum Length: 4

  Transliteration Language helps people pronounce words and names in foreign languages. It's validated against FND_LANGUAGES.LANGUAGE_CODE. Sample values are US,NL, DK.

{
    "type":"object",
    "properties":{
        "Building":{
            "title":"Building",
            "maxLength":"240",
            "type":"string",
            "description":"The specific building name or number at a given address in local language.",
            "nullable":true,
            "x-queryable":true
        },
        "SiteSourceSystem":{
            "type":"string",
            "description":"The name of external source system for the parent address denoted by a code, which is defined by an administrator as part of system setup. The value for this attribute should be predefined in the lookup type HZ_ORIG_SYSTEMS_VL using the setup task Manage Trading Community Source Systems. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address.",
            "nullable":true,
            "x-queryable":false
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the address locale record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PostalPlus4code":{
            "title":"Postal Code Extension",
            "maxLength":"20",
            "type":"string",
            "description":"The four digit extension to the United States Postal ZIP code in local language.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.PostalPlus4Code",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Postal Code Extension"
            },
            "x-queryable":true
        },
        "FloorNumber":{
            "title":"Floor",
            "maxLength":"240",
            "type":"string",
            "description":"The specific floor number at a given address or a particular building when building number is provided in local language.",
            "nullable":true,
            "x-queryable":true
        },
        "SiteSourceSystemReferenceValue":{
            "type":"string",
            "description":"The unique identifier for the parent address from the external source. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address.",
            "nullable":true,
            "x-queryable":false
        },
        "LocationLocaleId":{
            "type":"integer",
            "description":"The unique identifier of the location locale record.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "PostalCode":{
            "title":"Postal Code",
            "maxLength":"60",
            "type":"string",
            "description":"The postal code of the locale. A postal code, known in various countries as a post code, postcode, or ZIP code, is a series of letters or digits appended to a postal address for the purpose of sorting mail in local language.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.PostalCode",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Postal Code"
            },
            "x-queryable":true
        },
        "County":{
            "title":"County",
            "maxLength":"60",
            "type":"string",
            "description":"The specific name of the county in local language.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.County",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"County"
            },
            "x-queryable":true
        },
        "Address4":{
            "title":"Address Line 4",
            "maxLength":"240",
            "type":"string",
            "description":"The fourth line of the address in the local language.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address4",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 4",
                "protectionTokenizationScheme":"WORD"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the address locale record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the address locale record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FormattedAddress":{
            "type":"string",
            "description":"The formatted read only version of the locale address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LocationId":{
            "type":"integer",
            "description":"The unique identifier of the location record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Address2":{
            "title":"Address Line 2",
            "maxLength":"240",
            "type":"string",
            "description":"The second line of the address in the local language.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address2",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 2",
                "protectionTokenizationScheme":"WORD"
            },
            "x-queryable":true
        },
        "AddrElementAttribute5":{
            "title":"Address Element Attribute 5",
            "maxLength":"150",
            "type":"string",
            "description":"The additional address element 5 to support flexible address format in local language.",
            "nullable":true,
            "x-queryable":true
        },
        "Address3":{
            "title":"Address Line 3",
            "maxLength":"240",
            "type":"string",
            "description":"The third line of the address in the local language.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address3",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 3",
                "protectionTokenizationScheme":"WORD"
            },
            "x-queryable":true
        },
        "Address1":{
            "title":"Address Line 1",
            "maxLength":"240",
            "type":"string",
            "description":"The first line of the address in the local language.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address1",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 1",
                "protectionTokenizationScheme":"WORD"
            },
            "x-queryable":true
        },
        "City":{
            "title":"City",
            "maxLength":"60",
            "type":"string",
            "description":"The specific name of the city in local language.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.City",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"City"
            },
            "x-queryable":true
        },
        "AddrElementAttribute1":{
            "title":"Address Element Attribute 1",
            "maxLength":"150",
            "type":"string",
            "description":"The additional address element 1 to support flexible address format in local language.",
            "nullable":true,
            "x-queryable":true
        },
        "AddrElementAttribute2":{
            "title":"Address Element Attribute 2",
            "maxLength":"150",
            "type":"string",
            "description":"The additional address element 2 to support flexible address format in local language.",
            "nullable":true,
            "x-queryable":true
        },
        "TransliterationLanguage":{
            "title":"Transliteration Language",
            "maxLength":"4",
            "type":"string",
            "description":"Transliteration Language helps people pronounce words and names in foreign languages. It's validated against FND_LANGUAGES.LANGUAGE_CODE. Sample values are US,NL, DK.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AddrElementAttribute3":{
            "title":"Address Element Attribute 3",
            "maxLength":"150",
            "type":"string",
            "description":"The additional address element 3 to support flexible address format in local language.",
            "nullable":true,
            "x-queryable":true
        },
        "Province":{
            "title":"Province",
            "maxLength":"60",
            "type":"string",
            "description":"The name of the province in local language.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Province",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Province"
            },
            "x-queryable":true
        },
        "AddrElementAttribute4":{
            "title":"Address Element Attribute 4",
            "maxLength":"150",
            "type":"string",
            "description":"The additional address element 4 to support flexible address format in local language.",
            "nullable":true,
            "x-queryable":true
        },
        "State":{
            "title":"State",
            "maxLength":"60",
            "type":"string",
            "description":"The name of the State in the local language.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.State",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"State"
            },
            "x-queryable":true
        },
        "Country":{
            "title":"Country",
            "maxLength":"2",
            "type":"string",
            "description":"The specific name of the country in local language.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AddressNumber":{
            "title":"Site Number",
            "maxLength":"30",
            "type":"string",
            "description":"The unique address identifier that's internally generated during create. One of the following keys is used to identify the address purpose record during update: AddressId, AddressNumber, or SourceSystem and SourceSystemReferenceValue.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"The login of the user who last updated the address locale record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time when the address locale was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "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

TransliterationLanguageLOV

Operation: /fscmRestApi/resources/11.13.18.05/languagesLOV

The list of values indicating the specific name of the transliteration language in local language.

Back to Top