Jump to

• Request
• Response

Create a citizenship

post

/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/citizenships

Request

Path Parameters

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

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.
• Upsert-Mode:
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• Citizenship(required): string
  Title: Citizenship

  Maximum Length: 30

  Citizenship legislation code. Valid values are defined in the hcmCountriesLov.
• citizenshipsDFF: array citizenshipsDFF
• CitizenshipStatus(required): string
  Title: Citizenship Status

  Maximum Length: 30

  Status of the contact citizenship. Valid values are defined in the commonLookupsLOV.
• FromDate: string (date)
  Title: From Date

  Date from when the contact citizenship is valid.
• ToDate: string (date)
  Title: To Date

  Date until when the contact citizenship is valid.

{
    "required":[
        "Citizenship",
        "CitizenshipStatus"
    ],
    "type":"object",
    "properties":{
        "Citizenship":{
            "title":"Citizenship",
            "maxLength":"30",
            "type":"string",
            "description":"Citizenship legislation code. Valid values are defined in the hcmCountriesLov.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true
            }
        },
        "FromDate":{
            "title":"From Date",
            "type":"string",
            "description":"Date from when the contact citizenship is valid.",
            "format":"date",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "ToDate":{
            "title":"To Date",
            "type":"string",
            "description":"Date until when the contact citizenship is valid.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "CitizenshipStatus":{
            "title":"Citizenship Status",
            "maxLength":"30",
            "type":"string",
            "description":"Status of the contact citizenship. Valid values are defined in the commonLookupsLOV.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true,
                "dependencies":[
                    "Citizenship"
                ]
            }
        },
        "citizenshipsDFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/hcmContacts-citizenships-citizenshipsDFF-item-post-request"
            },
            "x-cardinality":"1"
        }
    }
}

Nested Schema : citizenshipsDFF

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/hcmContacts-citizenships-citizenshipsDFF-item-post-request"
    },
    "x-cardinality":"1"
}

Nested Schema : schema

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Value

  Maximum Length: 30

  Context Value
• __FLEX_Context_DisplayValue: string
  Title: Context Value

  Context Value
• CitizenshipId: integer (int64)
  Title: Citizenship ID

{
    "type":"object",
    "properties":{
        "CitizenshipId":{
            "title":"Citizenship ID",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Value",
            "type":"string",
            "description":"Context Value",
            "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",
            "description":"Context Value",
            "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 : hcmContacts-citizenships-item-response

Type: object

Show Source

• Citizenship: string
  Title: Citizenship

  Maximum Length: 30

  Citizenship legislation code. Valid values are defined in the hcmCountriesLov.
• CitizenshipId: integer (int64)
  Title: Citizenship ID

  Read Only: true

  Surrogate identifier for the contact citizenship.
• CitizenshipMeaning: string
  Title: Citizenship

  Read Only: true

  Maximum Length: 80

  Name of the contact's citizenship legislation code.
• citizenshipsDFF: array citizenshipsDFF
• CitizenshipStatus: string
  Title: Citizenship Status

  Maximum Length: 30

  Status of the contact citizenship. Valid values are defined in the commonLookupsLOV.
• CitizenshipStatusMeaning: string
  Title: Citizenship Status

  Read Only: true

  Maximum Length: 80

  Meaning of the contact's citizenship status code.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

  Date and time when the contact citizenship record was created.
• FromDate: string (date)
  Title: From Date

  Date from when the contact citizenship is valid.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

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

  Read Only: true

  Maximum Length: 64

  User who last updated the contact citizenship record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ToDate: string (date)
  Title: To Date

  Date until when the contact citizenship is valid.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"User who last updated the contact citizenship record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date and time when the contact citizenship record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"User who created the contact citizenship record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "CitizenshipStatusMeaning":{
            "title":"Citizenship Status",
            "maxLength":"80",
            "type":"string",
            "description":"Meaning of the contact's citizenship status code.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Citizenship":{
            "title":"Citizenship",
            "maxLength":"30",
            "type":"string",
            "description":"Citizenship legislation code. Valid values are defined in the hcmCountriesLov.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "CitizenshipMeaning":{
            "title":"Citizenship",
            "maxLength":"80",
            "type":"string",
            "description":"Name of the contact's citizenship legislation code.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CitizenshipId":{
            "title":"Citizenship ID",
            "type":"integer",
            "description":"Surrogate identifier for the contact citizenship.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18"
            },
            "x-queryable":true
        },
        "citizenshipsDFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/hcmContacts-citizenships-citizenshipsDFF-item-response"
            },
            "x-cardinality":"1"
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "FromDate":{
            "title":"From Date",
            "type":"string",
            "description":"Date from when the contact citizenship is valid.",
            "format":"date",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "ToDate":{
            "title":"To Date",
            "type":"string",
            "description":"Date until when the contact citizenship is valid.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "CitizenshipStatus":{
            "title":"Citizenship Status",
            "maxLength":"30",
            "type":"string",
            "description":"Status of the contact citizenship. Valid values are defined in the commonLookupsLOV.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true,
                "dependencies":[
                    "Citizenship"
                ]
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"Date and time when the contact citizenship record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        }
    }
}

Nested Schema : citizenshipsDFF

Type: array

Show Source

• Array of: object hcmContacts-citizenships-citizenshipsDFF-item-response

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/hcmContacts-citizenships-citizenshipsDFF-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 : hcmContacts-citizenships-citizenshipsDFF-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Value

  Maximum Length: 30

  Context Value
• __FLEX_Context_DisplayValue: string
  Title: Context Value

  Context Value
• CitizenshipId: integer (int64)
  Title: Citizenship ID
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CitizenshipId":{
            "title":"Citizenship ID",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Value",
            "type":"string",
            "description":"Context Value",
            "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",
            "description":"Context Value",
            "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

citizenshipLov

Operation: /fscmRestApi/resources/11.13.18.05/commonLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupCode%3D{Citizenship}%2CLookupType%3DNATIONALITY

The following properties are defined on the LOV link relation:

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

citizenshipStatusLov

Operation: /fscmRestApi/resources/11.13.18.05/commonLookupsLOV

Parameters:

• finder: LegislationCodeFinder%3BLookupCode%3D{CitizenshipStatus}%2CLookupType%3DPER_CITIZENSHIP_STATUS%2CLegislationCode%3D{Citizenship}

The following properties are defined on the LOV link relation:

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

citizenshipsDFF

Operation: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/citizenships/{CitizenshipId}/child/citizenshipsDFF

Parameters:

• CitizenshipId: $request.path.CitizenshipId
• hcmContactsUniqID: $request.path.hcmContactsUniqID

Back to Top