Jump to

• Request
• Response
• Examples

Get one qualification requirement in a profile

get

/fscmRestApi/resources/11.13.18.05/assetQualificationProfiles/{ProfileId}/child/qualificationRequirements/{ProfileRequirementId}

Request

Path Parameters

• ProfileId(required): integer(int64)
  Value that uniquely identifies the qualification profile. The application creates this value when it creates the qualification profile. This attribute is read-only.
• ProfileRequirementId(required): integer(int64)
  Value that uniquely identifies the qualification requirement referenced in the qualification profile.

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
• 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
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

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(required):
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version(required):
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : assetQualificationProfiles-qualificationRequirements-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who associated the qualification requirement with a qualification profile. The application automatically sets this value while creating the profile. This attribute is read-only.
• CreationDate: string (date-time)
  Read Only: true

  Date when the qualification requirement is associated with a qualification profile. The application automatically sets this value while creating the profile. This attribute is read-only.
• LastUpdateDate: string (date-time)
  Read Only: true

  Login that the user used when updating the qualification requirement association with a qualification profile. The application assigns a value to this attribute while creating the profile. This attribute is read-only.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  Date when the user most recently updated the qualification requirement association with a qualification profile. The application automatically sets this value while creating the profile. This attribute is read-only.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  User who most recently updated the qualification requirement association with a qualification profile. The application assigns a value to this attribute while creating the profile. This attribute is read-only.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ProfileRequirementId: integer (int64)
  Value that uniquely identifies the qualification requirement referenced in the qualification profile.
• RequirementCode: string
  Title: Code

  Maximum Length: 255

  Abbreviation that uniquely identifies the qualification requirement associated with a qualification profile. This attribute is read-only.
• RequirementDescription: string
  Title: Description

  Read Only: true

  Maximum Length: 240

  Description of the qualification requirement associated with the qualification profile. This attribute provides brief user-defined text, providing information on the qualification requirement. This attribute is read-only.
• RequirementEndDate: string (date-time)
  Title: End Date

  Date when the relationship between qualification requirement and qualification profile becomes inactive. The end date for the relationship must be a future date.
• RequirementId: integer (int64)
  Value that uniquely identifies the qualification requirement that's associated with the qualification profile. This attribute is required when adding the qualification requirement to a qualification profile.
• RequirementName: string
  Title: Name

  Maximum Length: 255

  Name of the qualification requirement associated with a qualification profile. This attribute is read-only.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Date when the user most recently updated the qualification requirement association with a qualification profile. The application automatically sets this value while creating the profile. This attribute is read-only.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the qualification requirement is associated with a qualification profile. The application automatically sets this value while creating the profile. This attribute is read-only.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "RequirementDescription":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"Description of the qualification requirement associated with the qualification profile. This attribute provides brief user-defined text, providing information on the qualification requirement. This attribute is read-only.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who associated the qualification requirement with a qualification profile. The application automatically sets this value while creating the profile. This attribute is read-only.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "RequirementEndDate":{
            "title":"End Date",
            "type":"string",
            "description":"Date when the relationship between qualification requirement and qualification profile becomes inactive. The end date for the relationship must be a future date.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ProfileRequirementId":{
            "type":"integer",
            "description":"Value that uniquely identifies the qualification requirement referenced in the qualification profile.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "RequirementId":{
            "type":"integer",
            "description":"Value that uniquely identifies the qualification requirement that's associated with the qualification profile. This attribute is required when adding the qualification requirement to a qualification profile.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "RequirementName":{
            "title":"Name",
            "maxLength":255,
            "type":"string",
            "description":"Name of the qualification requirement associated with a qualification profile. This attribute is read-only.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "RequirementCode":{
            "title":"Code",
            "maxLength":255,
            "type":"string",
            "description":"Abbreviation that uniquely identifies the qualification requirement associated with a qualification profile. This attribute is read-only.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Login that the user used when updating the qualification requirement association with a qualification profile. The application assigns a value to this attribute while creating the profile. This attribute is read-only.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"User who most recently updated the qualification requirement association with a qualification profile. The application assigns a value to this attribute while creating the profile. This attribute is read-only.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "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

Examples

This example describes how to get one qualification requirement in a profile.

Example cURL Command

Use the following cURL command to submit a request on the REST resource:

curl -u username:password "https://servername/fscmRestApi/resources/version/assetQualificationProfiles/ProfileId/child/qualificationRequirements/ProfileRequirementId"

Example Response Body

The following example includes the contents of the response body in JSON format:

{
    "ProfileRequirementId": 300100584871830,
    "RequirementId": 300100584871823,
    "RequirementName": "ALMQualReq2",
    "RequirementCode": "ALMQualReqCode",
    "RequirementDescription": "ALMQualReq2 desc",
    "RequirementEndDate": null,
    "CreatedBy": "ALM_QA",
    "CreationDate": "2023-05-05T16:11:54+00:00",
    "LastUpdatedBy": "ALM_QA",
    "LastUpdateDate": "2023-05-05T16:11:54.075+00:00",
    "LastUpdateLogin": "FACC889D04B61F79E0537AA8F00A60F1",
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/assetQualificationProfiles/300100584871829/child/qualificationRequirements/300100584871830",
            "name": "qualificationRequirements",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername/fscmRestApi/resources/version/assetQualificationProfiles/300100584871829/child/qualificationRequirements/300100584871830",
            "name": "qualificationRequirements",
            "kind": "item"
        },
        {
            "rel": "parent",
            "href": "https://servername/fscmRestApi/resources/version/assetQualificationProfiles/300100584871829",
            "name": "assetQualificationProfiles",
            "kind": "item"
        }
    ]
}

Back to Top