Jump to

• Request
• Response

Update a assignment profile record associated to the specified learning assignment

patch

/hcmRestApi/resources/11.13.18.05/learningAssignmentProfiles/{learningAssignmentProfilesUniqID}/child/assignmentProfileRecords/{assignmentRecordId}

Request

Path Parameters

• assignmentRecordId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
• learningAssignmentProfilesUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Learning Assignment Profiles resource and used to uniquely identify an instance of Learning Assignment Profiles. The client should not generate the hash key value. Instead, the client should query on the Learning Assignment Profiles collection resource in order to navigate to a specific instance of Learning Assignment Profiles to get the hash key.

Header Parameters

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

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

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 : learningAssignmentProfiles-assignmentProfileRecords-item-response

Type: object

Show Source

• assignedOnDate: string (date-time)
  Read Only: true

  Date when the learning was assigned to the learner.
• assignedToDisplayName: string
  Read Only: true

  Maximum Length: 240

  Display name of the learner.
• assignedToId: integer (int64)
  Read Only: true

  Unique identifier for the person the learning item was assigned to.
• assignedToPersonEmailAddress: string
  Read Only: true

  Maximum Length: 240

  Person's primary email address.
• assignmentDueDate: string (date)
  Read Only: true

  Due date for a learning assignment.
• assignmentProcessingStatus: string
  Read Only: true

  Maximum Length: 10

  Processing status for the learning assignment
• assignmentProcessingStatusMeaning: string
  Read Only: true

  Maximum Length: 255

  Description for the assignment processing status.
• assignmentProfileId: integer (int64)
  Read Only: true

  Unique identifier of the assignment profile's details.
• assignmentProfileNumber: string
  Read Only: true

  Maximum Length: 255

  User-friendly identifier for the profile linked to the learning assignment.
• assignmentRecordId: integer (int64)
  Read Only: true

  Unique identifier for the learning assignment details.
• assignmentRecordNumber: string
  Read Only: true

  Maximum Length: 30

  User-friendly identifier for the assignment record.
• assignmentStatus: string
  Read Only: true

  Maximum Length: 32

  The status of the learning assignment.
• assignmentStatusMeaning: string
  Read Only: true

  Meaning associated with the status of the learning assignment.
• assignmentType: string
  Read Only: true

  Maximum Length: 30

  Learning assignment type. Valid values are ORA_REQUIRE_ASSIGNMENT and ORA_JOIN_ASSIGNMENT.
• assignmentTypeMeaning: string
  Read Only: true

  Description associated with the assignment type.
• learningItemId: integer (int64)
  Read Only: true

  Unique identifier of the assigned learning item.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• reasonCodeMeaning: string
  Read Only: true

  Maximum Length: 255

  Description of the reasonCode attribute value.

{
    "type":"object",
    "properties":{
        "assignedOnDate":{
            "type":"string",
            "description":"Date when the learning was assigned to the learner.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "assignedToDisplayName":{
            "maxLength":240,
            "type":"string",
            "description":"Display name of the learner.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "assignedToId":{
            "type":"integer",
            "description":"Unique identifier for the person the learning item was assigned to.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "assignedToPersonEmailAddress":{
            "maxLength":240,
            "type":"string",
            "description":"Person's primary email address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "assignmentDueDate":{
            "type":"string",
            "description":"Due date for a learning assignment.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "assignmentProcessingStatus":{
            "maxLength":10,
            "type":"string",
            "description":"Processing status for the learning assignment",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "assignmentProcessingStatusMeaning":{
            "maxLength":255,
            "type":"string",
            "description":"Description for the assignment processing status.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "assignmentProfileId":{
            "type":"integer",
            "description":"Unique identifier of the assignment profile's details.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "assignmentProfileNumber":{
            "maxLength":255,
            "type":"string",
            "description":"User-friendly identifier for the profile linked to the learning assignment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "assignmentRecordId":{
            "type":"integer",
            "description":"Unique identifier for the learning assignment details.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "assignmentRecordNumber":{
            "maxLength":30,
            "type":"string",
            "description":"User-friendly identifier for the assignment record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "assignmentStatus":{
            "maxLength":32,
            "type":"string",
            "description":"The status of the learning assignment.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "assignmentStatusMeaning":{
            "type":"string",
            "description":"Meaning associated with the status of the learning assignment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "assignmentType":{
            "maxLength":30,
            "type":"string",
            "description":"Learning assignment type. Valid values are ORA_REQUIRE_ASSIGNMENT and ORA_JOIN_ASSIGNMENT.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "assignmentTypeMeaning":{
            "type":"string",
            "description":"Description associated with the assignment type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "learningItemId":{
            "type":"integer",
            "description":"Unique identifier of the assigned learning item.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "reasonCodeMeaning":{
            "maxLength":255,
            "type":"string",
            "description":"Description of the reasonCode attribute value.",
            "nullable":true,
            "readOnly":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."
        }
    }
}

Links

AssignmentStatusLOV

Operation: /fscmRestApi/resources/11.13.18.05/commonLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_WLF_ASSIGN_RECORD_STATUS

The following properties are defined on the LOV link relation:

• Source Attribute: assignmentStatus; Target Attribute: LookupCode
• Display Attribute: Meaning

Back to Top