Get one detail
get
/fscmRestApi/resources/11.13.18.05/inspectionDetails/{inspectionDetailsUniqID}
Request
Path Parameters
-
inspectionDetailsUniqID(required): string
This is the hash key of the attributes which make up the composite key--- InspectionPlanId, IpSpecificationId and UOMCode ---for the Inspection Details (Deprecated) resource and used to uniquely identify an instance of Inspection Details (Deprecated). The client should not generate the hash key value. Instead, the client should query on the Inspection Details (Deprecated) collection resource with a filter on the primary key values in order to navigate to a specific instance of Inspection Details (Deprecated).
For example: inspectionDetails?q=InspectionPlanId=<value1>;IpSpecificationId=<value2>;UOMCode=<value3>
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
-
Metadata-Context: 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 : inspectionDetails-item-response
Type:
Show Source
object-
ApproverUserId: integer
(int64)
Read Only:
trueValue that uniquely identifies the user who approved the inspection plan. This user might be different from the user who created the inspection plan or the inspection plan owner. -
AttachmentEntityName: string
Maximum Length:
255Default Value:QA_INSPECTION_PLANS_BName to use when accessing the attachments for the plan. -
AttachmentEntityNameSpecification: string
Maximum Length:
255Default Value:QA_IP_SPECIFICATIONSName to use when accessing the attachments for the plan specification. -
Attachments: array
Attachments
Title:
AttachmentsThe Attachments resource manages attachment details for the inspection plan. -
CategoryId: integer
(int64)
Read Only:
trueValue that uniquely identifies the category of the item to inspect. -
CategorySetId: integer
(int64)
Read Only:
trueValue that uniquely identifies the catalog of the item to inspect. -
CharacteristicDescription: string
Read Only:
trueMaximum Length:240Description of characteristic. -
CharacteristicId: integer
(int64)
Value that uniquely identifies the characteristic.
-
CharacteristicName: string
Read Only:
trueMaximum Length:80Name of characteristic. -
Description: string
Read Only:
trueMaximum Length:240Description of the inspection plan. -
EffectiveEndDate: string
(date)
Read Only:
trueEnd date of the date range that specifies when the inspection plan is in effect. -
EffectiveStartDate: string
(date)
Read Only:
trueStart date of the date range that specifies when the inspection plan is in effect. -
EnabledFlag: boolean
Maximum Length:
1Contains one of the following values: true or false. If true, then inspection details are enabled. If false, then details are not enabled. The default value is Yes. -
InspectionLevelId: integer
(int64)
Read Only:
trueValue that uniquely identifies the inspection level of the inspection plan. -
InspectionPlanCode: string
Read Only:
trueMaximum Length:30Abbreviation that identifies the inspection plan. -
InspectionPlanId: integer
(int64)
Read Only:
trueValue that uniquely identifies the plan to use when performing an inspection. -
InspectionPlanStatus: string
Read Only:
trueMaximum Length:30Status of the inspection plan. Values include New, On Hold, Approved, or Obsolete. -
InspectionPlanType: string
Read Only:
trueMaximum Length:30Inspection plan type. Values include Receiving, Inventory, Work In Process, or Resource. -
InventoryItemId: integer
(int64)
Read Only:
trueValue that uniquely identifies the item that the inspection plan references. -
IpSpecificationId: integer
(int64)
Value that uniquely identifies the inspection plan specification.
-
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MaximumValue: string
Maximum Length:
80Maximum threshold value of the characteristic. -
MinimumValue: string
Maximum Length:
80Minimum threshold value of the characteristic. -
Name: string
Read Only:
trueMaximum Length:80Name of the inspection plan. -
ObjectVersionNumber: integer
(int32)
Version number. You can use this number to lock the object. The resource increments this number every time it updates the row. The resource compares the number at the start and at the end of the transaction to determine whether another session updated the row since the most recent query.
-
OrganizationId: integer
(int64)
Read Only:
trueValue that uniquely identifies the organization that the inspection plan references. -
SpecificationAttachments: array
Specification Attachments
Title:
Specification AttachmentsThe Specification Attachments resource manages attachment details for the specification. -
TargetValue: string
Maximum Length:
80Target value of the characteristic. -
UnitOfMeasure: string
Title:
UOM NameRead Only:trueMaximum Length:25Name of the unit of measure. -
UOMCode: string
Title:
UOM CodeRead Only:trueMaximum Length:3Abbreviation that identifies the unit of measurement for the quantity that this event inspects. -
UserSequence: integer
(int32)
Sequence to use when inspecting the characteristic.
-
VersionNumber: string
Read Only:
trueMaximum Length:30Version number of the inspection plan.
Nested Schema : Attachments
Type:
arrayTitle:
AttachmentsThe Attachments resource manages attachment details for the inspection plan.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Specification Attachments
Type:
arrayTitle:
Specification AttachmentsThe Specification Attachments resource manages attachment details for the specification.
Show Source
Nested Schema : inspectionDetails-Attachments-item-response
Type:
Show Source
object-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker IdAttribute provided for the exclusive use by the Attachment UI components to assist in uploading 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. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueDate when the user created the attachment. -
DatatypeCode: string
Title:
TypeMaximum Length:30Default Value:FILEAbbreviation that identifies the 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 MessageError message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration DateExpiration date of the contents in the attachment. -
FileContents: string
(byte)
Title:
File ContentsContents of the attachment. -
FileName: string
Title:
File NameMaximum Length:2048Name of the attachment 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 attachment was most recently updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:255User who most recently updated attachment. -
LastUpdatedByUserName: string
Title:
Last Updated By UserRead Only:trueLogin that the user used when updating the attachment. -
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:255User who added or modified 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 : inspectionDetails-SpecificationAttachments-item-response
Type:
Show Source
object-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker IdAttribute provided for the exclusive use by the Attachment UI components to assist in uploading 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. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueDate when the user created the attachment. -
DatatypeCode: string
Title:
TypeMaximum Length:30Default Value:FILEAbbreviation that identifies the 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 MessageError message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration DateExpiration date of the contents in the attachment. -
FileContents: string
(byte)
Title:
File ContentsContents of the attachment. -
FileName: string
Title:
File NameMaximum Length:2048Name of the attachment 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 attachment was most recently updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:255User who most recently updated attachment. -
LastUpdatedByUserName: string
Title:
Last Updated By UserRead Only:trueLogin that the user used when updating the attachment. -
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:255User who added or modified the attachment.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Links
- Attachments
-
Operation: /fscmRestApi/resources/11.13.18.05/inspectionDetails/{inspectionDetailsUniqID}/child/AttachmentsParameters:
- inspectionDetailsUniqID:
$request.path.inspectionDetailsUniqID
The Attachments resource manages attachment details for the inspection plan. - inspectionDetailsUniqID:
- SpecificationAttachments
-
Parameters:
- inspectionDetailsUniqID:
$request.path.inspectionDetailsUniqID
The Specification Attachments resource manages attachment details for the specification. - inspectionDetailsUniqID:
Examples
This example describes how to get details for one inspection plan.
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/inspectionDetails?q=InspectionPlanId=InspectionPlanId"
For example, the following command gets details for inspection plan 300100090874966:
curl -u username:password "https://servername/fscmRestApi/resources/version/inspectionDetails?q=InspectionPlanId=300100090874966"
Example Response Body
The following example includes the contents of the response body in JSON format:
"InspectionPlanId" : 300100090874966,
"Name" : "Power Supply",
"Description" : null,
"InspectionLevelId" : 300100089612767,
"InspectionPlanCode" : "300100090874966",
"InspectionPlanType" : "RECEIVING",
"InspectionPlanStatus" : "NEW",
"OrganizationId" : 300100039754034,
"InventoryItemId" : null,
"ApproverUserId" : 0,
"CategoryId" : 3862,
"CategorySetId" : 300100012686450,
"VersionNumber" : "1",
"EffectiveEndDate" : null,
"EffectiveStartDate" : "2016-08-03",
"IpSpecificationId" : 300100090874967,
"ObjectVersionNumber" : 1,
"UserSequence" : 10,
"CharacteristicId" : 300100090874944,
"TargetValue" : "1.00",
"MaximumValue" : "4.00",
"MinimumValue" : "0.00",
"EnabledFlag" : true,
"UOMCode" : "AEA",
"UnitOfMeasure" : "ARU-EA",
"CharacteristicName" : "sss",
"CharacteristicDescription" : null,
"links" : [ {
"rel" : "self",
"href" : "https://servername/fscmRestApi/resources/version/inspectionDetails/00030000000EACED00057708000110F07F504C560000000EACED00057708000110F07F504C5700000003414541",
"name" : "inspectionDetails",
"kind" : "item",
"properties" : {
"changeIndicator" : "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000003737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B020000787200106A6176612E6C616E672E4F626A656374000000000000000000000078700000000178"
}
}, {
"rel" : "canonical",
"href" : "https://servername/fscmRestApi/resources/version/inspectionDetails/00030000000EACED00057708000110F07F504C560000000EACED00057708000110F07F504C5700000003414541",
"name" : "inspectionDetails",
"kind" : "item"
} ]
} ],
"count" : 1,
"hasMore" : false,
"limit" : 25,
"offset" : 0,
"links" : [ {
"rel" : "self",
"href" : "https://servername/fscmRestApi/resources/version/inspectionDetails",
"name" : "inspectionDetails",
"kind" : "collection"
} ]
}