Get all disposition details

get

/fscmRestApi/resources/11.13.18.05/recallDispositionDetails

Request

Query Parameters
  • 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).
  • 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
  • Used as a predefined finder to search the collection.

    Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    The following are the available finder names and corresponding finder variables:

    • PrimaryKey: Find recall disposition details according to the product disposition identifier.
      Finder Variables:
      • DispositionId; integer; Value that uniquely identifies the disposition detail.
  • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
  • 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
  • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
  • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

    Format: ?q=expression1;expression2

    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • ActionId; integer; Value that uniquely identifies the task assignment at product recall traceability header level or recall notice line level.
    • CreatedBy; string; User who created the record.
    • CreationDate; string; Date and time when the user created the record.
    • DispositionDocumentReference; string; Document number reference for the disposition action.
    • DispositionId; integer; Value that uniquely identifies disposition details.
    • DispositionOrganizationCode; string; Abbreviation that identifies the inventory organization from where the disposition of recalled part occurs.
    • DispositionOrganizationId; integer; Value that uniquely identifies the inventory organization from where the disposition of recalled part happens.
    • DispositionOrganizationName; string; Name of the inventory organization from where the disposition of recalled part occurs.
    • LastUpdateDate; string; Date and time when the user most recently updated the record.
    • LastUpdateLogin; string; Login that the user used when updating the record.
    • LastUpdatedBy; string; User who most recently updated the record.
    • ObjectVersionNumber; integer; 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; Quantity returned or quantity scrapped for the recalled part.
    • RecallDispositionMethod; string; Method by which the recalled parts get disposed.
    • RecallDispositionMethodCode; string; Abbreviation that identifies the method by which the recalled parts get disposed. Valid values include Return to Vendor and Scrap.
    • RecallDispositionUOMCode; string; Abbreviation that identifies the unit of measure in which recalled part is returned or scrapped.
    • RecallDispositionUnitOfMeasure; string; Unit of measure in which the recalled part is disposed.
    • RecallLineId; integer; Value that uniquely identifies the recall notice line.
    • RecallLineNumber; integer; Number that identifies the recall notice line.
    • RecallNoticeId; integer; Value that uniquely identifies the recall notice header.
    • RecallNoticeNumber; string; Number that identifies the recall notice used for internal tracking within a business unit, which gets generated based on recall document number sequence setup.
    • ShipToAddress; string; Manufacturer site address to which recalled parts are returned.
    • ShipmentNumber; string; Number that identifies the shipment with which material is returned or disposed.
    • SupplierId; integer; Value that uniquely identifies the supplier.
    • SupplierName; string; Name of the supplier.
    • SupplierSite; string; Abbreviation that identifies the supplier site.
    • SupplierSiteId; integer; Value that uniquely identifies the supplier site.
    • TaskCode; string; Abbreviation that identifies the task definition.
    • TaskName; string; Name of the task.
    • TransactionDate; string; Date when the user created the disposition transaction.
  • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
  • 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".
  • 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

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : recallDispositionDetails-item-response
Type: object
Show Source
Back to Top

Examples

This example describes how to get all disposition details.

Example cURL Command

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

curl -u username:password "https://servername/fscmRestApi/resources/version/recallDispositionDetails"

Example Response Body

The following shows an example of the response body in JSON format.

{
	"DispositionId": 100100197369300,
	"ActionId": 100100197368963,
	"RecallLineId": 300100210673489,
	"RecallLineNumber": 1,
	"RecallNoticeId": 300100210673487,
	"RecallNoticeNumber": "RND10042",
	"TaskCode": "ORA_DISPOSAL",
	"TaskName": "Perform Disposal of Recalled Parts",
	"DispositionOrganizationId": 300100200332056,
	"DispositionOrganizationCode": "HC02",
	"DispositionOrganizationName": "Vision Children Hospital",
	"RecallDispositionMethodCode": "ORA_REF_RETURN",
	"RecallDispositionMethod": "Supplier Return with Receipt Reference",
	"RecallDisposalQuantity": 2,
	"RecallDispositionUOMCode": "Ea",
	"RecallDispositionUnitOfMeasure": "Each",
	"DispositionDocumentReference": "1004916",
	"ShipmentNumber": null,
	"TransactionDate": "2020-09-09T10:36:41+00:00",
	"ShipToAddress": null,
	"SupplierId": 6134,
	"SupplierSiteId": 300100203539381,
	"SupplierSite": "MEDTRIC_123",
	"ObjectVersionNumber": 1,
	"CreationDate": "2020-09-09T10:37:31+00:00",
	"CreatedBy": "WHSE_MGR_ALL_INV_ORGS",
	"LastUpdateDate": "2020-09-09T10:37:31+00:00",
	"LastUpdatedBy": "WHSE_MGR_ALL_INV_ORGS",
	"LastUpdateLogin": "86EA862E5D974489C85A4FBAB8DAF6F4",
	"SupplierName": "Tall Manufacturing",
	"links": [
	{
		"rel": "self",
		"href": "https://servername/fscmRestApi/resources/version/recallDispositionDetails/100100197369300",
		"name": "recallDispositionDetails",
		"kind": "item",
		"properties": {
			"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
		}
	},
	{
		"rel": "canonical",
		"href": "https://servername/fscmRestApi/resources/version/recallDispositionDetails/100100197369300",
		"name": "recallDispositionDetails",
		"kind": "item"
	}
	]
}
Back to Top