Jump to

• Request
• Response

Update a national identifier type

patch

/fscmRestApi/resources/11.13.18.05/hedNationalIdentifierTypes/{NationalIdentifierTypeId}

Request

Path Parameters

• NationalIdentifierTypeId(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=

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

• EnabledFlag: boolean
  Title: Active Indicator

  Maximum Length: 1

  Default Value: true

  Indicates whether the national identifier type is active or inactive. The default value is yes, which means active.
• IdentifierTypeMeaning: string
  Title: Identifier Type

  Maximum Length: 60

  The name of the national identifier type such as passport.

{
    "type":"object",
    "properties":{
        "EnabledFlag":{
            "title":"Active Indicator",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the national identifier type is active or inactive. The default value is yes, which means active.",
            "nullable":false,
            "default":true
        },
        "IdentifierTypeMeaning":{
            "title":"Identifier Type",
            "maxLength":60,
            "type":"string",
            "description":"The name of the national identifier type such as passport.",
            "nullable":false
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context(required):
  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(required):
  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 : hedNationalIdentifierTypes-item-response

Type: object

Show Source

• CountryCode: string
  Title: Country Code

  Maximum Length: 10

  The code for the country of the national identification type.
• CountryName: string
  Title: Country

  Read Only: true

  Maximum Length: 80

  The name of the country of the national identification type.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the row.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date the row was created.
• EnabledFlag: boolean
  Title: Active Indicator

  Maximum Length: 1

  Default Value: true

  Indicates whether the national identifier type is active or inactive. The default value is yes, which means active.
• IdentifierTypeCode: string
  Title: Identifier Type Code

  Maximum Length: 30

  The code for the national identifier type.
• IdentifierTypeMeaning: string
  Title: Identifier Type

  Maximum Length: 60

  The name of the national identifier type such as passport.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date the row was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the row.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• NationalIdentifierTypeId: integer (int64)
  Title: Identifier Type ID

  Read Only: true

  The unique identifier for the national identifier type.
• SeedDataLock: string
  Title: Predefined Indicator

  Read Only: true

  Maximum Length: 1

  Default Value: 0

  Indicates whether the row is predefined. The value 0 means the row isn't predefined. The value 1 means the row is predefined and can't be updated, but can be disabled.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "IdentifierTypeCode":{
            "title":"Identifier Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The code for the national identifier type.",
            "nullable":false,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date the row was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CountryName":{
            "title":"Country",
            "maxLength":80,
            "type":"string",
            "description":"The name of the country of the national identification type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SeedDataLock":{
            "title":"Predefined Indicator",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the row is predefined. The value 0 means the row isn't predefined. The value 1 means the row is predefined and can't be updated, but can be disabled.",
            "nullable":false,
            "readOnly":true,
            "default":"0",
            "x-queryable":true
        },
        "NationalIdentifierTypeId":{
            "title":"Identifier Type ID",
            "type":"integer",
            "description":"The unique identifier for the national identifier type.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "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"
            }
        },
        "CountryCode":{
            "title":"Country Code",
            "maxLength":10,
            "type":"string",
            "description":"The code for the country of the national identification type.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "EnabledFlag":{
            "title":"Active Indicator",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the national identifier type is active or inactive. The default value is yes, which means active.",
            "nullable":false,
            "default":true,
            "x-queryable":true
        },
        "IdentifierTypeMeaning":{
            "title":"Identifier Type",
            "maxLength":60,
            "type":"string",
            "description":"The name of the national identifier type such as passport.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date the row 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

TerritoryLOV

Operation: /fscmRestApi/resources/11.13.18.05/territoriesLOV

The following properties are defined on the LOV link relation:

• Source Attribute: CountryCode; Target Attribute: TerritoryCode
• Display Attribute: TerritoryShortName

Back to Top