REST API for Oracle Fusion Cloud SCM

Update one barcode data identifier

patch

/fscmRestApi/resources/11.13.18.05/inventoryBarcodeFormats/{HeaderId}/child/dataIdentifierConfigurations/{LineId}

Request

Path Parameters

HeaderId(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=
LineId(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: string

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: string

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

Root Schema : schema

Type: object

Show Source

DataElementSequenceNumber: integer (int32)

Indicates the sequence number of a data element in a data identifier when the data identifier contains multiple data elements.
DataIdentifierDescription: string

Maximum Length: 50

Description of the data identifier.
DataLength: integer (int32)

Indicates the number of characters of the barcode data.
DataLengthType: string

Maximum Length: 30

Abbreviation that identifies if the number of characters of the barcode data is fixed or variable. A list of acceptable values is defined in the lookup ORA_INV_BARCODE_FIELD_LEN_TYPE.
DataLengthTypeName: string

Maximum Length: 255

Indicates if the number of characters of the barcode data is fixed or variable.
DataType: string

Maximum Length: 30

Abbreviation that identifies the data type of the barcode data. A list of acceptable values is defined in the lookup ORA_INV_BARCODE_FLD_DATA_TYPE.
DataTypeName: string

Maximum Length: 255

Indicates the data type of the barcode data.
DateFormat: string

Maximum Length: 25

Indicates the date format of the barcode data if the data type is date.
Delimiter: string

Maximum Length: 25

Indicates the text that's used to specify the end of the data element.
FieldCode: string

Maximum Length: 30

Abbreviation that identifies the field name to which barcode data should be mapped. A list of acceptable values is defined in the lookup ORA_INV_BARCODE_FIELDS.
FieldName: string

Maximum Length: 255

Indicates the field name to which barcode data should be mapped.
GroupSeparatorFlag: boolean

Maximum Length: 1

Indicates if a GS1 group separator is used to specify the end of the data element.
HeaderId: integer (int64)

Value that uniquely identifies the barcode format.
IncludesCheckDigitFlag: boolean

Maximum Length: 1

Indicates if the last digit of the barcode data is a check digit.
LinesDFF: array LinesDFF
MultiDataElementFlag: boolean

Maximum Length: 1

Contains one of the following values: true or false. If true, then it indicates that the data identifier contains multiple data elements. If false, then the data identifier doesn't contain multiple data elements.
RetainDataIdentifierFlag: boolean

Maximum Length: 1

Contains one of the following values: true or false. If true, then it indicates that the data identifier will be retained in the barcode data while parsing and included as part of the data element. If false, then it indicates that the data identifier won't be retained.
RetainDelimiterFlag: boolean

Maximum Length: 1

Contains one of the following values: true or false. If true, then it indicates that the delimiter will be retained in the barcode data while parsing and included as part of the data identifier. If false, then it indicates that the delimiter won't be retained.

{
    "type":"object",
    "properties":{
        "DataElementSequenceNumber":{
            "type":"integer",
            "description":"Indicates the sequence number of a data element in a data identifier when the data identifier contains multiple data elements.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            }
        },
        "DataIdentifierDescription":{
            "maxLength":50,
            "type":"string",
            "description":"Description of the data identifier.",
            "nullable":true
        },
        "DataLength":{
            "type":"integer",
            "description":"Indicates the number of characters of the barcode data.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            }
        },
        "DataLengthType":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies if the number of characters of the barcode data is fixed or variable. A list of acceptable values is defined in the lookup ORA_INV_BARCODE_FIELD_LEN_TYPE.",
            "nullable":false
        },
        "DataLengthTypeName":{
            "maxLength":255,
            "type":"string",
            "description":"Indicates if the number of characters of the barcode data is fixed or variable.",
            "nullable":true
        },
        "DataType":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the data type of the barcode data. A list of acceptable values is defined in the lookup ORA_INV_BARCODE_FLD_DATA_TYPE.",
            "nullable":false
        },
        "DataTypeName":{
            "maxLength":255,
            "type":"string",
            "description":"Indicates the data type of the barcode data.",
            "nullable":true
        },
        "DateFormat":{
            "maxLength":25,
            "type":"string",
            "description":"Indicates the date format of the barcode data if the data type is date.",
            "nullable":true
        },
        "Delimiter":{
            "maxLength":25,
            "type":"string",
            "description":"Indicates the text that's used to specify the end of the data element.",
            "nullable":true
        },
        "FieldCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the field name to which barcode data should be mapped. A list of acceptable values is defined in the lookup ORA_INV_BARCODE_FIELDS.",
            "nullable":true
        },
        "FieldName":{
            "maxLength":255,
            "type":"string",
            "description":"Indicates the field name to which barcode data should be mapped.",
            "nullable":true
        },
        "GroupSeparatorFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if a GS1 group separator is used to specify the end of the data element.",
            "nullable":false
        },
        "HeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the barcode format.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "IncludesCheckDigitFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if the last digit of the barcode data is a check digit.",
            "nullable":true
        },
        "LinesDFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/inventoryBarcodeFormats-dataIdentifierConfigurations-LinesDFF-item-patch-request"
            },
            "x-cardinality":"1"
        },
        "MultiDataElementFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then it indicates that the data identifier contains multiple data elements. If false, then the data identifier doesn't contain multiple data elements.",
            "nullable":true
        },
        "RetainDataIdentifierFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then it indicates that the data identifier will be retained in the barcode data while parsing and included as part of the data element. If false, then it indicates that the data identifier won't be retained.",
            "nullable":true
        },
        "RetainDelimiterFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then it indicates that the delimiter will be retained in the barcode data while parsing and included as part of the data identifier. If false, then it indicates that the delimiter won't be retained.",
            "nullable":true
        }
    }
}

Nested Schema : LinesDFF

Type: array

Show Source

Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/inventoryBarcodeFormats-dataIdentifierConfigurations-LinesDFF-item-patch-request"
    },
    "x-cardinality":"1"
}

Nested Schema : schema

Type: object

Show Source

__FLEX_Context: string

Title: Context Segment

Maximum Length: 30

Context Segment
__FLEX_Context_DisplayValue: string

Title: Context Segment

Context Segment

{
    "type":"object",
    "properties":{
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":30,
            "type":"string",
            "description":"Context Segment",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"Context Segment"
                },
                "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":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "description":"Context Segment",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "help":{
                    "instruction":"Context Segment"
                },
                "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":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        }
    }
}

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.

Root Schema : inventoryBarcodeFormats-dataIdentifierConfigurations-item-response

Type: object

Show Source

CreatedBy: string

Read Only: true

Maximum Length: 64

User who created the data identifier configuration.
CreationDate: string (date-time)

Read Only: true

Date when the user created the data identifier configuration.
DataElementSequenceNumber: integer (int32)

Indicates the sequence number of a data element in a data identifier when the data identifier contains multiple data elements.
DataIdentifier: string

Maximum Length: 10

Prefix of the encoded barcode data that indicates the meaning of the barcode data.
DataIdentifierDescription: string

Maximum Length: 50

Description of the data identifier.
DataLength: integer (int32)

Indicates the number of characters of the barcode data.
DataLengthType: string

Maximum Length: 30

Abbreviation that identifies if the number of characters of the barcode data is fixed or variable. A list of acceptable values is defined in the lookup ORA_INV_BARCODE_FIELD_LEN_TYPE.
DataLengthTypeName: string

Maximum Length: 255

Indicates if the number of characters of the barcode data is fixed or variable.
DataType: string

Maximum Length: 30

Abbreviation that identifies the data type of the barcode data. A list of acceptable values is defined in the lookup ORA_INV_BARCODE_FLD_DATA_TYPE.
DataTypeName: string

Maximum Length: 255

Indicates the data type of the barcode data.
DateFormat: string

Maximum Length: 25

Indicates the date format of the barcode data if the data type is date.
Delimiter: string

Maximum Length: 25

Indicates the text that's used to specify the end of the data element.
FieldCode: string

Maximum Length: 30

Abbreviation that identifies the field name to which barcode data should be mapped. A list of acceptable values is defined in the lookup ORA_INV_BARCODE_FIELDS.
FieldName: string

Maximum Length: 255

Indicates the field name to which barcode data should be mapped.
GroupSeparatorFlag: boolean

Maximum Length: 1

Indicates if a GS1 group separator is used to specify the end of the data element.
HeaderId: integer (int64)

Value that uniquely identifies the barcode format.
IncludesCheckDigitFlag: boolean

Maximum Length: 1

Indicates if the last digit of the barcode data is a check digit.
LastUpdateDate: string (date-time)

Read Only: true

Date when the user most recently updated the data identifier configuration.
LastUpdatedBy: string

Read Only: true

Maximum Length: 64

User who most recently updated the data identifier configuration.
LastUpdateLogin: string

Read Only: true

Maximum Length: 32

Login information of the user who most recently updated the data identifier configuration.
LineId: integer (int64)

Read Only: true

Value that uniquely identifies the data identifier configuration.
LinesDFF: array LinesDFF
links: array Links

Title: Links

The link relations associated with the resource instance.
MultiDataElementFlag: boolean

Maximum Length: 1

Contains one of the following values: true or false. If true, then it indicates that the data identifier contains multiple data elements. If false, then the data identifier doesn't contain multiple data elements.
ObjectVersionNumber: integer (int32)

Read Only: true

Number of times the object row has been updated. This attribute is used to implement optimistic locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.
RetainDataIdentifierFlag: boolean

Maximum Length: 1

Contains one of the following values: true or false. If true, then it indicates that the data identifier will be retained in the barcode data while parsing and included as part of the data element. If false, then it indicates that the data identifier won't be retained.
RetainDelimiterFlag: boolean

Maximum Length: 1

Contains one of the following values: true or false. If true, then it indicates that the delimiter will be retained in the barcode data while parsing and included as part of the data identifier. If false, then it indicates that the delimiter won't be retained.

{
    "type":"object",
    "properties":{
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the data identifier configuration.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the user created the data identifier configuration.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DataElementSequenceNumber":{
            "type":"integer",
            "description":"Indicates the sequence number of a data element in a data identifier when the data identifier contains multiple data elements.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "DataIdentifier":{
            "maxLength":10,
            "type":"string",
            "description":"Prefix of the encoded barcode data that indicates the meaning of the barcode data.",
            "nullable":true,
            "x-queryable":true
        },
        "DataIdentifierDescription":{
            "maxLength":50,
            "type":"string",
            "description":"Description of the data identifier.",
            "nullable":true,
            "x-queryable":true
        },
        "DataLength":{
            "type":"integer",
            "description":"Indicates the number of characters of the barcode data.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "DataLengthType":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies if the number of characters of the barcode data is fixed or variable. A list of acceptable values is defined in the lookup ORA_INV_BARCODE_FIELD_LEN_TYPE.",
            "nullable":false,
            "x-queryable":true
        },
        "DataLengthTypeName":{
            "maxLength":255,
            "type":"string",
            "description":"Indicates if the number of characters of the barcode data is fixed or variable.",
            "nullable":true,
            "x-queryable":true
        },
        "DataType":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the data type of the barcode data. A list of acceptable values is defined in the lookup ORA_INV_BARCODE_FLD_DATA_TYPE.",
            "nullable":false,
            "x-queryable":true
        },
        "DataTypeName":{
            "maxLength":255,
            "type":"string",
            "description":"Indicates the data type of the barcode data.",
            "nullable":true,
            "x-queryable":true
        },
        "DateFormat":{
            "maxLength":25,
            "type":"string",
            "description":"Indicates the date format of the barcode data if the data type is date.",
            "nullable":true,
            "x-queryable":true
        },
        "Delimiter":{
            "maxLength":25,
            "type":"string",
            "description":"Indicates the text that's used to specify the end of the data element.",
            "nullable":true,
            "x-queryable":true
        },
        "FieldCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the field name to which barcode data should be mapped. A list of acceptable values is defined in the lookup ORA_INV_BARCODE_FIELDS.",
            "nullable":true,
            "x-queryable":true
        },
        "FieldName":{
            "maxLength":255,
            "type":"string",
            "description":"Indicates the field name to which barcode data should be mapped.",
            "nullable":true,
            "x-queryable":true
        },
        "GroupSeparatorFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if a GS1 group separator is used to specify the end of the data element.",
            "nullable":false,
            "x-queryable":true
        },
        "HeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the barcode format.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "IncludesCheckDigitFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if the last digit of the barcode data is a check digit.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the user most recently updated the data identifier configuration.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"Login information of the user who most recently updated the data identifier configuration.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the data identifier configuration.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the data identifier configuration.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "LinesDFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/inventoryBarcodeFormats-dataIdentifierConfigurations-LinesDFF-item-response"
            },
            "x-cardinality":"1"
        },
        "MultiDataElementFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then it indicates that the data identifier contains multiple data elements. If false, then the data identifier doesn't contain multiple data elements.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Number of times the object row has been updated. This attribute is used to implement optimistic locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "RetainDataIdentifierFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then it indicates that the data identifier will be retained in the barcode data while parsing and included as part of the data element. If false, then it indicates that the data identifier won't be retained.",
            "nullable":true,
            "x-queryable":true
        },
        "RetainDelimiterFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then it indicates that the delimiter will be retained in the barcode data while parsing and included as part of the data identifier. If false, then it indicates that the delimiter won't be retained.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : LinesDFF

Type: array

Show Source

Array of: object inventoryBarcodeFormats-dataIdentifierConfigurations-LinesDFF-item-response

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/inventoryBarcodeFormats-dataIdentifierConfigurations-LinesDFF-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 : inventoryBarcodeFormats-dataIdentifierConfigurations-LinesDFF-item-response

Type: object

Show Source

__FLEX_Context: string

Title: Context Segment

Maximum Length: 30

Context Segment
__FLEX_Context_DisplayValue: string

Title: Context Segment

Context Segment
LineId: integer (int64)

Read Only: true
links: array Links

Title: Links

The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "LineId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":30,
            "type":"string",
            "description":"Context Segment",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"Context Segment"
                },
                "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":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "description":"Context Segment",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "help":{
                    "instruction":"Context Segment"
                },
                "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":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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

LinesDFF

Operation: /fscmRestApi/resources/11.13.18.05/inventoryBarcodeFormats/{HeaderId}/child/dataIdentifierConfigurations/{LineId}/child/LinesDFF

Parameters:

HeaderId: $request.path.HeaderId
LineId: $request.path.LineId

Examples

This example describes how to update one barcode data identifier of an inventory barcode format.

Example cURL Command

Use the following cURL command to submit a request on the REST resource.

curl -X PATCH -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -d 'request payload'  "https://servername/fscmRestApi/resources/version/inventoryBarcodeFormats/HeaderId/child/dataIdentifierConfigurations/LineId"

For example, the following command updates one barcode data identifier with a header identifier 300100596187556 and line identifier 300100596187557:

curl -X PATCH -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -d 'request payload'  "https://servername/fscmRestApi/resources/version/inventoryBarcodeFormats/300100596187556/child/dataIdentifierConfigurations/300100596187557"

Example Request Body

The following example includes the contents of the request body in JSON format to update the Delimiter attribute. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it updates.

{
    "Delimiter": "*"
}

Example Response Body

The following example includes the contents of the response body in JSON format:

{
    "HeaderId": 300100596187556,
    "LineId": 300100596187557,
    "DataIdentifier": "L+",
    "DataIdentifierDescription": "Lot number",
    "FieldCode": "ORA_LOT",
    "FieldName": "Lot number",
    "DataLengthType": "ORA_VARIABLE",
    "DataLengthTypeName": "Variable",
    "DataLength": null,
    "GroupSeparatorFlag": false,
    "Delimiter": "*",
    "DataType": "ORA_TEXT",
    "DataTypeName": "Text",
    "DateFormat": null,
    "IncludesCheckDigitFlag": false,
    "CreationDate": "2024-02-08T22:57:55.120+00:00",
    "CreatedBy": "SCMOPERATIONS",
    "LastUpdatedBy": "SCMOPERATIONS",
    "LastUpdateDate": "2024-02-08T23:24:13+00:00",
    "LastUpdateLogin": "0F4AB00151A5C65BE063726515AC9C9B",
    "ObjectVersionNumber": 2,
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/inventoryBarcodeFormats/300100596187556/child/dataIdentifierConfigurations/300100596187557",
            "name": "dataIdentifierConfigurations",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername/fscmRestApi/resources/version/inventoryBarcodeFormats/300100596187556/child/dataIdentifierConfigurations/300100596187557",
            "name": "dataIdentifierConfigurations",
            "kind": "item"
        },
        {
            "rel": "parent",
            "href": "https://servername/fscmRestApi/resources/version/inventoryBarcodeFormats/300100596187556",
            "name": "inventoryBarcodeFormats",
            "kind": "item"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/version/inventoryBarcodeFormats/300100596187556/child/dataIdentifierConfigurations/300100596187557/child/LinesDFF",
            "name": "LinesDFF",
            "kind": "collection"
        }
    ]
}