Create one asset qualification
post
/fscmRestApi/resources/11.13.18.05/installedBaseAssets/{AssetId}/child/assetQualifications
Request
Path Parameters
-
AssetId(required): integer(int64)
Value that uniquely identifies the asset. The application generates this value when it creates the asset. This attribute is read-only.
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
-
AssetId(required): integer
(int64)
Value that uniquely identifies an asset. This attribute is read-only.
-
AssetQualificationId: integer
(int64)
Value that uniquely identifies the asset qualification. The application creates this value when it creates the asset qualification. This attribute is read-only.
-
attachments: array
Attachments
Title:
Attachments
The attachments resource is used to view, create, and update asset qualification attachments. -
CurrentFlag: boolean
Maximum Length:
1
Default Value:false
Value that identifies current asset qualification. -
InspectionPlanId: integer
(int64)
Value that Uniquely Identifies the inspection plan. Currently, this attribute isn't populated.
-
IpEventId: integer
(int64)
Unique identifier of the inspection event associated while performing the asset qualification.
-
NextQualificationDate: string
(date-time)
Date when the asset qualification is next due. The value can be updated till the current value becomes past. The value is defaulted based on the default interval value in associated qualification requirement.
-
QualificationRequirementCode: string
Maximum Length:
255
Code of the qualification requirement. This is a unique and required attribute to create an asset qualification. -
QualificationRequirementId(required): integer
(int64)
Value that uniquely identifies the qualification requirement. The application creates this value when it creates the qualification requirement. This attribute is mandatory.
-
QualificationRequirementName: string
Maximum Length:
255
Name of the qualification requirement. This is a unique and required attribute to create an asset qualification. -
QualifiedDate: string
(date-time)
Date when the asset qualification is created. This date can be set to a required value during creation. Once created the value can't be updated. The default value is system date.
-
WorkOrderId: integer
(int64)
Unique identifier of the work order associated while performing the asset qualification.
Nested Schema : Attachments
Type:
array
Title:
Attachments
The attachments resource is used to view, create, and update asset qualification attachments.
Show Source
Nested Schema : installedBaseAssets-assetQualifications-attachments-item-post-request
Type:
Show Source
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
Attribute provided for the exclusive use for the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
Unique identifier of 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
Value that indicates the data type. -
Description: string
Title:
Description
Maximum Length:255
Description of the attachment. -
DmDocumentId: string
Maximum Length:
255
Document ID that the attachment is created from. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
Folder path that the attachment is created from. -
DmVersionNumber: string
Maximum Length:
255
Document version number that the attachment is created from. -
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
Error code, if any, for the attachment. -
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
URI of the file. -
PostProcessingAction: string
Title:
PostProcessingAction
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
Size of the attachment file. -
UploadedFileName: string
Title:
Uploaded File Name
Name to assign to a new attachment file. -
UploadedText: string
Title:
Uploaded Text
Text content for a new text attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
URI of a Topology Manager type attachment. -
Url: string
Title:
Url
Maximum Length:4000
URL of a web page type attachment.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : installedBaseAssets-assetQualifications-item-response
Type:
Show Source
object
-
AssetId: integer
(int64)
Value that uniquely identifies an asset. This attribute is read-only.
-
AssetNumber: string
Title:
Asset Number
Read Only:true
Maximum Length:80
Number that uniquely identifies an asset. This attribute is read-only. -
AssetQualificationId: integer
(int64)
Value that uniquely identifies the asset qualification. The application creates this value when it creates the asset qualification. This attribute is read-only.
-
attachments: array
Attachments
Title:
Attachments
The attachments resource is used to view, create, and update asset qualification attachments. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the qualification requirement The application automatically sets this value during creation. This attribute is read-only. -
CreationDate: string
(date-time)
Read Only:
true
Date when the qualification requirement is created. The application automatically sets this value during creation. This attribute is read-only. -
CurrentFlag: boolean
Maximum Length:
1
Default Value:false
Value that identifies current asset qualification. -
DefaultIntervalUOMCode: string
Read Only:
true
Maximum Length:255
Meaning of the UOM code of the default interval for qualification requirement. -
Description: string
Title:
Description
Read Only:true
Maximum Length:240
Description of the asset. You can use this attribute to describe the asset features, characteristics, and so on. -
DfltQualInterval: number
Title:
Default Interval
Read Only:true
Default interval for the qualification requirement. -
EqpQualRequirementDescription: string
Title:
Description
Read Only:true
Maximum Length:240
Description of the qualification requirement. -
InspectionEventDisposition: string
Read Only:
true
Maximum Length:255
Meaning of the inspection event disposition code associated with the equipment qualification. -
InspectionEventDispositionCode: string
Read Only:
true
Maximum Length:255
Code of the inspection event disposition code associated with the equipment qualification. -
InspectionPlanId: integer
(int64)
Value that Uniquely Identifies the inspection plan. Currently, this attribute isn't populated.
-
InspectionPlanName: string
Read Only:
true
Maximum Length:255
Name of the inspection plan that was associated while performing the asset qualification. -
InspectionStatus: string
Read Only:
true
Maximum Length:255
Status of the inspection plan that's associated to the asset qualification. -
IntervalTypeCode: string
Title:
UOM
Read Only:true
Maximum Length:30
Value of the qualification requirement interval type code. -
IpEventId: integer
(int64)
Unique identifier of the inspection event associated while performing the asset qualification.
-
LastUpdateDate: string
(date-time)
Read Only:
true
Date when the user most recently updated the qualification requirement. The application automatically sets this value during creation. This attribute is read-only. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the qualification requirement. The application assigns a value to this attribute during creation. This attribute is read-only. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
Login that the user used when updating the qualification requirement. The application assigns a value to this attribute during creation. This attribute is read-only. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MaintenanceProgramName: string
Read Only:
true
Maximum Length:255
Name of the maintenance program that was associated while performing the asset qualification. -
NextQualificationDate: string
(date-time)
Date when the asset qualification is next due. The value can be updated till the current value becomes past. The value is defaulted based on the default interval value in associated qualification requirement.
-
OperationName: string
Read Only:
true
Maximum Length:255
Name of the work order operation for the work order that was associated while performing the asset qualification. -
OperationSequence: string
Read Only:
true
Maximum Length:255
Work order operation sequence of the work order associated while performing the asset qualification. -
QualificationConfirmedFlag: boolean
Read Only:
true
Status of confirmed qualification. -
QualificationProfile: string
Read Only:
true
Maximum Length:255
Name of the qualification profile. -
QualificationProfileName: string
Read Only:
true
Maximum Length:255
Display value of all the qualification profiles that are associated to the qualification requirement. -
QualificationRequirementCode: string
Maximum Length:
255
Code of the qualification requirement. This is a unique and required attribute to create an asset qualification. -
QualificationRequirementId: integer
(int64)
Value that uniquely identifies the qualification requirement. The application creates this value when it creates the qualification requirement. This attribute is mandatory.
-
QualificationRequirementName: string
Maximum Length:
255
Name of the qualification requirement. This is a unique and required attribute to create an asset qualification. -
QualificationRequirementReference: string
Read Only:
true
Maximum Length:255
Value that uniquely identifies the asset qualification. The application creates this value when it creates the asset qualification. This attribute is read-only. -
QualificationRequirementType: string
Read Only:
true
Maximum Length:255
Meaning of the qualification requirement type. -
QualifiedBy: string
Read Only:
true
Maximum Length:64
User who created the asset qualification. The application automatically sets this value during creation. This attribute is read-only. -
QualifiedByName: string
Read Only:
true
Maximum Length:255
Name of the user performing the asset qualification. -
QualifiedDate: string
(date-time)
Date when the asset qualification is created. This date can be set to a required value during creation. Once created the value can't be updated. The default value is system date.
-
RequirementTypeCode: string
Title:
Type
Read Only:true
Maximum Length:30
Value of the qualification requirement type code. -
ResourceId: integer
Read Only:
true
Unique identifier of the equipment resource. -
ResourceInstance: string
Read Only:
true
Maximum Length:255
Name of the resource instance. -
ResourceInstanceId: integer
Read Only:
true
Unique identifier of the resource instance. -
ResourceName: string
Read Only:
true
Maximum Length:255
Name of the equipment resource instance. -
SerialNumber: string
Title:
Serial Number
Read Only:true
Maximum Length:80
Number that uniquely identifies the serial that the asset references. This attribute is used when an item is serial controlled. If the serial number does not exist in the inventory, then the application creates a serial in the inventory application. -
WorkOrderId: integer
(int64)
Unique identifier of the work order associated while performing the asset qualification.
-
WorkOrderNumber: string
Read Only:
true
Maximum Length:255
Work order number of the work order associated while performing the asset qualification. -
WorkRequirementName: string
Read Only:
true
Maximum Length:255
Name of the work requirement that was associated while performing the asset qualification.
Nested Schema : Attachments
Type:
array
Title:
Attachments
The attachments resource is used to view, create, and update asset qualification attachments.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : installedBaseAssets-assetQualifications-attachments-item-response
Type:
Show Source
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
Attribute provided for the exclusive use for the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
Unique identifier of 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 record. -
CreatedByUserName: string
Title:
Created By User Name
Read Only:true
Name of the user who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date when the record was created. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
Value that indicates the data type. -
Description: string
Title:
Description
Maximum Length:255
Description of the attachment. -
DmDocumentId: string
Maximum Length:
255
Document ID that the attachment is created from. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
Folder path that the attachment is created from. -
DmVersionNumber: string
Maximum Length:
255
Document version number that the attachment is created from. -
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
Error code, if any, for the attachment. -
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
URI of the file. -
FileWebImage: string
(byte)
Title:
File Web Image
Read Only:true
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 when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
User who last updated the record. -
LastUpdatedByUserName: string
Title:
Last Updated By User
Read Only:true
User name who most recently updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingAction
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
Size of the attachment file. -
UploadedFileName: string
Title:
Uploaded File Name
Name to assign to a new attachment file. -
UploadedText: string
Title:
Uploaded Text
Text content for a new text attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
URI of a Topology Manager type attachment. -
Url: string
Title:
Url
Maximum Length:4000
URL of a web page type attachment. -
UserName: string
Title:
User Name
Read Only:true
Maximum Length:255
Session login of the user who created 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:
- AssetId:
$request.path.AssetId
- AssetQualificationId:
$request.path.AssetQualificationId
The attachments resource is used to view, create, and update asset qualification attachments. - AssetId: