Get one specification
get
/fscmRestApi/resources/11.13.18.05/inspectionPlans/{InspectionPlanId}/child/specifications/{SpecificationId}
Request
Path Parameters
-
InspectionPlanId(required): integer(int64)
Value that uniquely identifies the inspection plan.
-
SpecificationId(required): integer(int64)
Value that uniquely identifies the specification for the inspection plan.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : inspectionPlans-specifications-item-response
Type:
Show Source
object
-
attachments: array
Specification Attachments in Inspection Plans
Title:
Specification Attachments in Inspection Plans
The Specification Attachments in Inspection Plans resource displays attachment details for the specifications of the inspection plan. -
CharacteristicId: integer
(int64)
Title:
Characteristic ID
Value that uniquely identifies the inspection characteristic against which the specification is being defined. -
CharacteristicName: string
Name of the inspection characteristic.
-
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the inspection specification. -
CreationDate: string
(date-time)
Read Only:
true
Date when the user created the inspection specification. -
DefaultValueFlag: boolean
Maximum Length:
1
Contains 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. -
InspectionPlanId: integer
(int64)
Value that uniquely identifies the inspection plan.
-
ItemTargetValue: string
Title:
Item Based Target Value
Maximum Length:80
Optimal value for an item. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the user most recently updated the inspection specification. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the inspection specification. -
links: array
Links
Title:
Links
The 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.
-
OptionalFlag: boolean
Maximum Length:
1
Contains 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. -
SpecificationId: integer
(int64)
Value that uniquely identifies the specification for the inspection plan.
-
TargetValue: string
Title:
Target Value Character
Maximum Length:80
Target 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:
3
Abbreviation 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:
array
Title:
Specification Attachments in Inspection Plans
The Specification Attachments in Inspection Plans resource displays attachment details for the specifications of the inspection plan.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The 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 Id
An identifier used for tracking the uploaded files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
Value that uniquely identifies the attached document. -
CategoryName: string
Title:
Category
Maximum Length:30
Category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
User who created the attachment. -
CreatedByUserName: string
Title:
Created By User Name
Read Only:true
Login that the user used when creating the attachment for the specification. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date when the user created the attachment record. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
Abbreviation that identifies the file data type. -
Description: string
Title:
Description
Maximum Length:255
Description of the attachment. -
DmDocumentId: string
Maximum Length:
255
Value that uniquely identifies the attached document. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
Folder path of the attachment. -
DmVersionNumber: string
Maximum Length:
255
Number that identifies the version of the attached document. -
DownloadInfo: string
Title:
DownloadInfo
JSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
Abbreviation that identifies the error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
Text of the error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
Date when the contents in the attachment expires. -
FileContents: string
(byte)
Title:
File Contents
Contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
Name of the file. -
FileUrl: string
Title:
File Url
URL (Uniform Resource Locator) of the attached file. -
FileWebImage: string
(byte)
Title:
File Web Image
Read Only:true
The base64 encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
Date and time when the user most recently updated the specification attachment. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
User who most recently updated the attachment for the specification. -
LastUpdatedByUserName: string
Title:
Last Updated By User
Read Only:true
Login that the user used when updating the attachment for the specification. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingAction
The name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
Title
Title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
Content type of the attachment. -
UploadedFileLength: integer
Title:
File Size
Length of the attachment file. -
UploadedFileName: string
Title:
Uploaded File Name
Name of the attachment file. -
UploadedText: string
Title:
Uploaded Text
Text of the attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
URI (Uniform Resource Identifier) of the attachment. -
Url: string
Title:
Url
Maximum Length:4000
URL (Uniform Resource Locator) of the attachment. -
UserName: string
Title:
User Name
Read Only:true
Maximum Length:255
Login that the user used when adding or modifying the attachment.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Links
- attachments
-
Parameters:
- InspectionPlanId:
$request.path.InspectionPlanId
- SpecificationId:
$request.path.SpecificationId
The Specification Attachments in Inspection Plans resource displays attachment details for the specifications of the inspection plan. - InspectionPlanId:
Examples
This example describes how to get one specification.
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/inspectionPlans/InspectionPlanId/child/specifications/SpecificationId"
For example, the following command gets one specification where the inspection plan specification identifier is 300100152744369:
curl -u username:password "https://servername/fscmRestApi/resources/version/inspectionPlans/InspectionPlanId/child/specifications/300100152744369"
Example Response Body
The following shows an example of the response body in JSON format.
{ "SpecificationId": 300100152744369, "ObjectVersionNumber": 1, "InspectionPlanId": 300100152744368, "UserSequence": 10, "CharacteristicId": 300100151903834, "UOMCode": null, "TargetValue": "Green", "CreatedBy": "QUALITY_ENGINEER", "CreationDate": "2018-07-02T07:40:18.324+00:00", "LastUpdatedBy": "QUALITY_ENGINEER", "LastUpdateDate": "2018-07-02T07:40:18.773+00:00", "LastUpdateLogin": "6FFF203DFC3A7766E05368BFF20A59EB", "MaximumValueDate": null, "MinimumValueDate": null, "TargetValueDate": null, "CharacteristicName": "QIM_P1_NonItemInspChar", "MaximumValueNumber": null, "MinimumValueNumber": null, "TargetValueNumber": null, "ItemTargetValue": null, "links": [{ "rel": "self", "href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100152744368/child/specifications/300100152744369", "name": "specifications", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100152744368/child/specifications/300100152744369", "name": "specifications", "kind": "item" }, { "rel": "parent", "href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100152744368", "name": "inspectionPlans", "kind": "item" }, { "rel": "lov", "href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100152744368/child/specifications/300100152744369/lov/CharacteristicValueLOV", "name": "CharacteristicValueLOV", "kind": "collection" }, { "rel": "lov", "href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100152744368/child/specifications/300100152744369/lov/CharacteristicNameLOV", "name": "CharacteristicNameLOV", "kind": "collection" }, { "rel": "lov", "href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100152744368/child/specifications/300100152744369/lov/UnitOfMeasureLOV", "name": "UnitOfMeasureLOV", "kind": "collection" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100152744368/child/specifications/300100152744369/child/specificationAttachments", "name": "specificationAttachments", "kind": "collection" }] }