Jump to

• Request
• Response

Get all asset qualifications

get

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

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
• finder: string
  Used as a predefined finder to search the collection.
  
  Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables:
  
  

  • PrimaryKey: Finds asset qualifications according to the asset qualification identifier.
    Finder Variables:
    • AssetQualificationId; integer; Value that uniquely identifies the asset qualification.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• 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
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • AssetId; integer; Value that uniquely identifies an asset. This attribute is read-only.
  • AssetNumber; string; Number that uniquely identifies an asset. This attribute is read-only.
  • AssetQualificationId; integer; 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; User who created the qualification requirement The application automatically sets this value during creation. This attribute is read-only.
  • CreationDate; string; Date when the qualification requirement is created. The application automatically sets this value during creation. This attribute is read-only.
  • CurrentFlag; boolean; Value that identifies current asset qualification.
  • DefaultIntervalUOMCode; string; Meaning of the UOM code of the default interval for qualification requirement.
  • Description; string; Description of the asset. You can use this attribute to describe the asset features, characteristics, and so on.
  • DfltQualInterval; number; Default interval for the qualification requirement.
  • EqpQualRequirementDescription; string; Description of the qualification requirement.
  • InspectionEventDisposition; string; Meaning of the inspection event disposition code associated with the equipment qualification.
  • InspectionEventDispositionCode; string; Code of the inspection event disposition code associated with the equipment qualification.
  • InspectionPlanId; integer; Value that Uniquely Identifies the inspection plan. Currently, this attribute isn't populated.
  • InspectionPlanName; string; Name of the inspection plan that was associated while performing the asset qualification.
  • InspectionStatus; string; Status of the inspection plan that's associated to the asset qualification.
  • IntervalTypeCode; string; Value of the qualification requirement interval type code.
  • IpEventId; integer; Unique identifier of the inspection event associated while performing the asset qualification.
  • LastUpdateDate; string; Date when the user most recently updated the qualification requirement. The application automatically sets this value during creation. This attribute is read-only.
  • LastUpdateLogin; string; 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.
  • LastUpdatedBy; string; User who most recently updated the qualification requirement. The application assigns a value to this attribute during creation. This attribute is read-only.
  • MaintenanceProgramName; string; Name of the maintenance program that was associated while performing the asset qualification.
  • NextQualificationDate; string; 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; Name of the work order operation for the work order that was associated while performing the asset qualification.
  • OperationSequence; string; Work order operation sequence of the work order associated while performing the asset qualification.
  • QualificationConfirmedFlag; boolean; Status of confirmed qualification.
  • QualificationProfile; string; Name of the qualification profile.
  • QualificationProfileName; string; Display value of all the qualification profiles that are associated to the qualification requirement.
  • QualificationRequirementCode; string; Code of the qualification requirement. This is a unique and required attribute to create an asset qualification.
  • QualificationRequirementId; integer; Value that uniquely identifies the qualification requirement. The application creates this value when it creates the qualification requirement. This attribute is mandatory.
  • QualificationRequirementName; string; Name of the qualification requirement. This is a unique and required attribute to create an asset qualification.
  • QualificationRequirementReference; string; 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; Meaning of the qualification requirement type.
  • QualifiedBy; string; User who created the asset qualification. The application automatically sets this value during creation. This attribute is read-only.
  • QualifiedByName; string; Name of the user performing the asset qualification.
  • QualifiedDate; string; 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; Value of the qualification requirement type code.
  • ResourceId; integer; Unique identifier of the equipment resource.
  • ResourceInstance; string; Name of the resource instance.
  • ResourceInstanceId; integer; Unique identifier of the resource instance.
  • ResourceName; string; Name of the equipment resource instance.
  • SerialNumber; string; 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; Unique identifier of the work order associated while performing the asset qualification.
  • WorkOrderNumber; string; Work order number of the work order associated while performing the asset qualification.
  • WorkRequirementName; string; Name of the work requirement that was associated while performing the asset qualification.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

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

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/installedBaseAssets-assetQualifications-item-response"
            }
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object installedBaseAssets-assetQualifications-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/installedBaseAssets-assetQualifications-item-response"
    }
}

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

{
    "type":"object",
    "properties":{
        "IntervalTypeCode":{
            "title":"UOM",
            "maxLength":"30",
            "type":"string",
            "description":"Value of the qualification requirement interval type code.",
            "nullable":true,
            "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 requirement 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
        },
        "Description":{
            "title":"Description",
            "maxLength":"240",
            "type":"string",
            "description":"Description of the asset. You can use this attribute to describe the asset features, characteristics, and so on.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "attachments":{
            "title":"Attachments",
            "type":"array",
            "description":"The attachments resource is used to view, create, and update asset qualification attachments.",
            "items":{
                "$ref":"#/components/schemas/installedBaseAssets-assetQualifications-attachments-item-response"
            }
        },
        "InspectionPlanName":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the inspection plan that was associated while performing the asset qualification.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceName":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the equipment resource instance.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "QualificationRequirementType":{
            "maxLength":"255",
            "type":"string",
            "description":"Meaning of the qualification requirement type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssetNumber":{
            "title":"Asset Number",
            "maxLength":"80",
            "type":"string",
            "description":"Number that uniquely identifies an asset. This attribute is read-only.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "InspectionStatus":{
            "maxLength":"255",
            "type":"string",
            "description":"Status of the inspection plan that's associated to the asset qualification.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EqpQualRequirementDescription":{
            "title":"Description",
            "maxLength":"240",
            "type":"string",
            "description":"Description of the qualification requirement.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MaintenanceProgramName":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the maintenance program that was associated while performing the asset qualification.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CurrentFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Value that identifies current asset qualification.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "QualificationRequirementName":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the qualification requirement. This is a unique and required attribute to create an asset qualification.",
            "nullable":true,
            "x-queryable":true
        },
        "DfltQualInterval":{
            "title":"Default Interval",
            "type":"number",
            "description":"Default interval for the qualification requirement.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DefaultIntervalUOMCode":{
            "maxLength":"255",
            "type":"string",
            "description":"Meaning of the UOM code of the default interval for qualification requirement.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InspectionEventDisposition":{
            "maxLength":"255",
            "type":"string",
            "description":"Meaning of the inspection event disposition code associated with the equipment qualification.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "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
        },
        "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
        },
        "OperationName":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the work order operation for the work order that was associated while performing the asset qualification.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OperationSequence":{
            "maxLength":"255",
            "type":"string",
            "description":"Work order operation sequence of the work order associated while performing the asset qualification.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RequirementTypeCode":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"Value of the qualification requirement type code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "QualifiedByName":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the user performing the asset qualification.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "QualificationRequirementReference":{
            "maxLength":"255",
            "type":"string",
            "description":"Value that uniquely identifies the asset qualification. The application creates this value when it creates the asset qualification. This attribute is read-only.",
            "nullable":true,
            "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
        },
        "QualificationProfile":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the qualification profile.",
            "nullable":true,
            "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 default 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
        },
        "SerialNumber":{
            "title":"Serial Number",
            "maxLength":"80",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkOrderNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"Work order number of the work order associated while performing the asset qualification.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceId":{
            "type":"integer",
            "description":"Unique identifier of the equipment resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkOrderId":{
            "type":"integer",
            "description":"Unique identifier of the work order associated while performing the asset qualification.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "QualificationProfileName":{
            "maxLength":"255",
            "type":"string",
            "description":"Display value of all the qualification profiles that are associated to the qualification requirement.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceInstance":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the resource instance.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkRequirementName":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the work requirement that was associated while performing the asset qualification.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InspectionEventDispositionCode":{
            "maxLength":"255",
            "type":"string",
            "description":"Code of the inspection event disposition code associated with the equipment qualification.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IpEventId":{
            "type":"integer",
            "description":"Unique identifier of the inspection event associated while performing the asset qualification.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "QualificationConfirmedFlag":{
            "type":"boolean",
            "description":"Status of confirmed qualification.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "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
        },
        "ResourceInstanceId":{
            "type":"integer",
            "description":"Unique identifier of the resource instance.",
            "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":"Code of the qualification requirement. This is a unique and required attribute to create an asset qualification.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Attachments

Type: array

Title: Attachments

The attachments resource is used to view, create, and update asset qualification attachments.

Show Source

• Array of: object installedBaseAssets-assetQualifications-attachments-item-response

{
    "title":"Attachments",
    "type":"array",
    "description":"The attachments resource is used to view, create, and update asset qualification attachments.",
    "items":{
        "$ref":"#/components/schemas/installedBaseAssets-assetQualifications-attachments-item-response"
    }
}

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 : installedBaseAssets-assetQualifications-attachments-item-response

Type: object

Show Source

• 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
  Title: Shared

  Indicates whether the attachment is shared.
• 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.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"255",
            "type":"string",
            "description":"Description of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":"2048",
            "type":"string",
            "description":"File name of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "FileWebImage":{
            "title":"File Web Image",
            "type":"string",
            "description":"Base64 encoded image of the file displayed in .png format if the source is a convertible image.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide",
                "PAYLOADHINT":"Show"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":"4000",
            "type":"string",
            "description":"URI of a Topology Manager type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "Url":{
            "title":"Url",
            "maxLength":"4000",
            "type":"string",
            "description":"URL of a web page type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DmDocumentId":{
            "maxLength":"255",
            "type":"string",
            "description":"Document ID that the attachment is created from.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "AttachedDocumentId":{
            "title":"Attached Document Id",
            "type":"integer",
            "description":"Unique identifier of the attached document.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"Content type of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"JSON object represented as a string containing information used to programmatically retrieve a file attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CreatedByUserName":{
            "title":"Created By User Name",
            "type":"string",
            "description":"Name of the user who created the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"Size of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmVersionNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"Document version number that the attachment is created from.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"255",
            "type":"string",
            "description":"User who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"Error message, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UserName":{
            "title":"User Name",
            "maxLength":"255",
            "type":"string",
            "description":"Session login of the user who created the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"255",
            "type":"string",
            "description":"User who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"Value that indicates the data type.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "PostProcessingAction":{
            "title":"PostProcessingAction",
            "type":"string",
            "description":"Name of the action that can be performed after an attachment is uploaded.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"Title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "LastUpdatedByUserName":{
            "title":"Last Updated By User",
            "type":"string",
            "description":"User name who most recently updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"Name to assign to a new attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"URI of the file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Indicates whether the attachment is shared.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"Contents of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"Expiration date of the contents in the attachment.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"Error code, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":"1000",
            "type":"string",
            "description":"Folder path that the attachment is created from.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"Text content for a new text attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":"30",
            "type":"string",
            "description":"Category of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "FMT_FORMAT":"d-MMM-yyyy HH:mm:ss"
            },
            "x-queryable":true
        },
        "AsyncTrackerId":{
            "title":"Asynchronous Upload Tracker Id",
            "type":"string",
            "description":"Attribute provided for the exclusive use for the Attachment UI components to assist in uploading files.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            }
        }
    }
}

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."
        }
    }
}

Links

findByAdvancedSearchQuery

Operation: /fscmRestApi/resources/11.13.18.05/installedBaseAssets/{AssetId}/child/assetQualifications/action/findByAdvancedSearchQuery

Parameters:

• AssetId: $request.path.AssetId

Method used to perform a search on asset qualifications based on qualification requirements.

Back to Top