Create one result
post
/fscmRestApi/resources/11.13.18.05/inspectionEvents/{IpEventId}/child/Sample/{SampleId}/child/SampleDisposition/{SampleEventDispositionId}/child/SampleResult
Request
Path Parameters
-
IpEventId(required): integer
Value that uniquely identifies the inspection event.
-
SampleEventDispositionId(required): integer(int64)
Value that uniquely identifies the event sample disposition.
-
SampleId(required): number
Value that uniquely identifies the sample to inspect.
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
Attachments: array
Result Attachments
Title:
Result Attachments
The Result Attachments resource manages the attachments for the sample results. -
CharacteristicId(required): integer
(int64)
Value that uniquely identifies the characteristic that this event is inspecting in the sample.
-
CharacteristicName: string
Name that identifies the characteristic that this event is inspecting in the sample.
-
Comments: string
Maximum Length:
4000
Comments that the user enters during inspection. -
DataType: string
Maximum Length:
255
Name of the type of data for the characteristic that the application is inspecting. -
Disposition: string
Inspection disposition result. Valid values include ACCEPT or REJECT.
-
Evaluation: string
Maximum Length:
80
Value that indicates whether the disposition evaluates the result. -
InSpecification: string
Describes whether the result remained within specifications.
-
InspectionDate(required): string
(date-time)
Date and time that this event collected this result.
-
IpEventId(required): integer
(int64)
Value that uniquely identifies the inspection event that collected the result.
-
OptionalFlag: boolean
Maximum Length:
1
Contains one of the following values: true or false. If true, then the entry of result value is optional during an inspection. If false, then the entry of result value is mandatory during an inspection. This attribute does not have a default value. -
Quantity: number
Quantity of samples that this event inspected.
-
ResultEvaluation: array
Result Evaluations
Title:
Result Evaluations
The Result Evaluations resource manages the evaluation results. -
ResultValueChar: string
Maximum Length:
80
Inspection result represented as a string. If this resource can represent this result as a string, then it uses ResultValueChar. -
ResultValueCharNonValidated: string
Maximum Length:
80
Value that identifies the results of the character data type that the application does not validate. -
ResultValueDate: string
(date-time)
Date when this event entered the sample inspection result.
-
ResultValueNumber: number
Inspection result represented as a number. If this resource can represent this result as a number, then it uses ResultValueNumber.
-
SampleId(required): integer
(int64)
Value that uniquely identifies the sample results that this event is entering.
-
SampleResultId: integer
(int64)
Value that uniquely identifies the result of the sample inspection.
-
UOMCode: string
Maximum Length:
3
Unit of measurement for the quantity of samples that this event inspects. -
UserSequence: integer
(int32)
User sequence.
Nested Schema : Result Attachments
Type:
array
Title:
Result Attachments
The Result Attachments resource manages the attachments for the sample results.
Show Source
Nested Schema : Result Evaluations
Type:
array
Title:
Result Evaluations
The Result Evaluations resource manages the evaluation results.
Show Source
Nested Schema : inspectionEvents-Sample-SampleDisposition-SampleResult-Attachments-item-post-request
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
-
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
Abbreviation that identifies the 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 to 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 status. -
ErrorStatusMessage: string
Title:
Error Status Message
Error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
Expiration date of the contents in the attachment. -
FileContents: string
(byte)
Title:
File Contents
Contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
File name of the attachment. -
FileUrl: string
Title:
File Url
URL (Uniform Resource Locator) that locates the attached file. -
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) that identifies the attachment. -
Url: string
Title:
Url
Maximum Length:4000
URL (Uniform Resource Locator) that locates the attachment.
Nested Schema : schema
Type:
Show Source
object
-
AdditionalChar: string
Maximum Length:
1
Value that indicates whether the inspection plan includes the characteristic. -
Evaluation: string
Maximum Length:
1
Value that indicates whether the disposition evaluates the result. -
InSpecification: string
Maximum Length:
1
Value that indicates whether the result meets the specifications. -
IpEventDispositionId: integer
(int64)
Value that uniquely identifies the inspection event disposition.
-
IpEventId: integer
(int64)
Value that uniquely identifies the inspection event that entered the results.
-
ResultEvaluationId: integer
(int64)
Value that uniquely identifies the result evaluation.
-
SampleResultId: integer
(int64)
Value that uniquely identifies the sample result that this event uses to determine the evaluation.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
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(required):
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 : inspectionEvents-Sample-SampleDisposition-SampleResult-item-response
Type:
Show Source
object
-
Attachments: array
Result Attachments
Title:
Result Attachments
The Result Attachments resource manages the attachments for the sample results. -
CharacteristicId: integer
(int64)
Value that uniquely identifies the characteristic that this event is inspecting in the sample.
-
CharacteristicName: string
Name that identifies the characteristic that this event is inspecting in the sample.
-
Comments: string
Maximum Length:
4000
Comments that the user enters during inspection. -
DataType: string
Maximum Length:
255
Name of the type of data for the characteristic that the application is inspecting. -
Disposition: string
Inspection disposition result. Valid values include ACCEPT or REJECT.
-
Evaluation: string
Maximum Length:
80
Value that indicates whether the disposition evaluates the result. -
InSpecification: string
Describes whether the result remained within specifications.
-
InspectionDate: string
(date-time)
Date and time that this event collected this result.
-
IpEventId: integer
(int64)
Value that uniquely identifies the inspection event that collected the result.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
Read Only:
true
Object version number. You can use this attribute to lock the object. This resource increments this value every time it updates the row. It compares this number at the start and at the end of the transaction to determine whether another session updated the same row during the inspection. -
OptionalFlag: boolean
Maximum Length:
1
Contains one of the following values: true or false. If true, then the entry of result value is optional during an inspection. If false, then the entry of result value is mandatory during an inspection. This attribute does not have a default value. -
Quantity: number
Quantity of samples that this event inspected.
-
ResultEvaluation: array
Result Evaluations
Title:
Result Evaluations
The Result Evaluations resource manages the evaluation results. -
ResultValueChar: string
Maximum Length:
80
Inspection result represented as a string. If this resource can represent this result as a string, then it uses ResultValueChar. -
ResultValueCharNonValidated: string
Maximum Length:
80
Value that identifies the results of the character data type that the application does not validate. -
ResultValueDate: string
(date-time)
Date when this event entered the sample inspection result.
-
ResultValueNumber: number
Inspection result represented as a number. If this resource can represent this result as a number, then it uses ResultValueNumber.
-
SampleId: integer
(int64)
Value that uniquely identifies the sample results that this event is entering.
-
SampleResultId: integer
(int64)
Value that uniquely identifies the result of the sample inspection.
-
UOMCode: string
Maximum Length:
3
Unit of measurement for the quantity of samples that this event inspects. -
UserSequence: integer
(int32)
User sequence.
Nested Schema : Result Attachments
Type:
array
Title:
Result Attachments
The Result Attachments resource manages the attachments for the sample results.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Result Evaluations
Type:
array
Title:
Result Evaluations
The Result Evaluations resource manages the evaluation results.
Show Source
Nested Schema : inspectionEvents-Sample-SampleDisposition-SampleResult-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. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date and time when the application created the attachment. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
Abbreviation that identifies the 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 to 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 status. -
ErrorStatusMessage: string
Title:
Error Status Message
Error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
Expiration date of the contents in the attachment. -
FileContents: string
(byte)
Title:
File Contents
Contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
File name of the attachment. -
FileUrl: string
Title:
File Url
URL (Uniform Resource Locator) that locates 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 attachment. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
Login of the user who most recently updated the attachment. -
LastUpdatedByUserName: string
Title:
Last Updated By User
Read Only:true
Login that the user used when updating the attachment. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
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) that identifies the attachment. -
Url: string
Title:
Url
Maximum Length:4000
URL (Uniform Resource Locator) that locates 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.
Nested Schema : inspectionEvents-Sample-SampleDisposition-SampleResult-ResultEvaluation-item-response
Type:
Show Source
object
-
AdditionalChar: string
Maximum Length:
1
Value that indicates whether the inspection plan includes the characteristic. -
Evaluation: string
Maximum Length:
1
Value that indicates whether the disposition evaluates the result. -
InSpecification: string
Maximum Length:
1
Value that indicates whether the result meets the specifications. -
IpEventDispositionId: integer
(int64)
Value that uniquely identifies the inspection event disposition.
-
IpEventId: integer
(int64)
Value that uniquely identifies the inspection event that entered the results.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
Read Only:
true
Object version number. You can use this attribute to lock the object. This resource increments this value every time it updates the row. It compares this number at the start and at the end of the transaction to determine whether another session updated the same row during the inspection. -
ResultEvaluationId: integer
(int64)
Value that uniquely identifies the result evaluation.
-
SampleResultId: integer
(int64)
Value that uniquely identifies the sample result that this event uses to determine the evaluation.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- Attachments
-
Parameters:
- IpEventId:
$request.path.IpEventId
- SampleEventDispositionId:
$request.path.SampleEventDispositionId
- SampleId:
$request.path.SampleId
- SampleResultId:
$request.path.SampleResultId
The Result Attachments resource manages the attachments for the sample results. - IpEventId:
- ResultEvaluation
-
Parameters:
- IpEventId:
$request.path.IpEventId
- SampleEventDispositionId:
$request.path.SampleEventDispositionId
- SampleId:
$request.path.SampleId
- SampleResultId:
$request.path.SampleResultId
The Result Evaluations resource manages the evaluation results. - IpEventId: