Get all plans
get
/fscmRestApi/resources/11.13.18.05/inspectionPlans
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:- PrimaryKey: Finds inspection details.
Finder Variables:- InspectionPlanId; integer; Value that uniquely identifies the inspection plan.
- findByInspectionPlanName: Finds details according to the inspection plan.
Finder Variables:- Name; string; Name of the inspection plan.
- PrimaryKey: Finds inspection details.
-
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:- Approver; string; Identifies the user who approved the plan.
- AssetGroupId; integer; Value that uniquely identifies the asset group of the asset to inspect if inspection plan type is Asset.
- AssetGroupNumber; string; Alphanumeric value that 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 plan type is Asset.
- AssetNumber; string; Alphanumeric value that identifies the asset number to inspect if inspection plan type is Asset.
- CatalogName; string; Name of the catalog to inspect if InspectionPlanType is one of the following values Receiving, Inventory, Asset or Work in Process.
- CategoryId; integer; Value that uniquely identifies the category of the item to inspect if InspectionPlanType is one of the following values Receiving, Inventory, Asset or Work in Process.
- CategoryName; string; Name of the category of the item to inspect if InspectionPlanType is one of the following values Receiving, Inventory, Asset or Work in Process.
- CategorySetId; integer; Value that uniquely identifies the catalog of the item to inspect if InspectionPlanType is one of the following values Receiving, Inventory, Asset or Work in Process.
- CreatedBy; string; User who created the inspection plan.
- CreationDate; string; Date when the user created the inspection plan.
- Description; string; Description of the inspection plan.
- EffectiveEndDate; string; End date when the inspection plan is no longer in effect.
- EffectiveStartDate; string; Start date and time when the inspection plan is in effect. The default value is the current system date and time.
- EnabledFlag; boolean; Contains one of the following values: Yes or No. If Yes, then inspection plan is enabled. If No, then inspection plan is disabled. The default value is Yes.
- InspectionLevelDescription; string; Description for the inspection level.
- InspectionLevelId; integer; Value that uniquely identifies the inspection level.
- InspectionLevelName; string; Name of the inspection level.
- InspectionPlanId; integer; Value that uniquely identifies the inspection plan.
- InventoryItemId; integer; Value that uniquely identifies the item that the inspection plan references if the InspectionPlanType is one of the following values Receiving, Inventory, Asset or Work in Process.
- ItemNumber; string; Alphanumeric value that identifies the item that the inspection plan references if InspectionPlanType is one of the following values Receiving, Inventory, Asset or Work in Process.
- ItemRevision; string; Value that identifies the revision of the item if InspectionPlanType is one of the following values Receiving, Inventory, Asset or Work in Process. This attribute is optional.
- LastUpdateDate; string; Date when the user most recently updated the inspection plan.
- LastUpdatedBy; string; Name of the user who most recently updated the inspection plan.
- Name; string; Name of the inspection plan.
- OptionalFlag; boolean; Contains one of the following values: Yes or No. If Yes, then inspection plan is optional. If No, then inspection plan is mandatory. The default value is No.
- OrganizationCode; string; Abbreviation that identifies the organization.
- OrganizationId; integer; Value that uniquely identifies the organization that the inspection plan references.
- Owner; string; Name of the user who created the inspection plan.
- ResourceId; integer; Value that uniquely identifies the resource under the work center to inspect if InspectionPlanType is Resource.
- ResourceName; string; Name of the resource under the work center to inspect if InspectionPlanType is Resource.
- Status; string; Status of inspection plan. Valid values include New, On hold, Obsolete, and Approved. A list of accepted values is defined in the lookup type ORA_QA_IP_STATUSES. The default value is New.
- Type; string; Type of inspection plan. Valid values are Receiving, Inventory, Work in Process, Resource, and Asset. A list of accepted values is defined in the lookup type ORA_QA_IP_TYPES.
- VersionNumber; string; Version number of the inspection plan.
- WorkCenter; string; Name of the work center to inspect if InspectionPlanType is Resource.
- WorkCenterId; integer; Value that uniquely identifies the work center to inspect if InspectionPlanType is Resource.
-
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 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 : inspectionPlans
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:
ItemsThe items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
LinksThe 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:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : inspectionPlans-item-response
Type:
Show Source
object-
Approver: string
Maximum Length:
100Identifies the user who approved the plan. -
AssetGroupId: integer
(int64)
Value that uniquely identifies the asset group of the asset to inspect if inspection plan type is Asset.
-
AssetGroupNumber: string
Maximum Length:
255Alphanumeric value that identifies the asset group of the asset to inspect if inspection plan type is Asset. -
AssetId: integer
(int64)
Value that uniquely identifies the asset number to inspect if inspection plan type is Asset.
-
AssetNumber: string
Maximum Length:
255Alphanumeric value that identifies the asset number to inspect if inspection plan type is Asset. -
attachments: array
Attachments in Inspection Plans
Title:
Attachments in Inspection PlansThe Attachments in Inspection Plans resource displays attachment details for the inspection plan. -
CatalogName: string
Name of the catalog to inspect if InspectionPlanType is one of the following values Receiving, Inventory, Asset or Work in Process.
-
CategoryId: integer
(int64)
Value that uniquely identifies the category of the item to inspect if InspectionPlanType is one of the following values Receiving, Inventory, Asset or Work in Process.
-
CategoryName: string
Name of the category of the item to inspect if InspectionPlanType is one of the following values Receiving, Inventory, Asset or Work in Process.
-
CategorySetId: integer
(int64)
Value that uniquely identifies the catalog of the item to inspect if InspectionPlanType is one of the following values Receiving, Inventory, Asset or Work in Process.
-
CreatedBy: string
Read Only:
trueMaximum Length:64User who created the inspection plan. -
CreationDate: string
(date-time)
Read Only:
trueDate when the user created the inspection plan. -
criteria: array
Criteria in Inspection Plans
Title:
Criteria in Inspection PlansThe Criteria in Inspection Plans resource manages criteria for the inspection plan. -
Description: string
Maximum Length:
240Description of the inspection plan. -
EffectiveEndDate: string
(date-time)
End date when the inspection plan is no longer in effect.
-
EffectiveStartDate: string
(date-time)
Start date and time when the inspection plan is in effect. The default value is the current system date and time.
-
EnabledFlag: boolean
Maximum Length:
1Default Value:trueContains one of the following values: Yes or No. If Yes, then inspection plan is enabled. If No, then inspection plan is disabled. The default value is Yes. -
InspectionInstructions: string
(byte)
Contents of the inspection instructions for the inspection plan.
-
InspectionLevelDescription: string
Read Only:
trueDescription for the inspection level. -
InspectionLevelId: integer
(int64)
Value that uniquely identifies the inspection level.
-
InspectionLevelName: string
Name of the inspection level.
-
InspectionPlanId: integer
(int64)
Value that uniquely identifies the inspection plan.
-
InventoryItemId: integer
(int64)
Value that uniquely identifies the item that the inspection plan references if the InspectionPlanType is one of the following values Receiving, Inventory, Asset or Work in Process.
-
ItemNumber: string
Alphanumeric value that identifies the item that the inspection plan references if InspectionPlanType is one of the following values Receiving, Inventory, Asset or Work in Process.
-
ItemRevision: string
Maximum Length:
18Value that identifies the revision of the item if InspectionPlanType is one of the following values Receiving, Inventory, Asset or Work in Process. This attribute is optional. -
LastUpdateDate: string
(date-time)
Read Only:
trueDate when the user most recently updated the inspection plan. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64Name of the user who most recently updated the inspection plan. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
Name: string
Title:
NameMaximum Length:80Name of the inspection plan. -
OptionalFlag: boolean
Maximum Length:
1Default Value:falseContains one of the following values: Yes or No. If Yes, then inspection plan is optional. If No, then inspection plan is mandatory. The default value is No. -
OrganizationCode: string
Abbreviation that identifies the organization.
-
OrganizationId: integer
(int64)
Value that uniquely identifies the organization that the inspection plan references.
-
OrganizationName: string
Read Only:
trueMaximum Length:240Name of the organization. -
Owner: string
Maximum Length:
100Name of the user who created the inspection plan. -
PlanStatusMeaning: string
Read Only:
trueMaximum Length:80Indicates the status of the inspection plan. Valid values include New, On hold, Obsolete, and Approved. -
PlanTypeMeaning: string
Read Only:
trueMaximum Length:80Indicates the type of inspection plan. Valid values are Receiving, Inventory, Work in Process, Asset, and Resource. -
ResourceId: integer
(int64)
Value that uniquely identifies the resource under the work center to inspect if InspectionPlanType is Resource.
-
ResourceName: string
Name of the resource under the work center to inspect if InspectionPlanType is Resource.
-
specifications: array
Specifications in Inspection Plans
Title:
Specifications in Inspection PlansThe Specifications in Inspection Plans resource manages the specifications of the inspection plan. -
Status: string
Maximum Length:
30Status of inspection plan. Valid values include New, On hold, Obsolete, and Approved. A list of accepted values is defined in the lookup type ORA_QA_IP_STATUSES. The default value is New. -
Type: string
Maximum Length:
30Type of inspection plan. Valid values are Receiving, Inventory, Work in Process, Resource, and Asset. A list of accepted values is defined in the lookup type ORA_QA_IP_TYPES. -
VersionNumber: string
Maximum Length:
30Version number of the inspection plan. -
WorkCenter: string
Name of the work center to inspect if InspectionPlanType is Resource.
-
WorkCenterId: integer
(int64)
Value that uniquely identifies the work center to inspect if InspectionPlanType is Resource.
Nested Schema : Attachments in Inspection Plans
Type:
arrayTitle:
Attachments in Inspection PlansThe Attachments in Inspection Plans resource displays attachment details for the inspection plan.
Show Source
Nested Schema : Criteria in Inspection Plans
Type:
arrayTitle:
Criteria in Inspection PlansThe Criteria in Inspection Plans resource manages criteria for the inspection plan.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Specifications in Inspection Plans
Type:
arrayTitle:
Specifications in Inspection PlansThe Specifications in Inspection Plans resource manages the specifications of the inspection plan.
Show Source
Nested Schema : inspectionPlans-attachments-item-response
Type:
Show Source
object-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker IdAn identifier used for tracking the uploaded files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document IdValue that uniquely identifies the attached document. -
CategoryName: string
Title:
CategoryMaximum Length:30Category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:255User who created the attachment. -
CreatedByUserName: string
Title:
Created By User NameRead Only:trueLogin that the user used when creating the attachment for the specification. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueDate when the user created the attachment record. -
DatatypeCode: string
Title:
TypeMaximum Length:30Default Value:FILEAbbreviation that identifies the file data type. -
Description: string
Title:
DescriptionMaximum Length:255Description of the attachment. -
DmDocumentId: string
Maximum Length:
255Value that uniquely identifies the attached document. -
DmFolderPath: string
Title:
Dm Folder PathMaximum Length:1000Folder path of the attachment. -
DmVersionNumber: string
Maximum Length:
255Number that identifies the version of the attached document. -
DownloadInfo: string
Title:
DownloadInfoJSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status CodeAbbreviation that identifies the error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status MessageText of the error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration DateDate when the contents in the attachment expires. -
FileContents: string
(byte)
Title:
File ContentsContents of the attachment. -
FileName: string
Title:
File NameMaximum Length:2048Name of the file. -
FileUrl: string
Title:
File UrlURL (Uniform Resource Locator) of the attached file. -
FileWebImage: string
(byte)
Title:
File Web ImageRead Only:trueThe base64 encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update DateRead Only:trueDate and time when the user most recently updated the specification attachment. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:255User who most recently updated the attachment for the specification. -
LastUpdatedByUserName: string
Title:
Last Updated By UserRead Only:trueLogin that the user used when updating the attachment for the specification. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingActionThe name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
TitleTitle of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content TypeContent type of the attachment. -
UploadedFileLength: integer
Title:
File SizeLength of the attachment file. -
UploadedFileName: string
Title:
Uploaded File NameName of the attachment file. -
UploadedText: string
Title:
Uploaded TextText of the attachment. -
Uri: string
Title:
UriMaximum Length:4000URI (Uniform Resource Identifier) of the attachment. -
Url: string
Title:
UrlMaximum Length:4000URL (Uniform Resource Locator) of the attachment. -
UserName: string
Title:
User NameRead Only:trueMaximum Length:255Login that the user used when adding or modifying the attachment.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed 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.
Nested Schema : inspectionPlans-criteria-item-response
Type:
Show Source
object-
CreatedBy: string
Read Only:
trueMaximum Length:64User who created the inspection criteria record. -
CreationDate: string
(date-time)
Read Only:
trueDate when the user created the inspection criteria. -
CriteriaId: integer
(int64)
Value that uniquely identifies the inspection plan criteria.
-
DispatchStatus: string
Maximum Length:
80Status of the dispatch in the work order operation. A list of accepted values include Ready and Reject. -
DispatchStatusMeaning: string
Read Only:
trueMaximum Length:60Value that identifies the dispatch status of the work order operation.Valid Accepted values include Ready and Reject. -
DocumentType: string
Maximum Length:
20Type of document for the inspection event where InspectionPlanType 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. -
DocumentTypeMeaning: string
Read Only:
trueMaximum Length:80Value that identifies the type of document for the inspection event where the 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. -
EnabledFlag: boolean
Maximum Length:
1Default Value:trueContains one of the following values: Yes or No. If Yes, then inspection criteria is enabled. If No, then inspection criteria is not enabled. The default value is Yes. -
InspectionPlanId: integer
(int64)
Value that uniquely identifies the inspection plan.
-
InspectionPlanType: string
Maximum Length:
30Type of inspection plan. Valid values include Receiving, Inventory, Work in process, and Resource. A list of accepted values is defined in the lookup type ORA_QA_IP_TYPES. -
LastUpdateDate: string
(date-time)
Read Only:
trueDate and time when the user most recently updated the inspection criteria. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who most recently updated the inspection criteria. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
Locator: string
Value that identifies the locator within the subinventory. This attribute is required where InspectionPlanType is Inventory. This is optional.
-
LocatorId: integer
(int64)
Value that uniquely identifies the locator within the subinventory. This attribute is required where InspectionPlanType is Inventory. This is optional.
-
OperationCode: string
Maximum Length:
30Abbreviation that identifies the operation for this item. -
OperationCodeMeaning: string
Read Only:
trueMaximum Length:480Value that identifies the operation that the item is associated to. -
OperationSequenceNumber: integer
Sequence number of the work order operation that occurs during manufacturing inspection.
-
ProcurementBUCode: string
Abbreviation that identifies the procurement business unit.
-
ProcurementBUId: integer
Value that uniquely identifies the procurement business unit.
-
SourceOrganization: string
Value that identifies the source organization. This attribute is required where InspectionPlanType is Receiving and DocumentType is In-transit shipment or Transfer order.
-
SourceOrganizationId: integer
(int64)
Value that uniquely identifies the organization that requested the item. This attribute is required where InspectionPlanType is Receiving and DocumentType is In-transit shipment or Transfer order.
-
SourceOrganizationName: string
Maximum Length:
255Value that identifies the source organization. This attribute is required where inspection plan type is Receiving and DocumentType is In-transit shipment or Transfer order. -
SubinventoryCode: string
Title:
SubinventoryMaximum Length:10Abbreviation that identifies the subinventory. This attribute is required where InspectionPlanType is Inventory. -
SubinventoryId: integer
Value that uniquely identifies the subinventory. This attribute is required where InspectionPlanType is Inventory.
-
Supplier: string
Maximum Length:
255Name of the supplier. This attribute is required where InspectionPlanType is Receiving and DocumentType is Purchase order. -
SupplierId: integer
(int64)
Value that uniquely identifies the supplier who supplies the material to inspect. This attribute is required where InspectionPlanType is Receiving and DocumentType is Purchase order.
-
SupplierSite: string
Value that identifies the supplier site. This attribute is required where InspectionPlanType is Receiving, DocumentType is Purchase order for the specified supplier. This is optional.
-
SupplierSiteId: integer
(int64)
Value that uniquely identifies the supplier site. This attribute is required where InspectionPlanType is Receiving and DocumentType is Purchase order for the specified supplier. This is optional.
-
WorkDefinitionName: string
Maximum Length:
255Value that identifies the work definition name. This attribute is applicable where inspection plan type is Asset. This is optional. -
WorkDefinitionNameId: integer
(int64)
Value that uniquely identifies the work definition name. This attribute is applicable where inspection plan type is Asset. This is optional.
-
WorkOrderSubTypeCode: string
Maximum Length:
30Abbreviation that identifies the work order sub type code. This attribute is applicable where inspection plan type is Asset. This is optional. -
WorkOrderSubTypeMeaning: string
Maximum Length:
255Value that identifies the work order sub type. This attribute is applicable where inspection plan type is Asset. A list of accepted values is defined in the lookup type ORA_MNT_WO_SUB_TYPE. This is optional. -
WorkOrderTypeCode: string
Maximum Length:
30Abbreviation that identifies the type of work order. This attribute is applicable where inspection plan type is Asset.This is optional. -
WorkOrderTypeMeaning: string
Maximum Length:
255Value that identifies the type of work order. This attribute is applicable where inspection plan type is Asset. A list of accepted values is defined in the lookup type ORA_MNT_WO_TYPE. This is optional.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : inspectionPlans-specifications-item-response
Type:
Show Source
object-
AiSuggestion: string
Maximum Length:
1Indicates that the characteristic has been created from a generative AI suggestion. -
attachments: array
Specification Attachments in Inspection Plans
Title:
Specification Attachments in Inspection PlansThe Specification Attachments in Inspection Plans resource displays attachment details for the specifications of the inspection plan. -
CharacteristicId: integer
(int64)
Title:
Characteristic IDValue that uniquely identifies the inspection characteristic against which the specification is being defined. -
CharacteristicName: string
Name of the inspection characteristic.
-
CreatedBy: string
Read Only:
trueMaximum Length:64User who created the inspection specification. -
CreationDate: string
(date-time)
Read Only:
trueDate when the user created the inspection specification. -
DefaultValueFlag: boolean
Maximum Length:
1Contains one of the following values: Yes or No. If Yes, then the result value should be defaulted from the target value associated to the specification line during an inspection. If No, then the result value is not defaulted from the target value associated to the specification line during an inspection. This attribute does not have a default value. -
GaugeAssetGroup: string
Maximum Length:
255Alphanumeric value that identifies the gauge asset group used to collect the inspection result value. -
GaugeAssetGroupId: integer
(int64)
Value that uniquely identifies the gauge asset group used to collect the inspection result value.
-
GaugeResource: string
Maximum Length:
255Alphanumeric value that identifies the gauge resource used to collect the inspection result value. -
GaugeResourceId: integer
(int64)
Value that uniquely identifies the gauge resource used to collect the inspection result value.
-
InspectionPlanId: integer
(int64)
Value that uniquely identifies the inspection plan.
-
ItemTargetValue: string
Title:
Item Based Target ValueMaximum Length:80Optimal value for an item. -
LastUpdateDate: string
(date-time)
Read Only:
trueDate and time when the user most recently updated the inspection specification. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who most recently updated the inspection specification. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MaximumValueDate: string
(date-time)
Upper limit of the acceptable date range for an inspection characteristic.
-
MaximumValueNumber: number
Upper limit of the acceptable numeric range for an inspection characteristic.
-
MinimumValueDate: string
(date-time)
Lower limit of the acceptable date range for an inspection characteristic.
-
MinimumValueNumber: number
Lower limit of the acceptable numeric range for an inspection characteristic.
-
NonItemTargetValue: string
Maximum Length:
255Target value of the inspection characteristic. -
OptionalFlag: boolean
Maximum Length:
1Contains one of the following values: Yes or No. If Yes, then the entry of result value is optional during an inspection. If No, then the entry of result value mandatory during an inspection. This attribute does not have a default value. -
SpecificationCharacteristicName: string
Maximum Length:
255Name of the inspection characteristic. -
SpecificationId: integer
(int64)
Value that uniquely identifies the specification for the inspection plan.
-
TargetValue: string
Title:
Target Value CharacterMaximum Length:80Target value of the inspection characteristic. -
TargetValueDate: string
(date-time)
Optimal date value for the inspection characteristic.
-
TargetValueNumber: number
Optimal numeric value for the inspection characteristic.
-
UOMCode: string
Maximum Length:
3Abbreviation that identifies the unit of measurement for the quantity that this event inspects. -
UOMMeaning: string
Read Only:
trueMaximum Length:80Value that identifies the unit of measurement for the quantity that this event inspects. -
UserSequence: integer
(int32)
Sequence to use when associating the inspection characteristic with the inspection plan.
Nested Schema : Specification Attachments in Inspection Plans
Type:
arrayTitle:
Specification Attachments in Inspection PlansThe Specification Attachments in Inspection Plans resource displays attachment details for the specifications of the inspection plan.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : inspectionPlans-specifications-attachments-item-response
Type:
Show Source
object-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker IdAn identifier used for tracking the uploaded files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document IdValue that uniquely identifies the attached document. -
CategoryName: string
Title:
CategoryMaximum Length:30Category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:255User who created the attachment. -
CreatedByUserName: string
Title:
Created By User NameRead Only:trueLogin that the user used when creating the attachment for the specification. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueDate when the user created the attachment record. -
DatatypeCode: string
Title:
TypeMaximum Length:30Default Value:FILEAbbreviation that identifies the file data type. -
Description: string
Title:
DescriptionMaximum Length:255Description of the attachment. -
DmDocumentId: string
Maximum Length:
255Value that uniquely identifies the attached document. -
DmFolderPath: string
Title:
Dm Folder PathMaximum Length:1000Folder path of the attachment. -
DmVersionNumber: string
Maximum Length:
255Number that identifies the version of the attached document. -
DownloadInfo: string
Title:
DownloadInfoJSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status CodeAbbreviation that identifies the error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status MessageText of the error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration DateDate when the contents in the attachment expires. -
FileContents: string
(byte)
Title:
File ContentsContents of the attachment. -
FileName: string
Title:
File NameMaximum Length:2048Name of the file. -
FileUrl: string
Title:
File UrlURL (Uniform Resource Locator) of the attached file. -
FileWebImage: string
(byte)
Title:
File Web ImageRead Only:trueThe base64 encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update DateRead Only:trueDate and time when the user most recently updated the specification attachment. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:255User who most recently updated the attachment for the specification. -
LastUpdatedByUserName: string
Title:
Last Updated By UserRead Only:trueLogin that the user used when updating the attachment for the specification. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingActionThe name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
TitleTitle of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content TypeContent type of the attachment. -
UploadedFileLength: integer
Title:
File SizeLength of the attachment file. -
UploadedFileName: string
Title:
Uploaded File NameName of the attachment file. -
UploadedText: string
Title:
Uploaded TextText of the attachment. -
Uri: string
Title:
UriMaximum Length:4000URI (Uniform Resource Identifier) of the attachment. -
Url: string
Title:
UrlMaximum Length:4000URL (Uniform Resource Locator) of the attachment. -
UserName: string
Title:
User NameRead Only:trueMaximum Length:255Login that the user used when adding or modifying the attachment.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Examples
These examples describe how to get all inspection plans.
Example 1 cURL Command
Use the following cURL command to submit a request on the REST resource:
curl -u username:password "https://servername/fscmRestApi/resources/version/inspectionPlans"
Example 1 Response Body
The following shows an example of the response body in JSON format.
{
"items": [{
"InspectionPlanId": 300100111994293,
"OrganizationId": 207,
"VersionNumber": "1",
"Name": "QIM_BAT_InspPlan_NoCrt_07211744123",
"Description": "One",
"InspectionPlanType": "INVENTORY",
"InspectionPlanStatus": "OBSOLETE",
"EnabledFlag": true,
"EffectiveStartDate": "2017-07-21T00:00:00+00:00",
"EffectiveEndDate": null,
"InspectionLevelId": 100,
"InventoryItemId": 300100053456029,
"Revision": null,
"CategorySetId": null,
"CategoryId": null,
"WorkCenterId": null,
"ResourceId": null,
"Owner": "QUALITY_ENGINEER",
"OptionalFlag": false,
"Approver": null,
"OrganizationCode": "M1",
"WorkCenter": null,
"ResourceName": null,
"ItemNumber": "AS49000C",
"CatalogName": null,
"CategoryName": null,
"InspectionLevelName": "100%",
"InspectionLevelDescription": "100% Inspection",
"CreatedBy": "QUALITY_ENGINEER",
"CreationDate": "2017-07-21T11:41:57+00:00",
"LastUpdateDate": "2017-07-21T11:44:35+00:00",
"LastUpdateLogin": "54D2F6340C901B46E0534280F50AF654",
"LastUpdatedBy": "QUALITY_ENGINEER",
"links": [{
"rel": "self",
"href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100111994293",
"name": "inspectionPlans",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
}
}, {
"rel": "canonical",
"href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100111994293",
"name": "inspectionPlans",
"kind": "item"
}, {
"rel": "lov",
"href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100111994293/lov/ItemNumberLOV",
"name": "ItemNumberLOV",
"kind": "collection"
}, {
"rel": "lov",
"href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100111994293/lov/InspectionPlanStatusLOV",
"name": "InspectionPlanStatusLOV",
"kind": "collection"
}, {
"rel": "lov",
"href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100111994293/lov/InspectionPlanTypeLOV",
"name": "InspectionPlanTypeLOV",
"kind": "collection"
}, {
"rel": "lov",
"href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100111994293/lov/CatalogLOV",
"name": "CatalogLOV",
"kind": "collection"
}, {
"rel": "lov",
"href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100111994293/lov/OrganizationCodeLOV",
"name": "OrganizationCodeLOV",
"kind": "collection"
}, {
"rel": "lov",
"href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100111994293/lov/InspectionLevelLOV",
"name": "InspectionLevelLOV",
"kind": "collection"
}, {
"rel": "lov",
"href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100111994293/lov/OwnerLOV",
"name": "OwnerLOV",
"kind": "collection"
}, {
"rel": "lov",
"href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100111994293/lov/ItemRevisionLOV",
"name": "ItemRevisionLOV",
"kind": "collection"
}, {
"rel": "lov",
"href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100111994293/lov/CategoryLOV",
"name": "CategoryLOV",
"kind": "collection"
}, {
"rel": "lov",
"href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100111994293/lov/WorkCenterLOV",
"name": "WorkCenterLOV",
"kind": "collection"
}, {
"rel": "lov",
"href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100111994293/lov/ApproverLOV",
"name": "ApproverLOV",
"kind": "collection"
}, {
"rel": "lov",
"href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100111994293/lov/ResourceCodeLOV",
"name": "ResourceCodeLOV",
"kind": "collection"
}, {
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100111994293/child/criteria",
"name": "criteria",
"kind": "collection"
}, {
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100111994293/child/specifications",
"name": "specifications",
"kind": "collection"
}, {
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100111994293/child/planAttachments",
"name": "planAttachments",
"kind": "collection"
}]
}, {...
}],
"count": 25,
"hasMore": true,
"limit": 25,
"offset": 0,
"links": [{
"rel": "self",
"href": "https://servername/fscmRestApi/resources/version/inspectionPlans",
"name": "inspectionPlans",
"kind": "collection"
}]
}
Example 2 cURL Command
Use the following cURL command to submit a request on the REST resource:
curl -u username:password "https://servername/fscmRestApi/resources/version/inspectionPlans?q=Type=ASSET"
Example 2 Response Body
The following shows an example of the response body in JSON format.
{
"items": [
{
"InspectionPlanId": 300100574881132,
"OrganizationId": 300100113363336,
"VersionNumber": "1",
"Name": "QIM23A-ASSETNUM-UI-01152362258",
"Description": "Automation Asset plan",
"Type": "ASSET",
"Status": "OBSOLETE",
"EnabledFlag": true,
"EffectiveStartDate": "2023-01-15T14:23:04+00:00",
"EffectiveEndDate": null,
"InspectionLevelId": 100,
"InventoryItemId": null,
"ItemRevision": null,
"CategorySetId": null,
"CategoryId": null,
"WorkCenterId": null,
"ResourceId": null,
"Owner": "QUALITY_ENGINEER",
"OptionalFlag": true,
"Approver": null,
"OrganizationCode": "MNTALM",
"WorkCenter": null,
"ResourceName": null,
"ItemNumber": null,
"CatalogName": null,
"CategoryName": null,
"InspectionLevelName": "100%",
"InspectionLevelDescription": "100% Inspection",
"CreatedBy": "QUALITY_ENGINEER",
"CreationDate": "2023-01-15T14:23:04+00:00",
"LastUpdateDate": "2023-01-15T14:29:05.227+00:00",
"LastUpdatedBy": "QUALITY_ENGINEER",
"AssetId": 300100117993592,
"AssetNumber": "F0554-02",
"AssetGroupId": null,
"AssetGroupNumber": null,
"links": [
{
"rel": "self",
"href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100574881132",
"name": "inspectionPlans",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000878"
}
},
{
"rel": "canonical",
"href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100574881132",
"name": "inspectionPlans",
"kind": "item"
},
{
"rel": "lov",
"href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100574881132/lov/InspectionPlanTypeLOV",
"name": "InspectionPlanTypeLOV",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100574881132/lov/InspectionPlanStatusLOV",
"name": "InspectionPlanStatusLOV",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100574881132/lov/OrganizationCodeLOV",
"name": "OrganizationCodeLOV",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100574881132/lov/InspectionLevelLOV",
"name": "InspectionLevelLOV",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100574881132/lov/CategoryLOV",
"name": "CategoryLOV",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100574881132/lov/ItemRevisionLOV",
"name": "ItemRevisionLOV",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100574881132/lov/ItemNumberLOV",
"name": "ItemNumberLOV",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100574881132/lov/ApproverLOV",
"name": "ApproverLOV",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100574881132/lov/WorkCenterLOV",
"name": "WorkCenterLOV",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100574881132/lov/ResourceCodeLOV",
"name": "ResourceCodeLOV",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100574881132/lov/AssetGroupLOV",
"name": "AssetGroupLOV",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100574881132/lov/CatalogLOV",
"name": "CatalogLOV",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100574881132/lov/OwnerLOV",
"name": "OwnerLOV",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100574881132/lov/AssetNumberLOV",
"name": "AssetNumberLOV",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100574881132/child/attachments",
"name": "attachments",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100574881132/child/criteria",
"name": "criteria",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100574881132/child/specifications",
"name": "specifications",
"kind": "collection"
}
]
},
{
"InspectionPlanId": 300100575661579,
"OrganizationId": 204,
"VersionNumber": "1",
"Name": "testasset66",
"Description": null,
"Type": "ASSET",
"Status": "NEW",
"EnabledFlag": true,
"EffectiveStartDate": "2023-01-17T10:04:04+00:00",
"EffectiveEndDate": null,
"InspectionLevelId": 100,
"InventoryItemId": null,
"ItemRevision": null,
"CategorySetId": null,
"CategoryId": null,
"WorkCenterId": null,
"ResourceId": null,
"Owner": "quality_engineer_KO",
"OptionalFlag": false,
"Approver": null,
"OrganizationCode": "V1",
"WorkCenter": null,
"ResourceName": null,
"ItemNumber": null,
"CatalogName": null,
"CategoryName": null,
"InspectionLevelName": "100%",
"InspectionLevelDescription": "100% Inspection",
"CreatedBy": "quality_engineer_KO",
"CreationDate": "2023-01-17T10:04:03+00:00",
"LastUpdateDate": "2023-01-17T10:06:50.167+00:00",
"LastUpdatedBy": "quality_engineer_KO",
"AssetId": 4033,
"AssetNumber": "AS54888 _102",
"AssetGroupId": null,
"AssetGroupNumber": null,
"links": [
{
"rel": "self",
"href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100575661579",
"name": "inspectionPlans",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
}
},
{
"rel": "canonical",
"href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100575661579",
"name": "inspectionPlans",
"kind": "item"
},
{
"rel": "lov",
"href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100575661579/lov/InspectionPlanTypeLOV",
"name": "InspectionPlanTypeLOV",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100575661579/lov/InspectionPlanStatusLOV",
"name": "InspectionPlanStatusLOV",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100575661579/lov/OrganizationCodeLOV",
"name": "OrganizationCodeLOV",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100575661579/lov/InspectionLevelLOV",
"name": "InspectionLevelLOV",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100575661579/lov/CategoryLOV",
"name": "CategoryLOV",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100575661579/lov/ItemRevisionLOV",
"name": "ItemRevisionLOV",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100575661579/lov/ItemNumberLOV",
"name": "ItemNumberLOV",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100575661579/lov/ApproverLOV",
"name": "ApproverLOV",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100575661579/lov/WorkCenterLOV",
"name": "WorkCenterLOV",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100575661579/lov/ResourceCodeLOV",
"name": "ResourceCodeLOV",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100575661579/lov/AssetGroupLOV",
"name": "AssetGroupLOV",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100575661579/lov/CatalogLOV",
"name": "CatalogLOV",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100575661579/lov/OwnerLOV",
"name": "OwnerLOV",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100575661579/lov/AssetNumberLOV",
"name": "AssetNumberLOV",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100575661579/child/attachments",
"name": "attachments",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100575661579/child/criteria",
"name": "criteria",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100575661579/child/specifications",
"name": "specifications",
"kind": "collection"
}
]
}
],
"count": 2,
"hasMore": false,
"limit": 25,
"offset": 0,
"links": [
{
"rel": "self",
"href": "https://servername/fscmRestApi/resources/version/inspectionPlans",
"name": "inspectionPlans",
"kind": "collection"
}
]
}