Get all parameters
get
/fscmRestApi/resources/11.13.18.05/inspectionFlagCommonParams
Request
Query Parameters
-
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 -
finder: string
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:- QaInspectionFlagCommonParamsVOFinder: Finds the common parameters for the inspection flag.
Finder Variables:- AssetId; integer.
- DispatchStatus; string; Dispatch status.
- DocumentType; string; Type of document.
- InspectionDate; string; Date and time when the plan was inspected.
- InventoryItemId; integer; Value that uniquely identifies the inventory item.
- ItemNumber; string; Number that identifies the item.
- Locator; string; Abbreviation that identifies the locator.
- LocatorId; integer; Value that uniquely identifies the locator.
- OperationCode; string; Abbreviation that identifies the operation.
- OperationSequenceNumber; integer; Operation sequence number.
- OrganizationCode; string; Abbreviation that identifies the organization.
- OrganizationId; integer; Value that uniquely identifies the organization.
- ReceiptQuantity; number; Receipt quantity.
- ResourceCode; string; Abbreviation that identifies the resource.
- ResourceId; integer; Value that uniquely identifies the resource.
- Revision; string; Revision.
- SourceOrganizationCode; string; Abbreviation that uniquely identifies the source organization.
- SourceOrganizationId; integer; Value that uniquely identifies the source organization.
- SourceProductCode; string; Abbreviation that identifies the source product.
- SubinventoryCode; string; Abbreviation that identifies the subinventory.
- SubinventoryId; integer; Value that uniquely identifies the subinventory.
- Supplier; string; Value that uniquely identifies the supplier.
- SupplierId; integer; Value that uniquely identifies the supplier.
- SupplierSite; string; Value that uniquely identifies the supplier site.
- SupplierSiteId; integer; Value that uniquely identifies the supplier site.
- TransactionQuantity; number.
- TransactionUOM; string.
- TransactionUOMCode; string.
- WorkCenter; string; Abbreviation that identifies the work center.
- WorkCenterId; integer; Value that uniquely identifies the work center.
- WorkDefinitionNameId; integer.
- WorkOrderQuantity; number; Work order quantity.
- WorkOrderSubType; string.
- WorkOrderType; string.
- QaInspectionFlagCommonParamsVOFinder: Finds the common parameters for the inspection flag.
-
limit: integer
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.
-
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 -
offset: integer
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.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
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
-
q: string
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:- AssetGroupId; integer; Value that uniquely identifies the asset group of the asset to inspect if inspection plan type is Asset.
- AssetId; integer; Value that uniquely identifies the asset number to inspect if inspection type is Asset.
- CatalogName; string; Name of the item catalog for the returned inspection plan.
- CategoryId; integer; Value that uniquely identifies the item category.
- CategoryName; string; Name of the item category for the returned inspection plan.
- CategorySetId; integer; 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.
- InspPlanVersion; string; Version of the returned inspection plan.
- 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 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.
- InventoryItemId; integer; Value that uniquely identifies the item that the inventory organization is inspecting.
- ItemNumber; string; Name of the item to inspect.
- Locator; string; Abbreviation that identifies the locator where the material resides.
- LocatorId; integer; 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; 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; 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.
- TransactionQuantity; number; Transaction quantity.
- TransactionUOM; string; Unit of measurement for the quantity of items to inspect in this event.
- TransactionUOMCode; string; Abbreviation that identifies the unit of measure to use for the sample to inspect.
- 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.
- WorkDefinitionNameId; integer; Value that uniquely identifies the work definition name. This attribute is applicable where inspection plan type is Asset. This is optional.
- WorkOrderQuantity; number; Quantity on the work order operation for the inspected item.
- WorkOrderSubType; string; Abbreviation that identifies the work order subtype code. This attribute is applicable where inspection plan type is Asset. This is optional.
- WorkOrderType; string; Abbreviation that identifies the type of work order. This attribute is applicable where inspection plan type is Asset.This is optional.
-
totalResults: boolean
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
-
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
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : inspectionFlagCommonParams-item-response
Type:
Show Source
object
-
AssetGroupId: integer
Value that uniquely identifies the asset group of the asset to inspect if inspection plan type is Asset.
-
AssetId: integer
Value that uniquely identifies the asset number to inspect if inspection type is Asset.
-
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.
-
InspectionLevelId: integer
Value that uniquely identifies the inspection level.
-
InspectionLevelName: string
Title:
Inspection Level
Maximum Length:255
Name of the inspection level. -
InspectionPlanId: integer
Value that uniquely identifies the returned inspection plan.
-
InspectionPlanName: string
Title:
Inspection Plan
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.
-
SampleQuantity: number
Quantity of material required for inspection on a per sample basis.
-
SampleQuantityUOM: string
Maximum Length:
255
Unit of measure for quantity per sample. -
Samples: number
Title:
Samples
Quantity from the sampling plan to inspect. -
SamplingPlanType: string
Title:
Sampling Plan Type
Maximum Length:255
Type of sampling plan. A list of accepted values is defined in the lookup type ORA_QA_SAMPLING_PLAN_TYPE. -
SamplingPlanTypeCode: string
Maximum Length:
255
Code of the sampling plan type. A list of accepted values is defined in the lookup type ORA_QA_SAMPLING_PLAN_TYPE. -
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.
-
TotalSampleQuantityInSampleUOM: number
Total quantity of material required for testing in the sample quantity unit of measure.
-
TotalSampleQuantityInTransactionUOM: number
Total quantity of material required for testing in the inspection quantity unit of measure.
-
TransactionQuantity: number
Transaction quantity.
-
TransactionUOM: string
Maximum Length:
255
Unit of measurement for the quantity of items to inspect in this event. -
TransactionUOMCode: string
Maximum Length:
255
Abbreviation that identifies the unit of measure to use for the sample to inspect. -
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.
-
WorkDefinitionNameId: integer
Value that uniquely identifies the work definition name. This attribute is applicable where inspection plan type is Asset. This is optional.
-
WorkOrderQuantity: number
Quantity on the work order operation for the inspected item.
-
WorkOrderSubType: string
Maximum Length:
255
Abbreviation that identifies the work order subtype code. This attribute is applicable where inspection plan type is Asset. This is optional. -
WorkOrderType: string
Maximum Length:
255
Abbreviation that identifies the type of work order. This attribute is applicable where inspection plan type is Asset.This is optional.
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 all common parameters for inspection flags.
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/inspectionFlagCommonParams"
Example Response Body
The following example includes the contents of the response body in JSON format:
{ "items" : [ { "OrganizationId" : null, "InventoryItemId" : null, "OperationCode" : null, "DispatchStatus" : null, "OperationSequenceNumber" : null, "WorkOrderQuantity" : null, "Revision" : null, "InspectionCheckValue" : null, "InspectionPlanId" : null, "DocumentType" : null, "SupplierId" : null, "SupplierSiteId" : null, "SourceOrganizationId" : null, "ReceiptQuantity" : 0, "SourceProductCode" : null, "InspectionQuantity" : null, "InspectionPlanName" : null, "ReturnStatus" : "ERROR", "ErrorMessage" : "Invalid Source Product Code", "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" } ] }