Create one asset qualification
post
/fscmRestApi/resources/11.13.18.05/installedBaseAssets/{AssetId}/child/assetQualifications
Request
Path Parameters
-
AssetId(required): integer(int64)
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
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.
-
Upsert-Mode: string
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
Image Attachments
Title:
Image AttachmentsAttachment management capabilities: view, create, and update. -
CurrentFlag: boolean
Maximum Length:
1Default Value:falseValue 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:
255Abbreviation that uniquely identifies the qualification requirement . This attribute is required to create a qualification requirement. -
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:
255Name of the qualification requirement. This is 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 : Image Attachments
Type:
arrayTitle:
Image AttachmentsAttachment management capabilities: view, create, and update.
Show Source
Nested Schema : installedBaseAssets-assetQualifications-attachments-item-post-request
Type:
Show Source
object-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker IdAttribute used exclusively by Attachment UI components to assist with file uploads. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document IdThe unique identifier of the attached document. -
CategoryName: string
Title:
CategoryMaximum Length:30The category of the attachment. - ContentRepositoryFileShared: boolean
-
DatatypeCode: string
Title:
TypeMaximum Length:30Default Value:FILEA value that indicates the data type. -
Description: string
Title:
DescriptionMaximum Length:255The description of the attachment. -
DmDocumentId: string
Maximum Length:
255Indicates the source document ID for the attachment. -
DmFolderPath: string
Title:
Dm Folder PathMaximum Length:1000Indicates the source folder path for the attachment. -
DmVersionNumber: string
Maximum Length:
255The version number of the document used as the source for the attachment. -
DownloadInfo: string
Title:
DownloadInfoJSON object represented as a string that contains information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status CodeThe error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status MessageThe error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration DateThe expiration date of the contents in the attachment. -
FileContents: string
(byte)
Title:
File ContentsThe contents of the attachment. -
FileName: string
Title:
File NameMaximum Length:2048The file name of the attachment. -
FileUrl: string
Title:
File UrlThe URI of the file. -
PostProcessingAction: string
Title:
PostProcessingActionThe name of the action that can be performed after the attachment is uploaded. -
PrimaryCategoryFlag: boolean
Title:
PrimaryMaximum Length:1Designates one of the attached images as the primary image, which will be displayed as the main visual. -
Title: string
Title:
TitleThe title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content TypeThe content type of the attachment. -
UploadedFileLength: integer
Title:
File SizeThe size of the attachment file. -
UploadedFileName: string
Title:
Uploaded File NameThe name to assign to a new attachment file. -
UploadedText: string
Title:
Uploaded TextThe text content for a new text attachment. -
Uri: string
Title:
UriMaximum Length:4000The URI of a Topology Manager type attachment. -
Url: string
Title:
UrlMaximum Length:4000The 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 NumberRead Only:trueMaximum Length:80Number 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
Image Attachments
Title:
Image AttachmentsAttachment management capabilities: view, create, and update. -
CreatedBy: string
Read Only:
trueMaximum Length:64User who created the qualification requirement The application automatically sets this value during creation. This attribute is read-only. -
CreationDate: string
(date-time)
Read Only:
trueDate when the qualification requirement is created. The application automatically sets this value during creation. This attribute is read-only. -
CurrentFlag: boolean
Maximum Length:
1Default Value:falseValue that identifies current asset qualification. -
DefaultIntervalUOMCode: string
Read Only:
trueMaximum Length:255Meaning of the UOM code of the default interval for qualification requirement. -
Description: string
Title:
DescriptionRead Only:trueMaximum Length:240Description of the asset. You can use this attribute to describe the asset features, characteristics, and so on. -
DfltQualInterval: number
Title:
Default IntervalRead Only:trueDefault interval for the qualification requirement. -
EqpQualRequirementDescription: string
Title:
DescriptionRead Only:trueMaximum Length:240Description of the qualification requirement. -
InspectionEventDisposition: string
Read Only:
trueMaximum Length:255Meaning of the inspection event disposition code associated with the equipment qualification. -
InspectionEventDispositionCode: string
Read Only:
trueMaximum Length:255Code 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:
trueMaximum Length:255Name of the inspection plan that was associated while performing the asset qualification. -
InspectionStatus: string
Read Only:
trueMaximum Length:255Status of the inspection plan that's associated to the asset qualification. -
IntervalTypeCode: string
Title:
UOMRead Only:trueMaximum Length:30Value 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:
trueDate 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:
trueMaximum Length:64User 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:
trueMaximum Length:32Login 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:
LinksThe link relations associated with the resource instance. -
MaintenanceProgramName: string
Read Only:
trueMaximum Length:255Name 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:
trueMaximum Length:255Name of the work order operation for the work order that was associated while performing the asset qualification. -
OperationSequence: string
Read Only:
trueMaximum Length:255Work order operation sequence of the work order associated while performing the asset qualification. -
QualificationConfirmedFlag: boolean
Read Only:
trueStatus of confirmed qualification. -
QualificationProfile: string
Read Only:
trueMaximum Length:255Name of the qualification profile. -
QualificationProfileName: string
Read Only:
trueMaximum Length:255Display value of all the qualification profiles that are associated to the qualification requirement. -
QualificationRequirementCode: string
Maximum Length:
255Abbreviation that uniquely identifies the qualification requirement . This attribute is required to create a qualification requirement. -
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:
255Name of the qualification requirement. This is unique and required attribute to create an asset qualification. -
QualificationRequirementReference: string
Read Only:
trueMaximum Length:255Value 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:
trueMaximum Length:255Meaning of the qualification requirement type. -
QualifiedBy: string
Read Only:
trueMaximum Length:64User who created the asset qualification. The application automatically sets this value during creation. This attribute is read-only. -
QualifiedByName: string
Read Only:
trueMaximum Length:255Name 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:
TypeRead Only:trueMaximum Length:30Value of the qualification requirement type code. -
ResourceId: integer
Read Only:
trueUnique identifier of the equipment resource. -
ResourceInstance: string
Read Only:
trueMaximum Length:255Name of the resource instance. -
ResourceInstanceId: integer
Read Only:
trueUnique identifier of the resource instance. -
ResourceName: string
Read Only:
trueMaximum Length:255Name of the equipment resource instance. -
SerialNumber: string
Title:
Serial NumberRead Only:trueMaximum Length:80Number that uniquely identifies the serial that the asset references. This attribute is used when an item is serial controlled. If the serial number doesn't 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:
trueMaximum Length:255Work order number of the work order associated while performing the asset qualification. -
WorkRequirementName: string
Read Only:
trueMaximum Length:255Name of the work requirement that was associated while performing the asset qualification.
Nested Schema : Image Attachments
Type:
arrayTitle:
Image AttachmentsAttachment management capabilities: view, create, and update.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe 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 IdAttribute used exclusively by Attachment UI components to assist with file uploads. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document IdThe unique identifier of the attached document. -
CategoryName: string
Title:
CategoryMaximum Length:30The category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:255User who added the asset image attachment. -
CreatedByUserName: string
Title:
Created By User NameRead Only:trueThe user name who created the record. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe date when the record was created. -
DatatypeCode: string
Title:
TypeMaximum Length:30Default Value:FILEA value that indicates the data type. -
Description: string
Title:
DescriptionMaximum Length:255The description of the attachment. -
DmDocumentId: string
Maximum Length:
255Indicates the source document ID for the attachment. -
DmFolderPath: string
Title:
Dm Folder PathMaximum Length:1000Indicates the source folder path for the attachment. -
DmVersionNumber: string
Maximum Length:
255The version number of the document used as the source for the attachment. -
DocumentPreviewURL: string
Read Only:
trueMaximum Length:255Document preview URL attribute on the attachments resource, which is part of the maintenance programs root resource. -
DownloadInfo: string
Title:
DownloadInfoJSON object represented as a string that contains information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status CodeThe error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status MessageThe error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration DateThe expiration date of the contents in the attachment. -
FileContents: string
(byte)
Title:
File ContentsThe contents of the attachment. -
FileName: string
Title:
File NameMaximum Length:2048The file name of the attachment. -
FileUrl: string
Title:
File UrlThe URI of the file. -
FileWebImage: string
(byte)
Title:
File Web ImageRead Only:trueBase64-encoded representation of the file, rendered in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update DateRead Only:trueThe date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:255User who last updated the asset image attachment. -
LastUpdatedByUserName: string
Title:
Last Updated By UserRead Only:trueThe user name who last updated the record. -
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 the attachment is uploaded. -
PrimaryCategoryFlag: boolean
Title:
PrimaryMaximum Length:1Designates one of the attached images as the primary image, which will be displayed as the main visual. -
Title: string
Title:
TitleThe title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content TypeThe content type of the attachment. -
UploadedFileLength: integer
Title:
File SizeThe size of the attachment file. -
UploadedFileName: string
Title:
Uploaded File NameThe name to assign to a new attachment file. -
UploadedText: string
Title:
Uploaded TextThe text content for a new text attachment. -
Uri: string
Title:
UriMaximum Length:4000The URI of a Topology Manager type attachment. -
Url: string
Title:
UrlMaximum Length:4000The URL of a web page type attachment. -
UserName: string
Title:
User NameRead Only:trueMaximum Length:255The login credentials of the user who created 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.
Links
- attachments
-
Parameters:
- AssetId:
$request.path.AssetId - AssetQualificationId:
$request.path.AssetQualificationId
Attachment management capabilities: view, create, and update. - AssetId: