Jump to

• Request
• Response

Create requests to change serials

post

/fscmRestApi/resources/11.13.18.05/shipmentLineChangeRequests/{TransactionId}/child/shipmentLines/{shipmentLinesUniqID}/child/serials

Request

Path Parameters

• TransactionId(required): integer(int64)
  Value that uniquely identifies the shipment line change request.
• shipmentLinesUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Shipment Lines resource and used to uniquely identify an instance of Shipment Lines. The client should not generate the hash key value. Instead, the client should query on the Shipment Lines collection resource in order to navigate to a specific instance of Shipment Lines 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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• attributeDFF: array Flexfields for Serial Attributes
  Title: Flexfields for Serial Attributes

  The Flexfields for Serial Attributes resource manages details about serial attributes for the serial numbers.
• FromSerialNumber(required): string
  Maximum Length: 80

  Starting serial number in a range of serial numbers. The application uses this attribute when the warehouse places the item under serial control.
• standardDFF: array Flexfields for Serials
  Title: Flexfields for Serials

  The Flexfields for Serials resource manages details about serial numbers.
• ToSerialNumber: string
  Maximum Length: 80

  Ending serial number in a range of serial numbers. The application uses this attribute when the warehouse places the item under serial control.

{
    "required":[
        "FromSerialNumber"
    ],
    "type":"object",
    "properties":{
        "attributeDFF":{
            "title":"Flexfields for Serial Attributes",
            "type":"array",
            "description":"The Flexfields for Serial Attributes resource manages details about serial attributes for the serial numbers.",
            "items":{
                "$ref":"#/components/schemas/shipmentLineChangeRequests-shipmentLines-serials-attributeDFF-item-post-request"
            },
            "x-cardinality":"1"
        },
        "FromSerialNumber":{
            "maxLength":80,
            "type":"string",
            "description":"Starting serial number in a range of serial numbers. The application uses this attribute when the warehouse places the item under serial control.",
            "nullable":false,
            "x-queryable":false
        },
        "standardDFF":{
            "title":"Flexfields for Serials",
            "type":"array",
            "description":"The Flexfields for Serials resource manages details about serial numbers.",
            "items":{
                "$ref":"#/components/schemas/shipmentLineChangeRequests-shipmentLines-serials-standardDFF-item-post-request"
            },
            "x-cardinality":"1"
        },
        "ToSerialNumber":{
            "maxLength":80,
            "type":"string",
            "description":"Ending serial number in a range of serial numbers. The application uses this attribute when the warehouse places the item under serial control.",
            "nullable":true,
            "x-queryable":false
        }
    }
}

Nested Schema : Flexfields for Serial Attributes

Type: array

Title: Flexfields for Serial Attributes

The Flexfields for Serial Attributes resource manages details about serial attributes for the serial numbers.

Show Source

• Array of: object shipmentLineChangeRequests-shipmentLines-serials-attributeDFF-item-post-request

{
    "title":"Flexfields for Serial Attributes",
    "type":"array",
    "description":"The Flexfields for Serial Attributes resource manages details about serial attributes for the serial numbers.",
    "items":{
        "$ref":"#/components/schemas/shipmentLineChangeRequests-shipmentLines-serials-attributeDFF-item-post-request"
    },
    "x-cardinality":"1"
}

Nested Schema : Flexfields for Serials

Type: array

Title: Flexfields for Serials

The Flexfields for Serials resource manages details about serial numbers.

Show Source

• Array of: object shipmentLineChangeRequests-shipmentLines-serials-standardDFF-item-post-request

{
    "title":"Flexfields for Serials",
    "type":"array",
    "description":"The Flexfields for Serials resource manages details about serial numbers.",
    "items":{
        "$ref":"#/components/schemas/shipmentLineChangeRequests-shipmentLines-serials-standardDFF-item-post-request"
    },
    "x-cardinality":"1"
}

Nested Schema : shipmentLineChangeRequests-shipmentLines-serials-attributeDFF-item-post-request

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Value

  Maximum Length: 30

  Descriptive flexfield context name for serial attributes.
• __FLEX_Context_DisplayValue: string
  Title: Context Value

  Descriptive flexfield number of segments for serial attributes.
• FromSerialNumber: string
  Maximum Length: 80
• TransactionInterfaceId: integer (int64)

{
    "type":"object",
    "properties":{
        "TransactionInterfaceId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18
            }
        },
        "FromSerialNumber":{
            "maxLength":80,
            "type":"string",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true
            }
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Value",
            "type":"string",
            "description":"Descriptive flexfield number of segments for serial attributes.",
            "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":"Descriptive flexfield context name for serial attributes.",
            "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_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"HIDDEN"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        }
    }
}

Nested Schema : shipmentLineChangeRequests-shipmentLines-serials-standardDFF-item-post-request

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Value

  Maximum Length: 30

  Descriptive flexfield context name for serial standards.
• __FLEX_Context_DisplayValue: string
  Title: Context Value

  Descriptive flexfield number of segments for serial standards.
• FromSerialNumber: string
  Maximum Length: 80
• TransactionInterfaceId: integer (int64)

{
    "type":"object",
    "properties":{
        "TransactionInterfaceId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18
            }
        },
        "FromSerialNumber":{
            "maxLength":80,
            "type":"string",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true
            }
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Value",
            "type":"string",
            "description":"Descriptive flexfield number of segments for serial standards.",
            "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":"Descriptive flexfield context name for serial standards.",
            "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_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(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 : shipmentLineChangeRequests-shipmentLines-serials-item-response

Type: object

Show Source

• attributeDFF: array Flexfields for Serial Attributes
  Title: Flexfields for Serial Attributes

  The Flexfields for Serial Attributes resource manages details about serial attributes for the serial numbers.
• FromSerialNumber: string
  Maximum Length: 80

  Starting serial number in a range of serial numbers. The application uses this attribute when the warehouse places the item under serial control.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• standardDFF: array Flexfields for Serials
  Title: Flexfields for Serials

  The Flexfields for Serials resource manages details about serial numbers.
• ToSerialNumber: string
  Maximum Length: 80

  Ending serial number in a range of serial numbers. The application uses this attribute when the warehouse places the item under serial control.

{
    "type":"object",
    "properties":{
        "attributeDFF":{
            "title":"Flexfields for Serial Attributes",
            "type":"array",
            "description":"The Flexfields for Serial Attributes resource manages details about serial attributes for the serial numbers.",
            "items":{
                "$ref":"#/components/schemas/shipmentLineChangeRequests-shipmentLines-serials-attributeDFF-item-response"
            },
            "x-cardinality":"1"
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "FromSerialNumber":{
            "maxLength":80,
            "type":"string",
            "description":"Starting serial number in a range of serial numbers. The application uses this attribute when the warehouse places the item under serial control.",
            "nullable":false,
            "x-queryable":false
        },
        "standardDFF":{
            "title":"Flexfields for Serials",
            "type":"array",
            "description":"The Flexfields for Serials resource manages details about serial numbers.",
            "items":{
                "$ref":"#/components/schemas/shipmentLineChangeRequests-shipmentLines-serials-standardDFF-item-response"
            },
            "x-cardinality":"1"
        },
        "ToSerialNumber":{
            "maxLength":80,
            "type":"string",
            "description":"Ending serial number in a range of serial numbers. The application uses this attribute when the warehouse places the item under serial control.",
            "nullable":true,
            "x-queryable":false
        }
    }
}

Nested Schema : Flexfields for Serial Attributes

Type: array

Title: Flexfields for Serial Attributes

The Flexfields for Serial Attributes resource manages details about serial attributes for the serial numbers.

Show Source

• Array of: object shipmentLineChangeRequests-shipmentLines-serials-attributeDFF-item-response

{
    "title":"Flexfields for Serial Attributes",
    "type":"array",
    "description":"The Flexfields for Serial Attributes resource manages details about serial attributes for the serial numbers.",
    "items":{
        "$ref":"#/components/schemas/shipmentLineChangeRequests-shipmentLines-serials-attributeDFF-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 : Flexfields for Serials

Type: array

Title: Flexfields for Serials

The Flexfields for Serials resource manages details about serial numbers.

Show Source

• Array of: object shipmentLineChangeRequests-shipmentLines-serials-standardDFF-item-response

{
    "title":"Flexfields for Serials",
    "type":"array",
    "description":"The Flexfields for Serials resource manages details about serial numbers.",
    "items":{
        "$ref":"#/components/schemas/shipmentLineChangeRequests-shipmentLines-serials-standardDFF-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : shipmentLineChangeRequests-shipmentLines-serials-attributeDFF-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Value

  Maximum Length: 30

  Descriptive flexfield context name for serial attributes.
• __FLEX_Context_DisplayValue: string
  Title: Context Value

  Descriptive flexfield number of segments for serial attributes.
• FromSerialNumber: string
  Maximum Length: 80
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• TransactionInterfaceId: integer (int64)

{
    "type":"object",
    "properties":{
        "TransactionInterfaceId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "FromSerialNumber":{
            "maxLength":80,
            "type":"string",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Value",
            "type":"string",
            "description":"Descriptive flexfield number of segments for serial attributes.",
            "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":"Descriptive flexfield context name for serial attributes.",
            "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_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."
        }
    }
}

Nested Schema : shipmentLineChangeRequests-shipmentLines-serials-standardDFF-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Value

  Maximum Length: 30

  Descriptive flexfield context name for serial standards.
• __FLEX_Context_DisplayValue: string
  Title: Context Value

  Descriptive flexfield number of segments for serial standards.
• FromSerialNumber: string
  Maximum Length: 80
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• TransactionInterfaceId: integer (int64)

{
    "type":"object",
    "properties":{
        "TransactionInterfaceId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "FromSerialNumber":{
            "maxLength":80,
            "type":"string",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Value",
            "type":"string",
            "description":"Descriptive flexfield number of segments for serial standards.",
            "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":"Descriptive flexfield context name for serial standards.",
            "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_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"
    }
}

Links

attributeDFF

Operation: /fscmRestApi/resources/11.13.18.05/shipmentLineChangeRequests/{TransactionId}/child/shipmentLines/{shipmentLinesUniqID}/child/serials/{serialsUniqID}/child/attributeDFF

Parameters:

• TransactionId: $request.path.TransactionId
• serialsUniqID: $request.path.serialsUniqID
• shipmentLinesUniqID: $request.path.shipmentLinesUniqID

The Flexfields for Serial Attributes resource manages details about serial attributes for the serial numbers.

standardDFF

Operation: /fscmRestApi/resources/11.13.18.05/shipmentLineChangeRequests/{TransactionId}/child/shipmentLines/{shipmentLinesUniqID}/child/serials/{serialsUniqID}/child/standardDFF

Parameters:

• TransactionId: $request.path.TransactionId
• serialsUniqID: $request.path.serialsUniqID
• shipmentLinesUniqID: $request.path.shipmentLinesUniqID

The Flexfields for Serials resource manages details about serial numbers.

Back to Top