Jump to

• Request
• Response

Create an 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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• AssetId: 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.
• InspectionPlanId: integer (int64)
  Value that Uniquely Identifies the inspection plan. Currently, this attribute isn't populated.
• 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

  Abbreviation 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: 255

  Name 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 defauilt value is system date.

{
    "type":"object",
    "properties":{
        "QualificationRequirementId":{
            "type":"integer",
            "description":"Value that uniquely identifies the qualification requirement. The application creates this value when it creates the qualification requirement. This attribute is mandatory.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "QualifiedDate":{
            "type":"string",
            "description":"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 defauilt value is system date.",
            "format":"date-time",
            "nullable":false
        },
        "AssetQualificationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the asset qualification. The application creates this value when it creates the asset qualification. This attribute is read-only.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "NextQualificationDate":{
            "type":"string",
            "description":"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.",
            "format":"date-time",
            "nullable":true
        },
        "QualificationRequirementName":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the qualification requirement. This is unique and required attribute to create an asset qualification.",
            "nullable":true,
            "x-queryable":false
        },
        "AssetId":{
            "type":"integer",
            "description":"Value that uniquely identifies an asset. This attribute is read-only.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "InspectionPlanId":{
            "type":"integer",
            "description":"Value that Uniquely Identifies the inspection plan. Currently, this attribute isn't populated.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "QualificationRequirementCode":{
            "maxLength":"255",
            "type":"string",
            "description":"Abbreviation that uniquely identifies the qualification requirement . This attribute is required to create a qualification requirement.",
            "nullable":true
        }
    }
}

Back to Top

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.

Body ()

Root Schema : installedBaseAssets-assetQualifications-item-response

Type: object

Show Source

• AssetId: integer (int64)
  Value that uniquely identifies an asset. This attribute is read-only.
• AssetNumber: string
  Title: 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.
• 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 requirment is created. The application automatically sets this value during creation.This attribute is read-only.
• InspectionPlanId: integer (int64)
  Value that Uniquely Identifies the inspection plan. Currently, this attribute isn't populated.
• 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.
• 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

  Abbreviation 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: 255

  Name of the qualification requirement. This is unique and required attribute to create an asset qualification.
• 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.
• 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 defauilt value is system date.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who most recently updated the qualification requirement. The application assigns a value to this attribute during creation. This attribute is read-only.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "QualificationRequirementId":{
            "type":"integer",
            "description":"Value that uniquely identifies the qualification requirement. The application creates this value when it creates the qualification requirement. This attribute is mandatory.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the qualification requirment is created. The application automatically sets this value during creation.This attribute is read-only.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who created the qualification requirement The application automatically sets this value during creation.This attribute is read-only.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "NextQualificationDate":{
            "type":"string",
            "description":"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.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "AssetNumber":{
            "title":"Number",
            "maxLength":"80",
            "type":"string",
            "description":"Number that uniquely identifies an asset. This attribute is read-only.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "QualifiedDate":{
            "type":"string",
            "description":"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 defauilt value is system date.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "AssetQualificationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the asset qualification. The application creates this value when it creates the asset qualification. This attribute is read-only.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "QualificationRequirementName":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the qualification requirement. This is unique and required attribute to create an asset qualification.",
            "nullable":true,
            "x-queryable":false
        },
        "AssetId":{
            "type":"integer",
            "description":"Value that uniquely identifies an asset. This attribute is read-only.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "QualifiedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who created the asset qualification. The application automatically sets this value during creation.This attribute is read-only.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the user most recently updated the qualification requirement. The application automatically sets this value during creation.This attribute is read-only.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InspectionPlanId":{
            "type":"integer",
            "description":"Value that Uniquely Identifies the inspection plan. Currently, this attribute isn't populated.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "QualificationRequirementCode":{
            "maxLength":"255",
            "type":"string",
            "description":"Abbreviation that uniquely identifies the qualification requirement . This attribute is required to create a qualification requirement.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top