Jump to

• Request
• Response
• Examples

Get all inspection plans in approved status matching the criteria specified in finder.

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 inspection plan that matches the criteria specified.
    Finder Variables
    • AssetId; integer; Value that uniquely identifies the asset number to inspect if inspection type is Asset.
    • DispatchStatus; string; Dispatch status of the work order operation. Valid values include Ready and Reject.
    • DocumentType; string; Type of document for the inspection event where inspection plan type is Receiving. Valid values include Purchase order, Transfer order, In-transit shipment, and Return material authorization. A list of accepted values is defined in the lookup type ORA_QA_IP_DOC_TYPES.
    • 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; Sequence number of the work order operation that occurs during manufacturing inspection.
    • OrganizationCode; string; Abbreviation that identifies the organization.
    • OrganizationId; integer; Value that uniquely identifies the organization.
    • ReceiptQuantity; number; Receipt quantity.
    • ResourceCode; string; Abbreviation that identifies a resource.
    • ResourceId; integer; Value that uniquely identifies the resource.
    • Revision; string; Revision; string; of the item.
    • 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. Valid values include WIP and RCV.
    • SubinventoryCode; string; Abbreviation that identifies the subinventory.
    • SubinventoryId; integer; Value that uniquely identifies the subinventory.
    • Supplier; string; Abbreviation that identifies the supplier.
    • SupplierId; integer; Value that uniquely identifies the supplier.
    • SupplierSite; string; Abbreviation that identifies the supplier site.
    • SupplierSiteId; integer; Value that uniquely identifies the supplier site.
    • 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.
    • WorkCenterId; integer; Value that uniquely identifies the work center.
    • 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; Work order quantity.
    • 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.
• 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 catalog to inspect if inspection plan type is one of the following values Receiving, Inventory, or Work in process.
  • CategoryId; integer; Value that uniquely identifies the category of the item to inspect if inspection plan type is one of the following values Receiving, Inventory, or Work in process.
  • CategoryName; string; Name of the category of the item to inspect if inspection plan type is one of the following values Receiving, Inventory, or Work in process.
  • CategorySetId; integer; Value that uniquely identifies the catalog of the item to inspect if inspection plan type is one of the following values Receiving, Inventory, or Work in process.
  • Description; string; Indicates the translatable description of inspection plan version.
  • DispatchStatus; string; Status of the dispatch in the work order operation. A list of accepted values include Ready and Reject.
  • DocumentType; string; Type of document for the inspection event where inspection plan type is Receiving. Valid values include Purchase order, Transfer order, In-transit shipment, and Return material authorization. A list of accepted values is defined in the lookup type ORA_QA_IP_DOC_TYPES.
  • ErrorMessage; string; Error details, if an error occurs.
  • InspPlanVersion; string; Version number of the inspection plan.
  • InspectionCheckValue; string; Contains one of the following values. N: The application doesn't require an inspection because it can't 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 inspection plan.
  • InspectionQuantity; number; Number of samples or serials inspected.
  • InventoryItemId; integer; Value that uniquely identifies the inventory item.
  • ItemNumber; string; Number that identifies the item inspected.
  • 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 operation.
  • OperationSequenceNumber; integer; Sequence number of the work order operation that occurs during manufacturing inspection.
  • 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 isn't optional. The default value is false.
  • OrganizationCode; string; Abbreviation that identifies the organization.
  • OrganizationId; integer; Value that uniquely identifies the organization.
  • ReceiptQuantity; number; Quantity received.
  • ResourceCode; string; Abbreviation that identifies the resource.
  • ResourceId; integer; Value that uniquely identifies the resource.
  • ReturnStatus; string; Return status of the service call.
  • Revision; string; Revision of the item.
  • 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. Valid values include WIP and RCV. If WIP, the source product is work in progress. If RCV, the source product is in receiving.
  • SubinventoryCode; string; Abbreviation that identifies the subinventory.
  • SubinventoryId; integer; Value that uniquely identifies the subinventory.
  • Supplier; string; Abbreviation that identifies the supplier.
  • SupplierId; integer; Value that uniquely identifies the supplier.
  • SupplierSite; string; Abbreviation that identifies the supplier site.
  • SupplierSiteId; integer; Value that uniquely identifies the supplier site.
  • 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.
  • WorkCenterId; integer; Value that uniquely identifies the work center.
  • 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; Work order quantity.
  • 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: string
  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: string
  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:
  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.

Body ()

Root Schema : inspectionFlagCommonParams

Type: object

Show Source

• 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.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"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":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/inspectionFlagCommonParams-item-response"
            }
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        }
    },
    "x-hints":{
        "subgroup":"Manufacturing",
        "usage":"BusinessObject",
        "group":"SCM"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object inspectionFlagCommonParams-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/inspectionFlagCommonParams-item-response"
    }
}

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

Type: object

Show Source

• 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 catalog to inspect if inspection plan type is one of the following values Receiving, Inventory, or Work in process.
• CategoryId: integer (int64)
  Value that uniquely identifies the category of the item to inspect if inspection plan type is one of the following values Receiving, Inventory, or Work in process.
• CategoryName: string
  Name of the category of the item to inspect if inspection plan type is one of the following values Receiving, Inventory, or Work in process.
• CategorySetId: integer (int64)
  Value that uniquely identifies the catalog of the item to inspect if inspection plan type is one of the following values Receiving, Inventory, or Work in process.
• Description: string
  Indicates the translatable description of inspection plan version.
• DispatchStatus: string
  Status of the dispatch in the work order operation. A list of accepted values include Ready and Reject.
• DocumentType: string
  Type of document for the inspection event where inspection plan type is Receiving. Valid values include Purchase order, Transfer order, In-transit shipment, and Return material authorization. A list of accepted values is defined in the lookup type ORA_QA_IP_DOC_TYPES.
• ErrorMessage: string
  Error details, if an error occurs.
• InspectionCheckValue: string
  Contains one of the following values. N: The application doesn't require an inspection because it can't 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 inspection plan.
• InspectionQuantity: number
  Number of samples or serials inspected.
• InspPlanVersion: string
  Version number of the inspection plan.
• InventoryItemId: integer
  Value that uniquely identifies the inventory item.
• InventoryQuantityDecimalPrecision: integer
  Decimal precision of the extended inventory quantity.
• ItemNumber: string
  Number that identifies the item inspected.
• 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 operation.
• OperationSequenceNumber: integer
  Sequence number of the work order operation that occurs during manufacturing inspection.
• 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 isn't optional. The default value is false.
• OrganizationCode: string
  Abbreviation that identifies the organization.
• OrganizationId: integer
  Value that uniquely identifies the organization.
• ReceiptQuantity: number
  Quantity received.
• ResourceCode: string
  Abbreviation that identifies the resource.
• ResourceId: integer
  Value that uniquely identifies the resource.
• ReturnStatus: string
  Return status of the service call.
• Revision: string
  Revision of the item.
• 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 uniquely identifies the source organization.
• SourceOrganizationId: integer
  Value that uniquely identifies the source organization.
• SourceProductCode: string
  Abbreviation that identifies the source product. Valid values include WIP and RCV. If WIP, the source product is work in progress. If RCV, the source product is in receiving.
• SubinventoryCode: string
  Maximum Length: 10

  Abbreviation that identifies the subinventory.
• SubinventoryId: integer
  Value that uniquely identifies the subinventory.
• Supplier: string
  Abbreviation that identifies the supplier.
• SupplierId: integer
  Value that uniquely identifies the supplier.
• SupplierSite: string
  Abbreviation that identifies the supplier site.
• SupplierSiteId: integer
  Value that uniquely identifies the supplier site.
• 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.
• WorkCenterId: integer
  Value that uniquely identifies the work center.
• 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
  Work order quantity.
• 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.

{
    "type":"object",
    "properties":{
        "AssetGroupId":{
            "type":"integer",
            "description":"Value that uniquely identifies the asset group of the asset to inspect if inspection plan type is Asset.",
            "nullable":true,
            "x-queryable":true
        },
        "AssetId":{
            "type":"integer",
            "description":"Value that uniquely identifies the asset number to inspect if inspection type is Asset.",
            "nullable":true,
            "x-queryable":true
        },
        "CatalogName":{
            "type":"string",
            "description":"Name of the catalog to inspect if inspection plan type is one of the following values Receiving, Inventory, or Work in process.",
            "nullable":true,
            "x-queryable":true
        },
        "CategoryId":{
            "type":"integer",
            "description":"Value that uniquely identifies the category of the item to inspect if inspection plan type is one of the following values Receiving, Inventory, or Work in process.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CategoryName":{
            "type":"string",
            "description":"Name of the category of the item to inspect if inspection plan type is one of the following values Receiving, Inventory, or Work in process.",
            "nullable":true,
            "x-queryable":true
        },
        "CategorySetId":{
            "type":"integer",
            "description":"Value that uniquely identifies the catalog of the item to inspect if inspection plan type is one of the following values Receiving, Inventory, or Work in process.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Description":{
            "type":"string",
            "description":"Indicates the translatable description of inspection plan version.",
            "nullable":true,
            "x-queryable":true
        },
        "DispatchStatus":{
            "type":"string",
            "description":"Status of the dispatch in the work order operation. A list of accepted values include Ready and Reject.",
            "nullable":true,
            "x-queryable":true
        },
        "DocumentType":{
            "type":"string",
            "description":"Type of document for the inspection event where inspection plan type is Receiving. Valid values include Purchase order, Transfer order, In-transit shipment, and Return material authorization. A list of accepted values is defined in the lookup type ORA_QA_IP_DOC_TYPES.",
            "nullable":true,
            "x-queryable":true
        },
        "ErrorMessage":{
            "type":"string",
            "description":"Error details, if an error occurs.",
            "nullable":true,
            "x-queryable":true
        },
        "InspPlanVersion":{
            "type":"string",
            "description":"Version number of the inspection plan.",
            "nullable":true,
            "x-queryable":true
        },
        "InspectionCheckValue":{
            "type":"string",
            "description":"Contains one of the following values. N: The application doesn't require an inspection because it can't find the inspection plan. O: The application found the inspection plan, and the inspection is optional.",
            "nullable":true,
            "x-queryable":true
        },
        "InspectionDate":{
            "type":"string",
            "description":"Date and time when the plan was inspected.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "InspectionLevelId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inspection level.",
            "nullable":true,
            "x-queryable":false
        },
        "InspectionLevelName":{
            "title":"Inspection Level",
            "maxLength":255,
            "type":"string",
            "description":"Name of the inspection level.",
            "nullable":true,
            "x-queryable":false
        },
        "InspectionPlanId":{
            "type":"integer",
            "description":"Value that uniquely identifies the returned inspection plan.",
            "nullable":true,
            "x-queryable":true
        },
        "InspectionPlanName":{
            "title":"Inspection Plan",
            "type":"string",
            "description":"Name of the inspection plan.",
            "nullable":true,
            "x-queryable":true
        },
        "InspectionQuantity":{
            "type":"number",
            "description":"Number of samples or serials inspected.",
            "nullable":true,
            "x-queryable":true
        },
        "InventoryItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inventory item.",
            "nullable":true,
            "x-queryable":true
        },
        "InventoryQuantityDecimalPrecision":{
            "type":"integer",
            "description":"Decimal precision of the extended inventory quantity.",
            "nullable":true,
            "x-queryable":false
        },
        "ItemNumber":{
            "type":"string",
            "description":"Number that identifies the item inspected.",
            "nullable":true,
            "x-queryable":true
        },
        "Locator":{
            "type":"string",
            "description":"Abbreviation that identifies the locator where the material resides.",
            "nullable":true,
            "x-queryable":true
        },
        "LocatorId":{
            "type":"integer",
            "description":"Value that uniquely identifies the locator.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OperationCode":{
            "type":"string",
            "description":"Abbreviation that identifies the operation.",
            "nullable":true,
            "x-queryable":true
        },
        "OperationSequenceNumber":{
            "type":"integer",
            "description":"Sequence number of the work order operation that occurs during manufacturing inspection.",
            "nullable":true,
            "x-queryable":true
        },
        "OptionalFlag":{
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the returned inspection plan is optional. If false, then the plan isn't optional. The default value is false.",
            "nullable":true,
            "x-queryable":true
        },
        "OrganizationCode":{
            "type":"string",
            "description":"Abbreviation that identifies the organization.",
            "nullable":true,
            "x-queryable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the organization.",
            "nullable":true,
            "x-queryable":true
        },
        "ReceiptQuantity":{
            "type":"number",
            "description":"Quantity received.",
            "nullable":true,
            "x-queryable":true
        },
        "ResourceCode":{
            "type":"string",
            "description":"Abbreviation that identifies the resource.",
            "nullable":true,
            "x-queryable":true
        },
        "ResourceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the resource.",
            "nullable":true,
            "x-queryable":true
        },
        "ReturnStatus":{
            "type":"string",
            "description":"Return status of the service call.",
            "nullable":true,
            "x-queryable":true
        },
        "Revision":{
            "type":"string",
            "description":"Revision of the item.",
            "nullable":true,
            "x-queryable":true
        },
        "SampleQuantity":{
            "type":"number",
            "description":"Quantity of material required for inspection on a per sample basis.",
            "nullable":true,
            "x-queryable":false
        },
        "SampleQuantityUOM":{
            "maxLength":255,
            "type":"string",
            "description":"Unit of measure for quantity per sample.",
            "nullable":true,
            "x-queryable":false
        },
        "Samples":{
            "title":"Samples",
            "type":"number",
            "description":"Quantity from the sampling plan to inspect.",
            "nullable":true,
            "x-queryable":false
        },
        "SamplingPlanType":{
            "title":"Sampling Plan Type",
            "maxLength":255,
            "type":"string",
            "description":"Type of sampling plan. A list of accepted values is defined in the lookup type ORA_QA_SAMPLING_PLAN_TYPE.",
            "nullable":true,
            "x-queryable":false
        },
        "SamplingPlanTypeCode":{
            "maxLength":255,
            "type":"string",
            "description":"Code of the sampling plan type. A list of accepted values is defined in the lookup type ORA_QA_SAMPLING_PLAN_TYPE.",
            "nullable":true,
            "x-queryable":false
        },
        "SourceOrganizationCode":{
            "maxLength":255,
            "type":"string",
            "description":"Abbreviation that uniquely identifies the source organization.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "SourceOrganizationId"
                ]
            },
            "x-queryable":true
        },
        "SourceOrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the source organization.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceProductCode":{
            "type":"string",
            "description":"Abbreviation that identifies the source product. Valid values include WIP and RCV. If WIP, the source product is work in progress. If RCV, the source product is in receiving.",
            "nullable":true,
            "x-queryable":true
        },
        "SubinventoryCode":{
            "maxLength":10,
            "type":"string",
            "description":"Abbreviation that identifies the subinventory.",
            "nullable":true,
            "x-queryable":true
        },
        "SubinventoryId":{
            "type":"integer",
            "description":"Value that uniquely identifies the subinventory.",
            "nullable":true,
            "x-queryable":true
        },
        "Supplier":{
            "type":"string",
            "description":"Abbreviation that identifies the supplier.",
            "nullable":true,
            "x-queryable":true
        },
        "SupplierId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier.",
            "nullable":true,
            "x-queryable":true
        },
        "SupplierSite":{
            "type":"string",
            "description":"Abbreviation that identifies the supplier site.",
            "nullable":true,
            "x-queryable":true
        },
        "SupplierSiteId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier site.",
            "nullable":true,
            "x-queryable":true
        },
        "TotalSampleQuantityInSampleUOM":{
            "type":"number",
            "description":"Total quantity of material required for testing in the sample quantity unit of measure.",
            "nullable":true,
            "x-queryable":false
        },
        "TotalSampleQuantityInTransactionUOM":{
            "type":"number",
            "description":"Total quantity of material required for testing in the inspection quantity unit of measure.",
            "nullable":true,
            "x-queryable":false
        },
        "TransactionQuantity":{
            "type":"number",
            "description":"Transaction quantity.",
            "nullable":true,
            "x-queryable":true
        },
        "TransactionUOM":{
            "maxLength":255,
            "type":"string",
            "description":"Unit of measurement for the quantity of items to inspect in this event.",
            "nullable":true,
            "x-queryable":true
        },
        "TransactionUOMCode":{
            "maxLength":255,
            "type":"string",
            "description":"Abbreviation that identifies the unit of measure to use for the sample to inspect.",
            "nullable":true,
            "x-queryable":true
        },
        "WorkCenter":{
            "type":"string",
            "description":"Abbreviation that identifies the work center.",
            "nullable":true,
            "x-queryable":true
        },
        "WorkCenterId":{
            "type":"integer",
            "description":"Value that uniquely identifies the work center.",
            "nullable":true,
            "x-queryable":true
        },
        "WorkDefinitionNameId":{
            "type":"integer",
            "description":"Value that uniquely identifies the work definition name. This attribute is applicable where inspection plan type is Asset. This is optional.",
            "nullable":true,
            "x-queryable":true
        },
        "WorkOrderQuantity":{
            "type":"number",
            "description":"Work order quantity.",
            "nullable":true,
            "x-queryable":true
        },
        "WorkOrderSubType":{
            "maxLength":255,
            "type":"string",
            "description":"Abbreviation that identifies the work order subtype code. This attribute is applicable where inspection plan type is Asset. This is optional.",
            "nullable":true,
            "x-queryable":true
        },
        "WorkOrderType":{
            "maxLength":255,
            "type":"string",
            "description":"Abbreviation that identifies the type of work order. This attribute is applicable where inspection plan type is Asset.This is optional.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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

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"
  } ]
}

Back to Top