Jump to

• Request
• Response

Get one disposition detail

get

/fscmRestApi/resources/11.13.18.05/recallDispositionDetails/{DispositionId}

Request

Path Parameters

• DispositionId(required): integer(int64)
  Value that uniquely identifies disposition details.

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

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.

There's no request body for this operation.

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 : recallDispositionDetails-item-response

Type: object

Show Source

• ActionId: integer (int64)
  Value that uniquely identifies the task assignment at product recall traceability header level or recall notice line level.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the record.
• CreationDate: string (date-time)
  Read Only: true

  Date and time when the user created the record.
• DispositionDocumentReference: string
  Title: Document Reference

  Maximum Length: 60

  Document number reference for the disposition action.
• DispositionId: integer (int64)
  Value that uniquely identifies disposition details.
• DispositionOrganizationCode: string
  Title: Disposition Organization

  Read Only: true

  Maximum Length: 18

  Abbreviation that identifies the inventory organization from where the disposition of recalled part occurs.
• DispositionOrganizationId: integer (int64)
  Read Only: true

  Value that uniquely identifies the inventory organization from where the disposition of recalled part happens.
• DispositionOrganizationName: string
  Read Only: true

  Maximum Length: 240

  Name of the inventory organization from where the disposition of recalled part occurs.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date and time when the user most recently updated the record.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who most recently updated the record.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  Login that the user used when updating the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectVersionNumber: integer (int32)
  Number that identifies the object version. This attribute is used to implement optimistic locking. The number is incremented every time the record is updated. The number is compared at the start and at the end of a transaction to detect whether another session has updated the record since it was queried.
• RecallDisposalQuantity: number
  Title: Disposed Quantity

  Quantity returned or quantity scrapped for the recalled part.
• RecallDispositionMethod: string
  Title: Disposition Method

  Read Only: true

  Maximum Length: 80

  Method by which the recalled parts get disposed.
• RecallDispositionMethodCode: string
  Title: Disposition Method

  Maximum Length: 60

  Abbreviation that identifies the method by which the recalled parts get disposed. Valid values include Return to Vendor and Scrap.
• RecallDispositionUnitOfMeasure: string
  Title: UOM Name

  Read Only: true

  Maximum Length: 25

  Unit of measure in which the recalled part is disposed.
• RecallDispositionUOMCode: string
  Maximum Length: 3

  Abbreviation that identifies the unit of measure in which recalled part is returned or scrapped.
• RecallLineId: integer (int64)
  Read Only: true

  Value that uniquely identifies the recall notice line.
• RecallLineNumber: integer (int64)
  Title: Line Number

  Read Only: true

  Number that identifies the recall notice line.
• RecallNoticeId: integer (int64)
  Title: Header ID

  Read Only: true

  Value that uniquely identifies the recall notice header.
• RecallNoticeNumber: string
  Title: Notice Number

  Read Only: true

  Maximum Length: 60

  Number that identifies the recall notice used for internal tracking within a business unit, which gets generated based on recall document number sequence setup.
• ShipmentNumber: string
  Title: Shipment Number

  Maximum Length: 30

  Number that identifies the shipment with which material is returned or disposed.
• ShipToAddress: string
  Title: Ship-to Address

  Maximum Length: 600

  Manufacturer site address to which recalled parts are returned.
• SupplierId: integer (int64)
  Title: Supplier

  Value that uniquely identifies the supplier.
• SupplierName: string
  Title: Supplier

  Read Only: true

  Maximum Length: 255

  Name of the supplier.
• SupplierSite: string
  Title: Supplier Site

  Read Only: true

  Maximum Length: 240

  Abbreviation that identifies the supplier site.
• SupplierSiteId: integer (int64)
  Title: Manufacturer Site

  Value that uniquely identifies the supplier site.
• TaskCode: string
  Read Only: true

  Maximum Length: 60

  Abbreviation that identifies the task definition.
• TaskName: string
  Title: Task Name

  Read Only: true

  Maximum Length: 60

  Name of the task.
• TransactionDate: string (date-time)
  Title: Transaction Date

  Date when the user created the disposition transaction.

{
    "type":"object",
    "properties":{
        "RecallLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the recall notice line.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the user created the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ShipToAddress":{
            "title":"Ship-to Address",
            "maxLength":600,
            "type":"string",
            "description":"Manufacturer site address to which recalled parts are returned.",
            "nullable":true,
            "x-queryable":true
        },
        "RecallDispositionMethodCode":{
            "title":"Disposition Method",
            "maxLength":60,
            "type":"string",
            "description":"Abbreviation that identifies the method by which the recalled parts get disposed. Valid values include Return to Vendor and Scrap.",
            "nullable":true,
            "x-queryable":true
        },
        "DispositionOrganizationName":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the inventory organization from where the disposition of recalled part occurs.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ShipmentNumber":{
            "title":"Shipment Number",
            "maxLength":30,
            "type":"string",
            "description":"Number that identifies the shipment with which material is returned or disposed.",
            "nullable":true,
            "x-queryable":true
        },
        "TaskCode":{
            "maxLength":60,
            "type":"string",
            "description":"Abbreviation that identifies the task definition.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RecallDispositionMethod":{
            "title":"Disposition Method",
            "maxLength":80,
            "type":"string",
            "description":"Method by which the recalled parts get disposed.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplierSiteId":{
            "title":"Manufacturer Site",
            "type":"integer",
            "description":"Value that uniquely identifies the supplier site.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Number that identifies the object version. This attribute is used to implement optimistic locking. The number is incremented every time the record is updated. The number is compared at the start and at the end of a transaction to detect whether another session has updated the record since it was queried.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "DispositionOrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inventory organization from where the disposition of recalled part happens.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RecallDispositionUnitOfMeasure":{
            "title":"UOM Name",
            "maxLength":25,
            "type":"string",
            "description":"Unit of measure in which the recalled part is disposed.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"edit"
            },
            "x-queryable":true
        },
        "RecallDisposalQuantity":{
            "title":"Disposed Quantity",
            "type":"number",
            "description":"Quantity returned or quantity scrapped for the recalled part.",
            "nullable":true,
            "x-queryable":true
        },
        "TransactionDate":{
            "title":"Transaction Date",
            "type":"string",
            "description":"Date when the user created the disposition transaction.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DispositionId":{
            "type":"integer",
            "description":"Value that uniquely identifies disposition details.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "RecallNoticeId":{
            "title":"Header ID",
            "type":"integer",
            "description":"Value that uniquely identifies the recall notice header.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SupplierId":{
            "title":"Supplier",
            "type":"integer",
            "description":"Value that uniquely identifies the supplier.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ActionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the task assignment at product recall traceability header level or recall notice line level.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TaskName":{
            "title":"Task Name",
            "maxLength":60,
            "type":"string",
            "description":"Name of the task.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplierName":{
            "title":"Supplier",
            "maxLength":255,
            "type":"string",
            "description":"Name of the supplier.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplierSite":{
            "title":"Supplier Site",
            "maxLength":240,
            "type":"string",
            "description":"Abbreviation that identifies the supplier site.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RecallLineNumber":{
            "title":"Line Number",
            "type":"integer",
            "description":"Number that identifies the recall notice line.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DispositionOrganizationCode":{
            "title":"Disposition Organization",
            "maxLength":18,
            "type":"string",
            "description":"Abbreviation that identifies the inventory organization from where the disposition of recalled part occurs.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DispositionDocumentReference":{
            "title":"Document Reference",
            "maxLength":60,
            "type":"string",
            "description":"Document number reference for the disposition action.",
            "nullable":true,
            "x-queryable":true
        },
        "RecallNoticeNumber":{
            "title":"Notice Number",
            "maxLength":60,
            "type":"string",
            "description":"Number that identifies the recall notice used for internal tracking within a business unit, which gets generated based on recall document number sequence setup.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the user most recently updated the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"Login that the user used when updating the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RecallDispositionUOMCode":{
            "maxLength":3,
            "type":"string",
            "description":"Abbreviation that identifies the unit of measure in which recalled part is returned or scrapped.",
            "nullable":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."
        }
    }
}

Back to Top