Get one parameter
get
/fscmRestApi/resources/11.13.18.05/inspectionFlagCommonParams/{inspectionFlagCommonParamsUniqID}
Request
Path Parameters
-
inspectionFlagCommonParamsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Inspection Parameters resource and used to uniquely identify an instance of Inspection Parameters. The client should not generate the hash key value. Instead, the client should query on the Inspection Parameters collection resource in order to navigate to a specific instance of Inspection Parameters to get the hash key.
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 TopResponse
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 : inspectionFlagCommonParams-item-response
Type:
Show Source
object
-
CatalogName: string
Name of the item catalog for the returned inspection plan.
-
CategoryId: integer
(int64)
Value that uniquely identifies the item category.
-
CategoryName: string
Name of the item category for the returned inspection plan.
-
CategorySetId: integer
(int64)
Value that uniquely identifies the category set.
-
Description: string
Description of the returned inspection plan.
-
DispatchStatus: string
Dispatch status of the work order operation for the inspected item.
-
DocumentType: string
Document type of the receiving inspection event.
-
ErrorMessage: string
Error details, if an error occurs.
-
InspectionCheckValue: string
Contains one of the following values. N: The application does not require an inspection because it cannot find the inspection plan. O: The application found the inspection plan, and the inspection is optional.
-
InspectionDate: string
(date-time)
Date and time when the plan was inspected.
-
InspectionPlanId: integer
Value that uniquely identifies the returned inspection plan.
-
InspectionPlanName: string
Name of the returned inspection plan.
-
InspectionQuantity: number
Number of samples or serials inspected.
-
InspPlanVersion: string
Version of the returned inspection plan.
-
InventoryItemId: integer
Value that uniquely identifies the item that the inventory organization is inspecting.
-
ItemNumber: string
Name of the item to inspect.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Locator: string
Abbreviation that identifies the locator where the material resides.
-
LocatorId: integer
(int64)
Value that uniquely identifies the locator.
-
OperationCode: string
Abbreviation that identifies the work order operation for the inspected item.
-
OperationSequenceNumber: integer
Sequence number of the work order operation for the inspected item.
-
OptionalFlag: boolean
Contains one of the following values: true or false. If true, then the returned inspection plan is optional. If false, then the plan is not optional. The default value is false.
-
OrganizationCode: string
Abbreviation that identifies the organization that inspected the item.
-
OrganizationId: integer
Value that uniquely identifies the inventory organization that inspected the item.
-
ReceiptQuantity: number
Quantity received.
-
ResourceCode: string
Abbreviation that identifies the inspected resource.
-
ResourceId: integer
Value that uniquely identifies the inspected resource.
-
ReturnStatus: string
Return status of the service call.
-
Revision: string
Revision of the item inspected.
-
SourceOrganizationCode: string
Maximum Length:
255
Abbreviation that identifies the source organization. This attribute is required when EventType is Receiving and DocumentType is In-transit shipment or Transfer order. -
SourceOrganizationId: integer
Value that uniquely identifies the organization that requested the item.
-
SourceProductCode: string
Abbreviation that identifies the source item.
-
SubinventoryCode: string
Maximum Length:
10
Abbreviation that identifies the subinventory. -
SubinventoryId: integer
Value that uniquely identifies the subinventory where the organization inspected the material.
-
Supplier: string
Name of the supplier. This attribute is required when InspectionPlanType is Receiving and DocumentType is Purchase order.
-
SupplierId: integer
Value that uniquely identifies the supplier who supplies the material to inspect.
-
SupplierSite: string
Name of the supplier site. This attribute is required when InspectionPlanType is Receiving, DocumentType is Purchase order for the specified supplier.
-
SupplierSiteId: integer
Value that uniquely identifies the supplier site who shipped the material.
-
WorkCenter: string
Abbreviation that identifies the work center of the inspected resource.
-
WorkCenterId: integer
Value that uniquely identifies the work center of the inspected resource.
-
WorkOrderQuantity: number
Quantity on the work order operation for the inspected item.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Examples
This example describes how to get inspection flags for one item.
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/inspectionFlagCommonParamssearch_parameters"
For example, the following command gets inspection flags for item WIP, and according to the search parameters that you specify:
curl -u username:password "https://servername/fscmRestApi/resources/version/inspectionFlagCommonParams?finder=QaInspectionFlagCommonParamsVOFinder;OrganizationId=204,InventoryItemId=144,Revision=A,DispatchStatus=READY,OperationCode=OP10,OperationSequenceNumber=20,WorkOrderQuantity=3,SourceProductCode=WIP"
Example Response Body
The following example includes the contents of the response body in JSON format:
{ "items" : [ { "OrganizationId" : 204, "InventoryItemId" : 144, "OperationCode" : "OP10", "DispatchStatus" : "READY", "OperationSequenceNumber" : 20, "WorkOrderQuantity" : 3, "Revision" : "A", "InspectionCheckValue" : "N", "InspectionPlanId" : -1, "DocumentType" : null, "SupplierId" : null, "SupplierSiteId" : null, "SourceOrganizationId" : null, "ReceiptQuantity" : 0, "SourceProductCode" : "WIP", "InspectionQuantity" : 0, "InspectionPlanName" : null, "ReturnStatus" : null, "ErrorMessage" : null, "links" : [ { "rel" : "self", "href" : "https://servername/fscmRestApi/resources/version/inspectionFlagCommonParams/0000", "name" : "inspectionFlagCommonParams", "kind" : "item" }, { "rel" : "canonical", "href" : "https://servername/fscmRestApi/resources/version/inspectionFlagCommonParams/0000", "name" : "inspectionFlagCommonParams", "kind" : "item" } ] } ], "count" : 1, "hasMore" : false, "limit" : 25, "offset" : 0, "links" : [ { "rel" : "self", "href" : "https://servername/fscmRestApi/resources/version/inspectionFlagCommonParams", "name" : "inspectionFlagCommonParams", "kind" : "collection" } ] }