Jump to

• Request
• Response

Create a learning assignment

post

/hcmRestApi/resources/11.13.18.05/learningAssignmentProfiles

Request

Header Parameters

• Effective-Of: string
  This header accepts a string value. The string is a semi-colon separated list of =. It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers.
• Metadata-Context: string
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version: string
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
• Upsert-Mode: string
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• assignAs: string
  Maximum Length: 30

  Display name of the person who created the learning assignment for the learner. For example, in case of voluntary assignment, it's the name of the learner. For a specialist created assignment, it's the name of the specialist or the alias used in Assign As.
• assignmentActualEffort: number
  Effort required to complete the assignment.
• assignmentActualScore: number
  The learner's actual score for completed learning.
• assignmentCompletionDate: string (date-time)
  Date the learning assignment was completed.
• assignmentDFF: array assignmentDFF
• assignmentDueDate: string (date-time)
  Due date for a learning assignment.
• assignmentDueDateType: string
  Maximum Length: 30

  Default Value: ORA_INIT_NO_DUE_DATE

  Type of learning assignment due date. Valid values are ORA_RELATIVE_DATE and ORA_SPECIFIC_DATE.
• assignmentDueIn: number
  Number of days to complete the learning assignment after it's assigned.
• assignmentDueInUnits: string
  Maximum Length: 255

  Unit of measure for the quantity that identifies when the learning assignment is due, such as days, months, or years
• assignmentJustification: string
  Maximum Length: 4000

  Justification provided by the person assigning the learning.
• assignmentNotes: string
  Maximum Length: 4000

  Notes from the person assigning the learning to the assigned learners.
• assignmentProfileDescription: string
  Maximum Length: 4000

  Description for the learning assignment profile.
• assignmentProfileEndDate: string (date-time)
  Date the processing of the learning assignment profile needs to complete.
• assignmentProfileId: integer (int64)
  Unique identifier of the assignment profile's details.
• assignmentProfileNumber: string
  Maximum Length: 30

  User-friendly identifier for the profile linked to the learning assignment.
• assignmentProfileRecords: array Assignment Profiles
  Title: Assignment Profiles

  The assignment profile records associated with the learning assignment.
• assignmentProfileStartDate: string (date)
  Date the processing of the learning assignment profile needs to start.
• assignmentProfileStatus(required): string
  Maximum Length: 30

  Status for the learning assignment profile.
• assignmentProfileTitle: string
  Maximum Length: 250

  Name of the learning assignment profile.
• assignmentRecordStatus: string
  Maximum Length: 30

  The status of the learning assignment.
• assignmentSubType: string
  Maximum Length: 30

  Learning assignment subtype. Valid values include ORA_SELF and ORA_ADMIN.
• assignmentType(required): string
  Maximum Length: 30

  Learning assignment type. Valid values are ORA_REQUIRE_ASSIGNMENT and ORA_JOIN_ASSIGNMENT.
• completionComments: string
  Maximum Length: 4000

  Comments provided when marking the learning assignment as completed.
• completionReasonCode: string
  Maximum Length: 30

  Reason code for marking the learning assignment as completed.
• dataSecurityPrivilege: string
  Data security privilege for the role of the person accessing the learning assignment, such as Learner or Learner Manager. Valid values are defined in the DataSecurityPrivilegeLOV.
• dueInNumber: number
  Quantity for the measurement indicating when the renewal assignment is due, such as 30.
• dueInUOM: string
  Maximum Length: 255

  Unit of measure for the quantity that identifies when the renewal assignment is due, such as days, months, or years
• dueMonth: string
  Maximum Length: 255

  Month in which the renewal assignment is due.
• dueOnDay: number
  Day when the renewal assignment is due.
• enableRenewals: string
  Maximum Length: 255

  Indicates whether the renewals are enabled on the learning assignment profile. Valid values are Y and N.
• excludeEnrollmentFromHistory: string
  Maximum Length: 1

  Indicates whether the assignment needs to be hidden from the learner's transcript. Valid values are Y and N. When the value is Y, the assignment's status is set to ORA_ASSN_REC_DELETED. When the value is N, the assignment's status is set to ORA_ASSN_REC_WITHDRAWN.
• existingCompletionValidityRule: string
  Maximum Length: 30

  Indicates when the previous completion expires. Valid values are ORA_FORCE_RETAKE_EXP_COMPL_CD, ORA_FORCE_RETAKE_EXP_COMPL_DD, ORA_FORCE_RETAKE_EXP_COMPL_AD and ORA_FORCE_RETAKE_EXP_COMPL_RN.
• increaseMaximumCapacity: string
  Maximum Length: 64

  Indicates whether the maximum capacity for the learning should be increased and the waitlist bypassed. Valid values are Y and N.
• learningAssignmentProfileCriteria: array Leaning Assignment Profile Criteria
  Title: Leaning Assignment Profile Criteria

  The learningAssignmentProfileCriteria resource associates 1 or more learners with a learning item.
• learningItem: array Noncatalog Learning Item
  Title: Noncatalog Learning Item

  The learning item details required to create noncatalog requests or record external learning under the assignment profile.
• learningItemId: integer (int64)
  Unique identifier of the assigned learning item.
• learningItemNumber: string
  Number given to the assigned learning item.
• learningItemType: string
  Type of learning item. Valid values include ORA_COURSE, ORA_SPECIALIZATION, and ORA_LEGACY.
• minimumDaysToComplete: number
  Minimum number of days to complete the learning assignment created in the subsequent run of the learning assignment profile, after it's assigned.
• ongoingAssignmentDueDate: string (date-time)
  Due date for a learning assignment created in the subsequent run of the learning assignment profile.
• ongoingDueDateType: string
  Maximum Length: 30

  Type of learning assignment due date for the subsequent run of the learning assignment profile. Valid values are ORA_RELATIVE_DATE and ORA_SPECIFIC_DATE.
• ongoingDueIn: number
  Number of days to complete the learning assignment created in the subsequent run of the learning assignment profile, after it's assigned.
• ongoingDueInUnits: string
  Maximum Length: 255

  Unit of measure for the quantity that identifies when the learning assignment created in the subsequent run of the learning assignment profile is due, such as days, months, or years
• processId: integer
  Unique identifier for the process.
• processingFrequency: string
  Maximum Length: 30

  Processing frequency for the learning assignment profile.
• processingRule: string
  Maximum Length: 1

  Default Value: N

  Processing rule for the assignment profile.
• purchaseOrderNumber: string
  Maximum Length: 30

  Order number for purchasing the learning.
• reassignNumber: number
  Quantity for the measurement indicating when the learning assignment should be reassigned, such as 1.
• reassignOnDay: number
  Day when the renewal assignment should be created.
• reassignOnMonth: string
  Maximum Length: 30

  Month when the renewal assignment should be created.
• reassignUOM: string
  Maximum Length: 30

  Unit of measure for the quantity that identifies when the renewal assignment should be created, such as days, months, or years
• recommendationCategory: string
  Maximum Length: 30

  Category code to which the learning assignment belongs.
• relatedMaterials: array Related Materials
  Title: Related Materials

  The relatedMaterials resource provides a list of related learning material for its parent resource. It's also used to add and remove related material.
• renewalOption: string
  Maximum Length: 30

  Rule to identify the start date of the renewal assignment.
• renewalPeriod: string
  Maximum Length: 30

  Indicates when the learning assignment should be renewed. Valid values are ORA_ANNUAL_DUE_DATE and ORA_REL_TO_PRIOR_COMPLETION.
• requestedCompletionDate: string (date)
  Requested date by when the learner should complete the related learning assignment.
• requestedStartDate: string (date)
  Start date for the requested learning assignment.
• retakeInNumber: number
  Quantity for the measurement indicating when learners should retake the learning, such as 1.
• retakeInUnitOfMeasure: string
  Maximum Length: 30

  Unit of measure for the quantity that identifies when learners should retake the learning, such as days, months, or years.
• retakeRule: string
  Maximum Length: 30

  Rule indicating when learners should retake the learning again. Valid values are ORA_EXEMPT_LEARNING, ORA_RETAKE_LEARNING, ORA_RETAKE_WITH_EXEMPT_DATE and ORA_RETAKE_WITH_EXEMPT_BEFORE.
• retakeWhenCompletedBeforeDate: string (date)
  Learners with assignment completions before this date need to retake the learning.
• runAsPersonId: integer (int64)
  Unique identifier of the person associated with the assignment profile.
• runAsPersonNumber: string
  Maximum Length: 255

  Friendly identifier for the person associated with the assignment profile.
• sourceId: integer (int64)
  Title: Enrollment Source Identifier

  Unique identifier for the source where this assignment was created.
• sourceType: string
  Title: Enrollment Source Type

  Maximum Length: 30

  Type for the source where this assignment was created, such as Recommendation or Search.
• statusChangeComments: string
  Maximum Length: 400

  Status change comment for the learning assignment.
• statusChangeReasonCode: string
  Maximum Length: 30

  Reason code for the learning assignment status change.
• targetAssignmentStatus: string
  Maximum Length: 30

  Status to set for the learning assignment.
• validityPeriodBeginRule: string
  Maximum Length: 30

  Rule identifying when the validity period for the completed learning assignment starts..
• validityPeriodExpiryDay: number
  Day when the learning assignment validity should expire.
• validityPeriodExpiryFrom: string
  Maximum Length: 30

  Rule to calculate when he learning assignment's validity period should expire.
• validityPeriodExpiryMonth: string
  Maximum Length: 255

  Month in which the learning assignment validity should expire.
• validityPeriodExpiryNumber: number
  Quantity for the measurement indicating when the learning assignment expires, such as 1.
• validityPeriodExpiryRule: string
  Maximum Length: 255

  Rule that identifies when the learning assignment's validity period expires. Valid values are ORA_EXP_NEVER, ORA_EXP_ DATE and ORA_EXP_RELATIVE_DATE.
• validityPeriodExpiryUOM: string
  Maximum Length: 30

  Unit of measure for the quantity that identifies when the learning assignment expires.
• waiveComments: string
  Maximum Length: 4000

  Comments provided when waiving prerequisites for the assignments.
• waivePrerequisites: string
  Maximum Length: 1

  Default Value: N

  Indicates whether the prerequisites need to be waived while creating learning assignments. Valid values are Y or N.
• waiveReasonCode: string
  Maximum Length: 30

  Reason for waiving assignment prerequisites.
• withdrawOnProcessing: string
  Maximum Length: 30

  Default Value: Y

  Indicates whether the assignment needs to be withdrawn for learners who are no longer part of the assignment profile audience. Valid values are Y or N.

{
    "required":[
        "assignmentProfileStatus",
        "assignmentType"
    ],
    "type":"object",
    "properties":{
        "assignAs":{
            "maxLength":30,
            "type":"string",
            "description":"Display name of the person who created the learning assignment for the learner. For example, in case of voluntary assignment, it's the name of the learner. For a specialist created assignment, it's the name of the specialist or the alias used in Assign As.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "assignmentActualEffort":{
            "type":"number",
            "description":"Effort required to complete the assignment.",
            "nullable":true,
            "x-hints":{
                "precision":9,
                "scale":3
            }
        },
        "assignmentActualScore":{
            "type":"number",
            "description":"The learner's actual score for completed learning.",
            "nullable":true,
            "x-hints":{
                "precision":9,
                "scale":3
            }
        },
        "assignmentCompletionDate":{
            "type":"string",
            "description":"Date the learning assignment was completed.",
            "format":"date-time",
            "nullable":true
        },
        "assignmentDFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/learningAssignmentProfiles-assignmentDFF-item-post-request"
            },
            "x-cardinality":"1"
        },
        "assignmentDueDate":{
            "type":"string",
            "description":"Due date for a learning assignment.",
            "format":"date-time",
            "nullable":true
        },
        "assignmentDueDateType":{
            "maxLength":30,
            "type":"string",
            "description":"Type of learning assignment due date. Valid values are ORA_RELATIVE_DATE and ORA_SPECIFIC_DATE.",
            "nullable":true,
            "default":"ORA_INIT_NO_DUE_DATE"
        },
        "assignmentDueIn":{
            "type":"number",
            "description":"Number of days to complete the learning assignment after it's assigned.",
            "nullable":true
        },
        "assignmentDueInUnits":{
            "maxLength":255,
            "type":"string",
            "description":"Unit of measure for the quantity that identifies when the learning assignment is due, such as days, months, or years",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "assignmentJustification":{
            "maxLength":4000,
            "type":"string",
            "description":"Justification provided by the person assigning the learning.",
            "nullable":true
        },
        "assignmentNotes":{
            "maxLength":4000,
            "type":"string",
            "description":"Notes from the person assigning the learning to the assigned learners.",
            "nullable":true
        },
        "assignmentProfileDescription":{
            "maxLength":4000,
            "type":"string",
            "description":"Description for the learning assignment profile.",
            "nullable":true
        },
        "assignmentProfileEndDate":{
            "type":"string",
            "description":"Date the processing of the learning assignment profile needs to complete.",
            "format":"date-time",
            "nullable":true
        },
        "assignmentProfileId":{
            "type":"integer",
            "description":"Unique identifier of the assignment profile's details.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "assignmentProfileNumber":{
            "maxLength":30,
            "type":"string",
            "description":"User-friendly identifier for the profile linked to the learning assignment.",
            "nullable":true
        },
        "assignmentProfileRecords":{
            "title":"Assignment Profiles",
            "type":"array",
            "description":"The assignment profile records associated with the learning assignment.",
            "items":{
                "$ref":"#/components/schemas/learningAssignmentProfiles-assignmentProfileRecords-item-post-request"
            }
        },
        "assignmentProfileStartDate":{
            "type":"string",
            "description":"Date the processing of the learning assignment profile needs to start.",
            "format":"date",
            "nullable":true
        },
        "assignmentProfileStatus":{
            "maxLength":30,
            "type":"string",
            "description":"Status for the learning assignment profile.",
            "nullable":false
        },
        "assignmentProfileTitle":{
            "maxLength":250,
            "type":"string",
            "description":"Name of the learning assignment profile.",
            "nullable":true
        },
        "assignmentRecordStatus":{
            "maxLength":30,
            "type":"string",
            "description":"The status of the learning assignment.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "assignmentSubType":{
            "maxLength":30,
            "type":"string",
            "description":"Learning assignment subtype. Valid values include ORA_SELF and ORA_ADMIN.",
            "nullable":true
        },
        "assignmentType":{
            "maxLength":30,
            "type":"string",
            "description":"Learning assignment type. Valid values are ORA_REQUIRE_ASSIGNMENT and ORA_JOIN_ASSIGNMENT.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "completionComments":{
            "maxLength":4000,
            "type":"string",
            "description":"Comments provided when marking the learning assignment as completed.",
            "nullable":true
        },
        "completionReasonCode":{
            "maxLength":30,
            "type":"string",
            "description":"Reason code for marking the learning assignment as completed.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "dataSecurityPrivilege":{
            "type":"string",
            "description":"Data security privilege for the role of the person accessing the learning assignment, such as Learner or Learner Manager. Valid values are defined in the DataSecurityPrivilegeLOV.",
            "nullable":true
        },
        "dueInNumber":{
            "type":"number",
            "description":"Quantity for the measurement indicating when the renewal assignment is due, such as 30.",
            "nullable":true
        },
        "dueInUOM":{
            "maxLength":255,
            "type":"string",
            "description":"Unit of measure for the quantity that identifies when the renewal assignment is due, such as days, months, or years",
            "nullable":true
        },
        "dueMonth":{
            "maxLength":255,
            "type":"string",
            "description":"Month in which the renewal assignment is due.",
            "nullable":true
        },
        "dueOnDay":{
            "type":"number",
            "description":"Day when the renewal assignment is due.",
            "nullable":true
        },
        "enableRenewals":{
            "maxLength":255,
            "type":"string",
            "description":"Indicates whether the renewals are enabled on the learning assignment profile. Valid values are Y and N.",
            "nullable":true
        },
        "excludeEnrollmentFromHistory":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the assignment needs to be hidden from the learner's transcript. Valid values are Y and N. When the value is Y, the assignment's status is set to ORA_ASSN_REC_DELETED. When the value is N, the assignment's status is set to ORA_ASSN_REC_WITHDRAWN.",
            "nullable":true
        },
        "existingCompletionValidityRule":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates when the previous completion expires. Valid values are ORA_FORCE_RETAKE_EXP_COMPL_CD, ORA_FORCE_RETAKE_EXP_COMPL_DD, ORA_FORCE_RETAKE_EXP_COMPL_AD and ORA_FORCE_RETAKE_EXP_COMPL_RN.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "increaseMaximumCapacity":{
            "maxLength":64,
            "type":"string",
            "description":"Indicates whether the maximum capacity for the learning should be increased and the waitlist bypassed. Valid values are Y and N.",
            "nullable":true
        },
        "learningAssignmentProfileCriteria":{
            "title":"Leaning Assignment Profile Criteria",
            "type":"array",
            "description":"The learningAssignmentProfileCriteria resource associates 1 or more learners with a learning item.",
            "items":{
                "$ref":"#/components/schemas/learningAssignmentProfiles-learningAssignmentProfileCriteria-item-post-request"
            }
        },
        "learningItem":{
            "title":"Noncatalog Learning Item",
            "type":"array",
            "description":"The learning item details required to create noncatalog requests or record external learning under the assignment profile.",
            "items":{
                "$ref":"#/components/schemas/learningAssignmentProfiles-learningItem-item-post-request"
            }
        },
        "learningItemId":{
            "type":"integer",
            "description":"Unique identifier of the assigned learning item.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "learningItemNumber"
                ]
            }
        },
        "learningItemNumber":{
            "type":"string",
            "description":"Number given to the assigned learning item.",
            "nullable":true
        },
        "learningItemType":{
            "type":"string",
            "description":"Type of learning item. Valid values include ORA_COURSE, ORA_SPECIALIZATION, and ORA_LEGACY.",
            "nullable":true
        },
        "minimumDaysToComplete":{
            "type":"number",
            "description":"Minimum number of days to complete the learning assignment created in the subsequent run of the learning assignment profile, after it's assigned.",
            "nullable":true
        },
        "ongoingAssignmentDueDate":{
            "type":"string",
            "description":"Due date for a learning assignment created in the subsequent run of the learning assignment profile.",
            "format":"date-time",
            "nullable":true
        },
        "ongoingDueDateType":{
            "maxLength":30,
            "type":"string",
            "description":"Type of learning assignment due date for the subsequent run of the learning assignment profile. Valid values are ORA_RELATIVE_DATE and ORA_SPECIFIC_DATE.",
            "nullable":true
        },
        "ongoingDueIn":{
            "type":"number",
            "description":"Number of days to complete the learning assignment created in the subsequent run of the learning assignment profile, after it's assigned.",
            "nullable":true
        },
        "ongoingDueInUnits":{
            "maxLength":255,
            "type":"string",
            "description":"Unit of measure for the quantity that identifies when the learning assignment created in the subsequent run of the learning assignment profile is due, such as days, months, or years",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "processId":{
            "type":"integer",
            "description":"Unique identifier for the process.",
            "nullable":true
        },
        "processingFrequency":{
            "maxLength":30,
            "type":"string",
            "description":"Processing frequency for the learning assignment profile.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "processingRule":{
            "maxLength":1,
            "type":"string",
            "description":"Processing rule for the assignment profile.",
            "nullable":false,
            "default":"N",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "purchaseOrderNumber":{
            "maxLength":30,
            "type":"string",
            "description":"Order number for purchasing the learning.",
            "nullable":true
        },
        "reassignNumber":{
            "type":"number",
            "description":"Quantity for the measurement indicating when the learning assignment should be reassigned, such as 1.",
            "nullable":true
        },
        "reassignOnDay":{
            "type":"number",
            "description":"Day when the renewal assignment should be created.",
            "nullable":true
        },
        "reassignOnMonth":{
            "maxLength":30,
            "type":"string",
            "description":"Month when the renewal assignment should be created.",
            "nullable":true
        },
        "reassignUOM":{
            "maxLength":30,
            "type":"string",
            "description":"Unit of measure for the quantity that identifies when the renewal assignment should be created, such as days, months, or years",
            "nullable":true
        },
        "recommendationCategory":{
            "maxLength":30,
            "type":"string",
            "description":"Category code to which the learning assignment belongs.",
            "nullable":true
        },
        "relatedMaterials":{
            "title":"Related Materials",
            "type":"array",
            "description":"The relatedMaterials resource provides a list of related learning material for its parent resource. It's also used to add and remove related material.",
            "items":{
                "$ref":"#/components/schemas/learningAssignmentProfiles-relatedMaterials-item-post-request"
            }
        },
        "renewalOption":{
            "maxLength":30,
            "type":"string",
            "description":"Rule to identify the start date of the renewal assignment.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "renewalPeriod":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates when the learning assignment should be renewed. Valid values are ORA_ANNUAL_DUE_DATE and ORA_REL_TO_PRIOR_COMPLETION.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "requestedCompletionDate":{
            "type":"string",
            "description":"Requested date by when the learner should complete the related learning assignment.",
            "format":"date",
            "nullable":true
        },
        "requestedStartDate":{
            "type":"string",
            "description":"Start date for the requested learning assignment.",
            "format":"date",
            "nullable":true
        },
        "retakeInNumber":{
            "type":"number",
            "description":"Quantity for the measurement indicating when learners should retake the learning, such as 1.",
            "nullable":true
        },
        "retakeInUnitOfMeasure":{
            "maxLength":30,
            "type":"string",
            "description":"Unit of measure for the quantity that identifies when learners should retake the learning, such as days, months, or years.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "retakeRule":{
            "maxLength":30,
            "type":"string",
            "description":"Rule indicating when learners should retake the learning again. Valid values are ORA_EXEMPT_LEARNING, ORA_RETAKE_LEARNING, ORA_RETAKE_WITH_EXEMPT_DATE and ORA_RETAKE_WITH_EXEMPT_BEFORE.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "retakeWhenCompletedBeforeDate":{
            "type":"string",
            "description":"Learners with assignment completions before this date need to retake the learning.",
            "format":"date",
            "nullable":true
        },
        "runAsPersonId":{
            "type":"integer",
            "description":"Unique identifier of the person associated with the assignment profile.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "runAsPersonNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Friendly identifier for the person associated with the assignment profile.",
            "nullable":true
        },
        "sourceId":{
            "title":"Enrollment Source Identifier",
            "type":"integer",
            "description":"Unique identifier for the source where this assignment was created.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "sourceType":{
            "title":"Enrollment Source Type",
            "maxLength":30,
            "type":"string",
            "description":"Type for the source where this assignment was created, such as Recommendation or Search.",
            "nullable":true
        },
        "statusChangeComments":{
            "maxLength":400,
            "type":"string",
            "description":"Status change comment for the learning assignment.",
            "nullable":true
        },
        "statusChangeReasonCode":{
            "maxLength":30,
            "type":"string",
            "description":"Reason code for the learning assignment status change.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "targetAssignmentStatus":{
            "maxLength":30,
            "type":"string",
            "description":"Status to set for the learning assignment.",
            "nullable":true
        },
        "validityPeriodBeginRule":{
            "maxLength":30,
            "type":"string",
            "description":"Rule identifying when the validity period for the completed learning assignment starts..",
            "nullable":true
        },
        "validityPeriodExpiryDay":{
            "type":"number",
            "description":"Day when the learning assignment validity should expire.",
            "nullable":true
        },
        "validityPeriodExpiryFrom":{
            "maxLength":30,
            "type":"string",
            "description":"Rule to calculate when he learning assignment's validity period should expire.",
            "nullable":true
        },
        "validityPeriodExpiryMonth":{
            "maxLength":255,
            "type":"string",
            "description":"Month in which the learning assignment validity should expire.",
            "nullable":true
        },
        "validityPeriodExpiryNumber":{
            "type":"number",
            "description":"Quantity for the measurement indicating when the learning assignment expires, such as 1.",
            "nullable":true
        },
        "validityPeriodExpiryRule":{
            "maxLength":255,
            "type":"string",
            "description":"Rule that identifies when the learning assignment's validity period expires. Valid values are ORA_EXP_NEVER, ORA_EXP_ DATE and ORA_EXP_RELATIVE_DATE.",
            "nullable":true
        },
        "validityPeriodExpiryUOM":{
            "maxLength":30,
            "type":"string",
            "description":"Unit of measure for the quantity that identifies when the learning assignment expires.",
            "nullable":true
        },
        "waiveComments":{
            "maxLength":4000,
            "type":"string",
            "description":"Comments provided when waiving prerequisites for the assignments.",
            "nullable":true
        },
        "waivePrerequisites":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the prerequisites need to be waived while creating learning assignments. Valid values are Y or N.",
            "nullable":true,
            "default":"N"
        },
        "waiveReasonCode":{
            "maxLength":30,
            "type":"string",
            "description":"Reason for waiving assignment prerequisites.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "withdrawOnProcessing":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates whether the assignment needs to be withdrawn for learners who are no longer part of the assignment profile audience. Valid values are Y or N.",
            "nullable":true,
            "default":"Y"
        }
    }
}

Nested Schema : assignmentDFF

Type: array

Show Source

• Array of: object learningAssignmentProfiles-assignmentDFF-item-post-request

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/learningAssignmentProfiles-assignmentDFF-item-post-request"
    },
    "x-cardinality":"1"
}

Nested Schema : Assignment Profiles

Type: array

Title: Assignment Profiles

The assignment profile records associated with the learning assignment.

Show Source

• Array of: object learningAssignmentProfiles-assignmentProfileRecords-item-post-request

{
    "title":"Assignment Profiles",
    "type":"array",
    "description":"The assignment profile records associated with the learning assignment.",
    "items":{
        "$ref":"#/components/schemas/learningAssignmentProfiles-assignmentProfileRecords-item-post-request"
    }
}

Nested Schema : Leaning Assignment Profile Criteria

Type: array

Title: Leaning Assignment Profile Criteria

The learningAssignmentProfileCriteria resource associates 1 or more learners with a learning item.

Show Source

• Array of: object learningAssignmentProfiles-learningAssignmentProfileCriteria-item-post-request

{
    "title":"Leaning Assignment Profile Criteria",
    "type":"array",
    "description":"The learningAssignmentProfileCriteria resource associates 1 or more learners with a learning item.",
    "items":{
        "$ref":"#/components/schemas/learningAssignmentProfiles-learningAssignmentProfileCriteria-item-post-request"
    }
}

Nested Schema : Noncatalog Learning Item

Type: array

Title: Noncatalog Learning Item

The learning item details required to create noncatalog requests or record external learning under the assignment profile.

Show Source

• Array of: object learningAssignmentProfiles-learningItem-item-post-request

{
    "title":"Noncatalog Learning Item",
    "type":"array",
    "description":"The learning item details required to create noncatalog requests or record external learning under the assignment profile.",
    "items":{
        "$ref":"#/components/schemas/learningAssignmentProfiles-learningItem-item-post-request"
    }
}

Nested Schema : Related Materials

Type: array

Title: Related Materials

The relatedMaterials resource provides a list of related learning material for its parent resource. It's also used to add and remove related material.

Show Source

• Array of: object learningAssignmentProfiles-relatedMaterials-item-post-request

{
    "title":"Related Materials",
    "type":"array",
    "description":"The relatedMaterials resource provides a list of related learning material for its parent resource. It's also used to add and remove related material.",
    "items":{
        "$ref":"#/components/schemas/learningAssignmentProfiles-relatedMaterials-item-post-request"
    }
}

Nested Schema : learningAssignmentProfiles-assignmentDFF-item-post-request

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 30

  Context Segment
• __FLEX_Context_DisplayValue: string
  Title: Context Segment

  Context Segment
• RequestDetailId: integer (int64)

{
    "type":"object",
    "properties":{
        "RequestDetailId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18
            }
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":30,
            "type":"string",
            "description":"Context Segment",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "description":"Context Segment",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        }
    }
}

Nested Schema : learningAssignmentProfiles-assignmentProfileRecords-item-post-request

Type: object

Show Source

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

Nested Schema : learningAssignmentProfiles-learningAssignmentProfileCriteria-item-post-request

Type: object

Show Source

• assignmentProfileCriteriaId: integer (int64)
  Unique identifier for the assignment profile criteria details.
• assignmentProfileCriteriaSourceName: string
  Maximum Length: 255

  Name of the source associated with the learning assignment profile audience criteria.
• assignmentProfileCriteriaType: string
  Maximum Length: 30

  Type of learner.
• assignmentProfileCriteriaTypeId(required): integer (int64)
  The unique identifier of the learner that the learning is being assigned to.
• assignmentProfileCriteriaTypeNumber: string
  Maximum Length: 255

  Friendly number for the criteria.
• assignmentProfileId: integer (int64)
  Unique identifier of the assignment profile's details.
• personAttachment: array Learning Contributor Person List Attachment
  Title: Learning Contributor Person List Attachment

  The personAttachment resource is used to attach the list of person IDs or person emails for the recipients getting assignments generated by the specified assignment profile.
• reportName: string
  Maximum Length: 255

  Name of the analysis report.

{
    "required":[
        "assignmentProfileCriteriaTypeId"
    ],
    "type":"object",
    "properties":{
        "assignmentProfileCriteriaId":{
            "type":"integer",
            "description":"Unique identifier for the assignment profile criteria details.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "assignmentProfileCriteriaSourceName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the source associated with the learning assignment profile audience criteria.",
            "nullable":true
        },
        "assignmentProfileCriteriaType":{
            "maxLength":30,
            "type":"string",
            "description":"Type of learner.",
            "nullable":true
        },
        "assignmentProfileCriteriaTypeId":{
            "type":"integer",
            "description":"The unique identifier of the learner that the learning is being assigned to.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "assignmentProfileCriteriaTypeNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Friendly number for the criteria.",
            "nullable":true
        },
        "assignmentProfileId":{
            "type":"integer",
            "description":"Unique identifier of the assignment profile's details.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "personAttachment":{
            "title":"Learning Contributor Person List Attachment",
            "type":"array",
            "description":"The personAttachment resource is used to attach the list of person IDs or person emails for the recipients getting assignments generated by the specified assignment profile.",
            "items":{
                "$ref":"#/components/schemas/learningAssignmentProfiles-learningAssignmentProfileCriteria-personAttachment-item-post-request"
            },
            "x-cardinality":"1"
        },
        "reportName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the analysis report.",
            "nullable":true
        }
    }
}

Nested Schema : Learning Contributor Person List Attachment

Type: array

Title: Learning Contributor Person List Attachment

The personAttachment resource is used to attach the list of person IDs or person emails for the recipients getting assignments generated by the specified assignment profile.

Show Source

• Array of: object learningAssignmentProfiles-learningAssignmentProfileCriteria-personAttachment-item-post-request

{
    "title":"Learning Contributor Person List Attachment",
    "type":"array",
    "description":"The personAttachment resource is used to attach the list of person IDs or person emails for the recipients getting assignments generated by the specified assignment profile.",
    "items":{
        "$ref":"#/components/schemas/learningAssignmentProfiles-learningAssignmentProfileCriteria-personAttachment-item-post-request"
    },
    "x-cardinality":"1"
}

Nested Schema : learningAssignmentProfiles-learningAssignmentProfileCriteria-personAttachment-item-post-request

Type: object

Show Source

• AsyncTrackerId: string
  Title: Asynchronous Upload Tracker Id

  Attribute provided by the Attachment UI components to support the upload of files.
• AttachedDocumentId: integer (int64)
  Title: Attached Document Id

  Unique identifier of the attached document.
• CategoryName: string
  Title: Category

  Maximum Length: 30

  Category name of the attachment. This is a read-only attribute.
• ContentRepositoryFileShared: boolean
  Title: Shared

  Indicates whether the file can be shared. The default value is false and it's the only supported value.
• DatatypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: FILE

  Attachment Type such as FILE or TEXT, or WEB_PAGE.
• Description: string
  Title: Description

  Maximum Length: 255

  Description for the attachment.
• DmDocumentId: string
  Maximum Length: 255

  Surrogate identifier for the document attached.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  Folder path where the attachment will be created.
• DmVersionNumber: string
  Maximum Length: 255

  Version number for the attachment.
• DownloadInfo: string
  Title: DownloadInfo

  JSON object represented as a string that contains information used to programmatically retrieve a file attachment.
• ErrorStatusCode: string
  Title: Error Status Code

  Error status code, if any, for the attachment.
• ErrorStatusMessage: string
  Title: Error Status Message

  Expiration date for the attachment. This is a read-only attribute.
• ExpirationDate: string (date-time)
  Title: Expiration Date

  Expiration date of the attachment. This is a read-only attribute.
• FileContents: string (byte)
  Title: File Contents

  Actual content of the attachment.
• FileName: string
  Title: File Name

  Maximum Length: 2048

  Name for the attachment file.
• FileUrl: string
  Title: File Url

  File URL for the attachment.
• PostProcessingAction: string
  Title: PostProcessingAction

  Name of the action that can be done after an attachment is uploaded.
• Title: string
  Title: Title

  Title of the attachment.
• UploadedFileContentType: string
  Title: Uploaded File Content Type

  Content type of the uploaded file. This is a read-only attribute.
• UploadedFileLength: integer
  Title: File Size

  Size of the uploaded file. This is a read-only attribute.
• UploadedFileName: string
  Title: Uploaded File Name

  Name of the uploaded file. This is a read-only attribute.
• UploadedText: string
  Title: Uploaded Text

  Text uploaded in the attachment.
• Uri: string
  Title: Uri

  Maximum Length: 4000

  URI for the attachment. This is a read-only attribute.
• Url: string
  Title: Url

  Maximum Length: 4000

  URL for a web page type attachment.

{
    "type":"object",
    "properties":{
        "AsyncTrackerId":{
            "title":"Asynchronous Upload Tracker Id",
            "type":"string",
            "description":"Attribute provided by the Attachment UI components to support the upload of files.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            }
        },
        "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"
            }
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"Category name of the attachment. This is a read-only attribute.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Indicates whether the file can be shared. The default value is false and it's the only supported value.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"Attachment Type such as FILE or TEXT, or WEB_PAGE.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":255,
            "type":"string",
            "description":"Description for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmDocumentId":{
            "maxLength":255,
            "type":"string",
            "description":"Surrogate identifier for the document attached.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            }
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":1000,
            "type":"string",
            "description":"Folder path where the attachment will be created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "DmVersionNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Version number for the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"JSON object represented as a string that contains information used to programmatically retrieve a file attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"Error status code, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"Expiration date for the attachment. This is a read-only attribute.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"Expiration date of the attachment. This is a read-only attribute.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"Actual content of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":2048,
            "type":"string",
            "description":"Name for the attachment file.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"File URL for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "PostProcessingAction":{
            "title":"PostProcessingAction",
            "type":"string",
            "description":"Name of the action that can be done 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"
            }
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"Content type of the uploaded file. This is a read-only attribute.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"Size of the uploaded file. This is a read-only attribute.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"Name of the uploaded file. This is a read-only attribute.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"Text uploaded in the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":4000,
            "type":"string",
            "description":"URI for the attachment. This is a read-only attribute.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Url":{
            "title":"Url",
            "maxLength":4000,
            "type":"string",
            "description":"URL for a web page type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        }
    }
}

Nested Schema : learningAssignmentProfiles-learningItem-item-post-request

Type: object

Show Source

• actualCpeUnits: number
  Title: Actual CPE Units

  Continuing professional education units that the learner achieved for this assignment.
• learningItemCpeType: string
  Title: Learning Item CPE Type

  Maximum Length: 30

  Continuing professional education type for the learning item. Valid values are defined in the CpeTypeLOV list.
• learningItemDescription: string
  Maximum Length: 4000

  Description of the learning item.
• learningItemDFF: array learningItemDFF
• learningItemExpectedEffort: number
  Expected effort to complete the learning item
• learningItemExpectedEffortInSeconds: number
  Expected effort, in seconds, to complete the assigned learning item.
• learningItemExpectedEffortUnits: string
  Maximum Length: 30

  Default Value: ORA_DUR_HOUR

  Unit of measurement for the expected and actual effort to complete the learning item, such as day, hour, minute. Valid values are defined in the list EffortUnitsLOV.
• learningItemId: integer (int64)
  Unique identifier of the assigned learning item.
• learningItemNumber(required): string
  Maximum Length: 2000

  Number given to the assigned learning item.
• learningItemPrice: number
  Cost
• learningItemPriceCurrency: string
  Maximum Length: 30

  Currency of the price for the learning item. Valid values are defined in the list PriceCurrencyLOVVA.
• learningItemSubType: string
  Maximum Length: 30

  Learning item subtype, such as Video or Tutorial. Valid values are defined in the AssignedLearningItemSubTypeLOV list.
• learningItemTitle: string
  Maximum Length: 250

  Title of the learning item.
• learningItemType(required): string
  Maximum Length: 32

  Learning item type, such as Course, Specialization, Tutorial, Video, or eLearning. Valid values are defined in the list AssignedLearningItemTypeLOV.
• learningItemURL: string
  Maximum Length: 4000

  URL that can be used to embed the learning item page in other pages.

{
    "required":[
        "learningItemNumber",
        "learningItemType"
    ],
    "type":"object",
    "properties":{
        "actualCpeUnits":{
            "title":"Actual CPE Units",
            "type":"number",
            "description":"Continuing professional education units that the learner achieved for this assignment.",
            "nullable":true
        },
        "learningItemCpeType":{
            "title":"Learning Item CPE Type",
            "maxLength":30,
            "type":"string",
            "description":"Continuing professional education type for the learning item. Valid values are defined in the CpeTypeLOV list.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "learningItemDFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/learningAssignmentProfiles-learningItem-learningItemDFF-item-post-request"
            },
            "x-cardinality":"1"
        },
        "learningItemDescription":{
            "maxLength":4000,
            "type":"string",
            "description":"Description of the learning item.",
            "nullable":true
        },
        "learningItemExpectedEffort":{
            "type":"number",
            "description":"Expected effort to complete the learning item",
            "nullable":true
        },
        "learningItemExpectedEffortInSeconds":{
            "type":"number",
            "description":"Expected effort, in seconds, to complete the assigned learning item.",
            "nullable":true
        },
        "learningItemExpectedEffortUnits":{
            "maxLength":30,
            "type":"string",
            "description":"Unit of measurement for the expected and actual effort to complete the learning item, such as day, hour, minute. Valid values are defined in the list EffortUnitsLOV.",
            "nullable":true,
            "default":"ORA_DUR_HOUR"
        },
        "learningItemId":{
            "type":"integer",
            "description":"Unique identifier of the assigned learning item.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "learningItemNumber":{
            "maxLength":2000,
            "type":"string",
            "description":"Number given to the assigned learning item.",
            "nullable":false
        },
        "learningItemPrice":{
            "type":"number",
            "description":"Cost",
            "nullable":true
        },
        "learningItemPriceCurrency":{
            "maxLength":30,
            "type":"string",
            "description":"Currency of the price for the learning item. Valid values are defined in the list PriceCurrencyLOVVA.",
            "nullable":true
        },
        "learningItemSubType":{
            "maxLength":30,
            "type":"string",
            "description":"Learning item subtype, such as Video or Tutorial. Valid values are defined in the AssignedLearningItemSubTypeLOV list.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "learningItemTitle":{
            "maxLength":250,
            "type":"string",
            "description":"Title of the learning item.",
            "nullable":true
        },
        "learningItemType":{
            "maxLength":32,
            "type":"string",
            "description":"Learning item type, such as Course, Specialization, Tutorial, Video, or eLearning. Valid values are defined in the list AssignedLearningItemTypeLOV.",
            "nullable":false
        },
        "learningItemURL":{
            "maxLength":4000,
            "type":"string",
            "description":"URL that can be used to embed the learning item page in other pages.",
            "nullable":true
        }
    }
}

Nested Schema : learningItemDFF

Type: array

Show Source

• Array of: object learningAssignmentProfiles-learningItem-learningItemDFF-item-post-request

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/learningAssignmentProfiles-learningItem-learningItemDFF-item-post-request"
    },
    "x-cardinality":"1"
}

Nested Schema : learningAssignmentProfiles-learningItem-learningItemDFF-item-post-request

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 30

  Context Segment
• __FLEX_Context_DisplayValue: string
  Title: Context Segment

  Context Segment
• EffectiveEndDate: string (date)
• EffectiveStartDate: string (date)
• LearningItemId: integer (int64)
• LearningItemType: string
  Maximum Length: 32

{
    "type":"object",
    "properties":{
        "EffectiveEndDate":{
            "type":"string",
            "format":"date",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true
            }
        },
        "EffectiveStartDate":{
            "type":"string",
            "format":"date",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true
            }
        },
        "LearningItemId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18
            }
        },
        "LearningItemType":{
            "maxLength":32,
            "type":"string",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":30,
            "type":"string",
            "description":"Context Segment",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"HIDDEN"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "description":"Context Segment",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"HIDDEN"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        }
    }
}

Nested Schema : learningAssignmentProfiles-relatedMaterials-item-post-request

Type: object

Show Source

• relatedMaterialsBinaries: array Attachments
  Title: Attachments

  The attachments resource is used to view, create, and update attachments.
• visibility: string
  Maximum Length: 80

  Determines who can view or edit the attachments, such as Administrators, Administrators and Enrollees, or Administrators and Self Service.

{
    "type":"object",
    "properties":{
        "relatedMaterialsBinaries":{
            "title":"Attachments",
            "type":"array",
            "description":"The attachments resource is used to view, create, and update attachments.",
            "items":{
                "$ref":"#/components/schemas/learningAssignmentProfiles-relatedMaterials-relatedMaterialsBinaries-item-post-request"
            }
        },
        "visibility":{
            "maxLength":80,
            "type":"string",
            "description":"Determines who can view or edit the attachments, such as Administrators, Administrators and Enrollees, or Administrators and Self Service.",
            "nullable":true
        }
    }
}

Nested Schema : Attachments

Type: array

Title: Attachments

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

Show Source

• Array of: object schema

{
    "title":"Attachments",
    "type":"array",
    "description":"The attachments resource is used to view, create, and update attachments.",
    "items":{
        "$ref":"#/components/schemas/learningAssignmentProfiles-relatedMaterials-relatedMaterialsBinaries-item-post-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• AsyncTrackerId: string
  Title: Asynchronous Upload Tracker Id

  Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.
• AttachedDocumentId: integer (int64)
  Title: Attached Document Id

  The unique identifier of the attached document.
• CategoryName: string
  Title: Category

  Maximum Length: 30

  The category of the attachment.
• ContentRepositoryFileShared: boolean
  Title: Shared

  Indicates whether the attachment is shared
• DatatypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: FILE

  A value that indicates the data type.
• Description: string
  Title: Description

  Maximum Length: 255

  The description of the attachment.
• DmDocumentId: string
  Maximum Length: 255

  The document ID from which the attachment is created.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  The folder path from which the attachment is created.
• DmVersionNumber: string
  Maximum Length: 255

  The document version number from which the attachment is created.
• 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

  The error code, if any, for the attachment.
• ErrorStatusMessage: string
  Title: Error Status Message

  The error message, if any, for the attachment.
• ExpirationDate: string (date-time)
  Title: Expiration Date

  The expiration date of the contents in the attachment.
• FileContents: string (byte)
  Title: File Contents

  The contents of the attachment.
• FileName: string
  Title: File Name

  Maximum Length: 2048

  The file name of the attachment.
• FileUrl: string
  Title: File Url

  The URI of the file.
• PostProcessingAction: string
  Title: PostProcessingAction

  The name of the action that can be performed after an attachment is uploaded.
• Title: string
  Title: Title

  The title of the attachment.
• UploadedFileContentType: string
  Title: Uploaded File Content Type

  The content type of the attachment.
• UploadedFileLength: integer
  Title: File Size

  The size of the attachment file.
• UploadedFileName: string
  Title: Uploaded File Name

  The name to assign to a new attachment file.
• UploadedText: string
  Title: Uploaded Text

  The text content for a new text attachment.
• Uri: string
  Title: Uri

  Maximum Length: 4000

  The URI of a Topology Manager type attachment.
• Url: string
  Title: Url

  Maximum Length: 4000

  The URL of a web page type attachment.

{
    "type":"object",
    "properties":{
        "AsyncTrackerId":{
            "title":"Asynchronous Upload Tracker Id",
            "type":"string",
            "description":"Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            }
        },
        "AttachedDocumentId":{
            "title":"Attached Document Id",
            "type":"integer",
            "description":"The 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"
            }
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"The category of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "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"
            }
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"A value that indicates the data type.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":255,
            "type":"string",
            "description":"The description of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmDocumentId":{
            "maxLength":255,
            "type":"string",
            "description":"The document ID from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            }
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":1000,
            "type":"string",
            "description":"The folder path from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "DmVersionNumber":{
            "maxLength":255,
            "type":"string",
            "description":"The document version number from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "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"
            }
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"The error code, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"The error message, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The expiration date of the contents in the attachment.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"The contents of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":2048,
            "type":"string",
            "description":"The file name of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"The URI of the file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "PostProcessingAction":{
            "title":"PostProcessingAction",
            "type":"string",
            "description":"The 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":"The title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"The content type of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"The size of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"The name to assign to a new attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"The text content for a new text attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":4000,
            "type":"string",
            "description":"The URI of a Topology Manager type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Url":{
            "title":"Url",
            "maxLength":4000,
            "type":"string",
            "description":"The URL of a web page type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"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 : learningAssignmentProfiles-item-response

Type: object

Show Source

• assignAs: string
  Maximum Length: 30

  Display name of the person who created the learning assignment for the learner. For example, in case of voluntary assignment, it's the name of the learner. For a specialist created assignment, it's the name of the specialist or the alias used in Assign As.
• assignedOnDate: string (date-time)
  Read Only: true

  Date when the learning item was assigned.
• assignmentActualEffort: number
  Effort required to complete the assignment.
• assignmentActualScore: number
  The learner's actual score for completed learning.
• assignmentCompletionDate: string (date-time)
  Date the learning assignment was completed.
• assignmentDFF: array assignmentDFF
• assignmentDueDate: string (date-time)
  Due date for a learning assignment.
• assignmentDueDateType: string
  Maximum Length: 30

  Default Value: ORA_INIT_NO_DUE_DATE

  Type of learning assignment due date. Valid values are ORA_RELATIVE_DATE and ORA_SPECIFIC_DATE.
• assignmentDueIn: number
  Number of days to complete the learning assignment after it's assigned.
• assignmentDueInUnits: string
  Maximum Length: 255

  Unit of measure for the quantity that identifies when the learning assignment is due, such as days, months, or years
• assignmentJustification: string
  Maximum Length: 4000

  Justification provided by the person assigning the learning.
• assignmentNotes: string
  Maximum Length: 4000

  Notes from the person assigning the learning to the assigned learners.
• assignmentProfileDescription: string
  Maximum Length: 4000

  Description for the learning assignment profile.
• assignmentProfileEndDate: string (date-time)
  Date the processing of the learning assignment profile needs to complete.
• assignmentProfileId: integer (int64)
  Unique identifier of the assignment profile's details.
• assignmentProfileNumber: string
  Maximum Length: 30

  User-friendly identifier for the profile linked to the learning assignment.
• assignmentProfileRecords: array Assignment Profiles
  Title: Assignment Profiles

  The assignment profile records associated with the learning assignment.
• assignmentProfileStartDate: string (date)
  Date the processing of the learning assignment profile needs to start.
• assignmentProfileStatus: string
  Maximum Length: 30

  Status for the learning assignment profile.
• assignmentProfileStatusMeaning: string
  Read Only: true

  Maximum Length: 255

  Description for the learning assignment profile status.
• assignmentProfileTitle: string
  Maximum Length: 250

  Name of the learning assignment profile.
• assignmentRecordStatus: string
  Maximum Length: 30

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

  Maximum Length: 255

  Meaning associated with the learning assignment status.
• assignmentSubType: string
  Maximum Length: 30

  Learning assignment subtype. Valid values include ORA_SELF and ORA_ADMIN.
• assignmentType: string
  Maximum Length: 30

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

  Maximum Length: 255

  Description associated with the assignment type.
• completionComments: string
  Maximum Length: 4000

  Comments provided when marking the learning assignment as completed.
• completionReasonCode: string
  Maximum Length: 30

  Reason code for marking the learning assignment as completed.
• createdBy: string
  Read Only: true

  Maximum Length: 64

  Name of the person who created the learning assignment profile.
• creationDate: string (date-time)
  Read Only: true

  Date and time when the learning assignment profile was created.
• dataSecurityPrivilege: string
  Data security privilege for the role of the person accessing the learning assignment, such as Learner or Learner Manager. Valid values are defined in the DataSecurityPrivilegeLOV.
• dueInNumber: number
  Quantity for the measurement indicating when the renewal assignment is due, such as 30.
• dueInUOM: string
  Maximum Length: 255

  Unit of measure for the quantity that identifies when the renewal assignment is due, such as days, months, or years
• dueMonth: string
  Maximum Length: 255

  Month in which the renewal assignment is due.
• dueOnDay: number
  Day when the renewal assignment is due.
• enableRenewals: string
  Maximum Length: 255

  Indicates whether the renewals are enabled on the learning assignment profile. Valid values are Y and N.
• excludeEnrollmentFromHistory: string
  Maximum Length: 1

  Indicates whether the assignment needs to be hidden from the learner's transcript. Valid values are Y and N. When the value is Y, the assignment's status is set to ORA_ASSN_REC_DELETED. When the value is N, the assignment's status is set to ORA_ASSN_REC_WITHDRAWN.
• existingCompletionValidityRule: string
  Maximum Length: 30

  Indicates when the previous completion expires. Valid values are ORA_FORCE_RETAKE_EXP_COMPL_CD, ORA_FORCE_RETAKE_EXP_COMPL_DD, ORA_FORCE_RETAKE_EXP_COMPL_AD and ORA_FORCE_RETAKE_EXP_COMPL_RN.
• increaseMaximumCapacity: string
  Maximum Length: 64

  Indicates whether the maximum capacity for the learning should be increased and the waitlist bypassed. Valid values are Y and N.
• lastModifiedDate: string (date-time)
  Read Only: true

  Date when the learning assignment profile was most recently changed.
• lastProcessedDate: string (date-time)
  Read Only: true

  Date when the learning assignment profile was most recently processed.
• learningAssignmentProfileCriteria: array Leaning Assignment Profile Criteria
  Title: Leaning Assignment Profile Criteria

  The learningAssignmentProfileCriteria resource associates 1 or more learners with a learning item.
• learningItem: array Noncatalog Learning Item
  Title: Noncatalog Learning Item

  The learning item details required to create noncatalog requests or record external learning under the assignment profile.
• learningItemCoverArtLink: string
  Read Only: true

  Maximum Length: 255

  URL to open the learning item cover art directly from the browser.
• learningItemId: integer (int64)
  Unique identifier of the assigned learning item.
• learningItemNumber: string
  Number given to the assigned learning item.
• learningItemSubTypeMeaning: string
  Read Only: true

  Maximum Length: 255

  Description of the learningItemSubType attribute value.
• learningItemTitle: string
  Read Only: true

  Maximum Length: 250

  Title of the learning item.
• learningItemType: string
  Type of learning item. Valid values include ORA_COURSE, ORA_SPECIALIZATION, and ORA_LEGACY.
• learningItemTypeMeaning: string
  Read Only: true

  Maximum Length: 255

  Meaning associated with the learning item code.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• minimumDaysToComplete: number
  Minimum number of days to complete the learning assignment created in the subsequent run of the learning assignment profile, after it's assigned.
• ongoingAssignmentDueDate: string (date-time)
  Due date for a learning assignment created in the subsequent run of the learning assignment profile.
• ongoingDueDateType: string
  Maximum Length: 30

  Type of learning assignment due date for the subsequent run of the learning assignment profile. Valid values are ORA_RELATIVE_DATE and ORA_SPECIFIC_DATE.
• ongoingDueIn: number
  Number of days to complete the learning assignment created in the subsequent run of the learning assignment profile, after it's assigned.
• ongoingDueInUnits: string
  Maximum Length: 255

  Unit of measure for the quantity that identifies when the learning assignment created in the subsequent run of the learning assignment profile is due, such as days, months, or years
• processId: integer
  Unique identifier for the process.
• processingFrequency: string
  Maximum Length: 30

  Processing frequency for the learning assignment profile.
• processingRule: string
  Maximum Length: 1

  Default Value: N

  Processing rule for the assignment profile.
• purchaseOrderNumber: string
  Maximum Length: 30

  Order number for purchasing the learning.
• reassignNumber: number
  Quantity for the measurement indicating when the learning assignment should be reassigned, such as 1.
• reassignOnDay: number
  Day when the renewal assignment should be created.
• reassignOnMonth: string
  Maximum Length: 30

  Month when the renewal assignment should be created.
• reassignUOM: string
  Maximum Length: 30

  Unit of measure for the quantity that identifies when the renewal assignment should be created, such as days, months, or years
• recommendationCategory: string
  Maximum Length: 30

  Category code to which the learning assignment belongs.
• recommendationCategoryMeaning: string
  Read Only: true

  Maximum Length: 255

  Meaning associated with the recommended learning category code.
• relatedMaterials: array Related Materials
  Title: Related Materials

  The relatedMaterials resource provides a list of related learning material for its parent resource. It's also used to add and remove related material.
• renewalOption: string
  Maximum Length: 30

  Rule to identify the start date of the renewal assignment.
• renewalPeriod: string
  Maximum Length: 30

  Indicates when the learning assignment should be renewed. Valid values are ORA_ANNUAL_DUE_DATE and ORA_REL_TO_PRIOR_COMPLETION.
• requestedCompletionDate: string (date)
  Requested date by when the learner should complete the related learning assignment.
• requestedStartDate: string (date)
  Start date for the requested learning assignment.
• retakeInNumber: number
  Quantity for the measurement indicating when learners should retake the learning, such as 1.
• retakeInUnitOfMeasure: string
  Maximum Length: 30

  Unit of measure for the quantity that identifies when learners should retake the learning, such as days, months, or years.
• retakeRule: string
  Maximum Length: 30

  Rule indicating when learners should retake the learning again. Valid values are ORA_EXEMPT_LEARNING, ORA_RETAKE_LEARNING, ORA_RETAKE_WITH_EXEMPT_DATE and ORA_RETAKE_WITH_EXEMPT_BEFORE.
• retakeWhenCompletedBeforeDate: string (date)
  Learners with assignment completions before this date need to retake the learning.
• runAsPersonId: integer (int64)
  Unique identifier of the person associated with the assignment profile.
• runAsPersonNumber: string
  Maximum Length: 255

  Friendly identifier for the person associated with the assignment profile.
• sourceId: integer (int64)
  Title: Enrollment Source Identifier

  Unique identifier for the source where this assignment was created.
• sourceType: string
  Title: Enrollment Source Type

  Maximum Length: 30

  Type for the source where this assignment was created, such as Recommendation or Search.
• statusChangeComments: string
  Maximum Length: 400

  Status change comment for the learning assignment.
• statusChangeReasonCode: string
  Maximum Length: 30

  Reason code for the learning assignment status change.
• targetAssignmentStatus: string
  Maximum Length: 30

  Status to set for the learning assignment.
• validityPeriodBeginRule: string
  Maximum Length: 30

  Rule identifying when the validity period for the completed learning assignment starts..
• validityPeriodExpiryDay: number
  Day when the learning assignment validity should expire.
• validityPeriodExpiryFrom: string
  Maximum Length: 30

  Rule to calculate when he learning assignment's validity period should expire.
• validityPeriodExpiryMonth: string
  Maximum Length: 255

  Month in which the learning assignment validity should expire.
• validityPeriodExpiryNumber: number
  Quantity for the measurement indicating when the learning assignment expires, such as 1.
• validityPeriodExpiryRule: string
  Maximum Length: 255

  Rule that identifies when the learning assignment's validity period expires. Valid values are ORA_EXP_NEVER, ORA_EXP_ DATE and ORA_EXP_RELATIVE_DATE.
• validityPeriodExpiryUOM: string
  Maximum Length: 30

  Unit of measure for the quantity that identifies when the learning assignment expires.
• waiveComments: string
  Maximum Length: 4000

  Comments provided when waiving prerequisites for the assignments.
• waivePrerequisites: string
  Maximum Length: 1

  Default Value: N

  Indicates whether the prerequisites need to be waived while creating learning assignments. Valid values are Y or N.
• waiveReasonCode: string
  Maximum Length: 30

  Reason for waiving assignment prerequisites.
• withdrawOnProcessing: string
  Maximum Length: 30

  Default Value: Y

  Indicates whether the assignment needs to be withdrawn for learners who are no longer part of the assignment profile audience. Valid values are Y or N.

{
    "type":"object",
    "properties":{
        "assignAs":{
            "maxLength":30,
            "type":"string",
            "description":"Display name of the person who created the learning assignment for the learner. For example, in case of voluntary assignment, it's the name of the learner. For a specialist created assignment, it's the name of the specialist or the alias used in Assign As.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "assignedOnDate":{
            "type":"string",
            "description":"Date when the learning item was assigned.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "assignmentActualEffort":{
            "type":"number",
            "description":"Effort required to complete the assignment.",
            "nullable":true,
            "x-hints":{
                "precision":9,
                "scale":3
            },
            "x-queryable":true
        },
        "assignmentActualScore":{
            "type":"number",
            "description":"The learner's actual score for completed learning.",
            "nullable":true,
            "x-hints":{
                "precision":9,
                "scale":3
            },
            "x-queryable":true
        },
        "assignmentCompletionDate":{
            "type":"string",
            "description":"Date the learning assignment was completed.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "assignmentDFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/learningAssignmentProfiles-assignmentDFF-item-response"
            },
            "x-cardinality":"1"
        },
        "assignmentDueDate":{
            "type":"string",
            "description":"Due date for a learning assignment.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "assignmentDueDateType":{
            "maxLength":30,
            "type":"string",
            "description":"Type of learning assignment due date. Valid values are ORA_RELATIVE_DATE and ORA_SPECIFIC_DATE.",
            "nullable":true,
            "default":"ORA_INIT_NO_DUE_DATE",
            "x-queryable":true
        },
        "assignmentDueIn":{
            "type":"number",
            "description":"Number of days to complete the learning assignment after it's assigned.",
            "nullable":true,
            "x-queryable":true
        },
        "assignmentDueInUnits":{
            "maxLength":255,
            "type":"string",
            "description":"Unit of measure for the quantity that identifies when the learning assignment is due, such as days, months, or years",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "assignmentJustification":{
            "maxLength":4000,
            "type":"string",
            "description":"Justification provided by the person assigning the learning.",
            "nullable":true,
            "x-queryable":true
        },
        "assignmentNotes":{
            "maxLength":4000,
            "type":"string",
            "description":"Notes from the person assigning the learning to the assigned learners.",
            "nullable":true,
            "x-queryable":true
        },
        "assignmentProfileDescription":{
            "maxLength":4000,
            "type":"string",
            "description":"Description for the learning assignment profile.",
            "nullable":true,
            "x-queryable":true
        },
        "assignmentProfileEndDate":{
            "type":"string",
            "description":"Date the processing of the learning assignment profile needs to complete.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "assignmentProfileId":{
            "type":"integer",
            "description":"Unique identifier of the assignment profile's details.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "assignmentProfileNumber":{
            "maxLength":30,
            "type":"string",
            "description":"User-friendly identifier for the profile linked to the learning assignment.",
            "nullable":true,
            "x-queryable":true
        },
        "assignmentProfileRecords":{
            "title":"Assignment Profiles",
            "type":"array",
            "description":"The assignment profile records associated with the learning assignment.",
            "items":{
                "$ref":"#/components/schemas/learningAssignmentProfiles-assignmentProfileRecords-item-response"
            }
        },
        "assignmentProfileStartDate":{
            "type":"string",
            "description":"Date the processing of the learning assignment profile needs to start.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "assignmentProfileStatus":{
            "maxLength":30,
            "type":"string",
            "description":"Status for the learning assignment profile.",
            "nullable":false,
            "x-queryable":true
        },
        "assignmentProfileStatusMeaning":{
            "maxLength":255,
            "type":"string",
            "description":"Description for the learning assignment profile status.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "assignmentProfileTitle":{
            "maxLength":250,
            "type":"string",
            "description":"Name of the learning assignment profile.",
            "nullable":true,
            "x-queryable":true
        },
        "assignmentRecordStatus":{
            "maxLength":30,
            "type":"string",
            "description":"The status of the learning assignment.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "assignmentRecordStatusMeaning":{
            "maxLength":255,
            "type":"string",
            "description":"Meaning associated with the learning assignment status.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "assignmentSubType":{
            "maxLength":30,
            "type":"string",
            "description":"Learning assignment subtype. Valid values include ORA_SELF and ORA_ADMIN.",
            "nullable":true,
            "x-queryable":true
        },
        "assignmentType":{
            "maxLength":30,
            "type":"string",
            "description":"Learning assignment type. Valid values are ORA_REQUIRE_ASSIGNMENT and ORA_JOIN_ASSIGNMENT.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "assignmentTypeMeaning":{
            "maxLength":255,
            "type":"string",
            "description":"Description associated with the assignment type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "completionComments":{
            "maxLength":4000,
            "type":"string",
            "description":"Comments provided when marking the learning assignment as completed.",
            "nullable":true,
            "x-queryable":true
        },
        "completionReasonCode":{
            "maxLength":30,
            "type":"string",
            "description":"Reason code for marking the learning assignment as completed.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "createdBy":{
            "maxLength":64,
            "type":"string",
            "description":"Name of the person who created the learning assignment profile.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "creationDate":{
            "type":"string",
            "description":"Date and time when the learning assignment profile was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "dataSecurityPrivilege":{
            "type":"string",
            "description":"Data security privilege for the role of the person accessing the learning assignment, such as Learner or Learner Manager. Valid values are defined in the DataSecurityPrivilegeLOV.",
            "nullable":true,
            "x-queryable":true
        },
        "dueInNumber":{
            "type":"number",
            "description":"Quantity for the measurement indicating when the renewal assignment is due, such as 30.",
            "nullable":true,
            "x-queryable":true
        },
        "dueInUOM":{
            "maxLength":255,
            "type":"string",
            "description":"Unit of measure for the quantity that identifies when the renewal assignment is due, such as days, months, or years",
            "nullable":true,
            "x-queryable":true
        },
        "dueMonth":{
            "maxLength":255,
            "type":"string",
            "description":"Month in which the renewal assignment is due.",
            "nullable":true,
            "x-queryable":true
        },
        "dueOnDay":{
            "type":"number",
            "description":"Day when the renewal assignment is due.",
            "nullable":true,
            "x-queryable":true
        },
        "enableRenewals":{
            "maxLength":255,
            "type":"string",
            "description":"Indicates whether the renewals are enabled on the learning assignment profile. Valid values are Y and N.",
            "nullable":true,
            "x-queryable":true
        },
        "excludeEnrollmentFromHistory":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the assignment needs to be hidden from the learner's transcript. Valid values are Y and N. When the value is Y, the assignment's status is set to ORA_ASSN_REC_DELETED. When the value is N, the assignment's status is set to ORA_ASSN_REC_WITHDRAWN.",
            "nullable":true,
            "x-queryable":true
        },
        "existingCompletionValidityRule":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates when the previous completion expires. Valid values are ORA_FORCE_RETAKE_EXP_COMPL_CD, ORA_FORCE_RETAKE_EXP_COMPL_DD, ORA_FORCE_RETAKE_EXP_COMPL_AD and ORA_FORCE_RETAKE_EXP_COMPL_RN.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "increaseMaximumCapacity":{
            "maxLength":64,
            "type":"string",
            "description":"Indicates whether the maximum capacity for the learning should be increased and the waitlist bypassed. Valid values are Y and N.",
            "nullable":true,
            "x-queryable":true
        },
        "lastModifiedDate":{
            "type":"string",
            "description":"Date when the learning assignment profile was most recently changed.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "lastProcessedDate":{
            "type":"string",
            "description":"Date when the learning assignment profile was most recently processed.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "learningAssignmentProfileCriteria":{
            "title":"Leaning Assignment Profile Criteria",
            "type":"array",
            "description":"The learningAssignmentProfileCriteria resource associates 1 or more learners with a learning item.",
            "items":{
                "$ref":"#/components/schemas/learningAssignmentProfiles-learningAssignmentProfileCriteria-item-response"
            }
        },
        "learningItem":{
            "title":"Noncatalog Learning Item",
            "type":"array",
            "description":"The learning item details required to create noncatalog requests or record external learning under the assignment profile.",
            "items":{
                "$ref":"#/components/schemas/learningAssignmentProfiles-learningItem-item-response"
            }
        },
        "learningItemCoverArtLink":{
            "maxLength":255,
            "type":"string",
            "description":"URL to open the learning item cover art directly from the browser.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "learningItemId":{
            "type":"integer",
            "description":"Unique identifier of the assigned learning item.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "learningItemNumber"
                ]
            },
            "x-queryable":true
        },
        "learningItemNumber":{
            "type":"string",
            "description":"Number given to the assigned learning item.",
            "nullable":true,
            "x-queryable":true
        },
        "learningItemSubTypeMeaning":{
            "maxLength":255,
            "type":"string",
            "description":"Description of the learningItemSubType attribute value.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "learningItemTitle":{
            "maxLength":250,
            "type":"string",
            "description":"Title of the learning item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "learningItemType":{
            "type":"string",
            "description":"Type of learning item. Valid values include ORA_COURSE, ORA_SPECIALIZATION, and ORA_LEGACY.",
            "nullable":true,
            "x-queryable":true
        },
        "learningItemTypeMeaning":{
            "maxLength":255,
            "type":"string",
            "description":"Meaning associated with the learning item code.",
            "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"
            }
        },
        "minimumDaysToComplete":{
            "type":"number",
            "description":"Minimum number of days to complete the learning assignment created in the subsequent run of the learning assignment profile, after it's assigned.",
            "nullable":true,
            "x-queryable":true
        },
        "ongoingAssignmentDueDate":{
            "type":"string",
            "description":"Due date for a learning assignment created in the subsequent run of the learning assignment profile.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "ongoingDueDateType":{
            "maxLength":30,
            "type":"string",
            "description":"Type of learning assignment due date for the subsequent run of the learning assignment profile. Valid values are ORA_RELATIVE_DATE and ORA_SPECIFIC_DATE.",
            "nullable":true,
            "x-queryable":true
        },
        "ongoingDueIn":{
            "type":"number",
            "description":"Number of days to complete the learning assignment created in the subsequent run of the learning assignment profile, after it's assigned.",
            "nullable":true,
            "x-queryable":true
        },
        "ongoingDueInUnits":{
            "maxLength":255,
            "type":"string",
            "description":"Unit of measure for the quantity that identifies when the learning assignment created in the subsequent run of the learning assignment profile is due, such as days, months, or years",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "processId":{
            "type":"integer",
            "description":"Unique identifier for the process.",
            "nullable":true,
            "x-queryable":true
        },
        "processingFrequency":{
            "maxLength":30,
            "type":"string",
            "description":"Processing frequency for the learning assignment profile.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "processingRule":{
            "maxLength":1,
            "type":"string",
            "description":"Processing rule for the assignment profile.",
            "nullable":false,
            "default":"N",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "purchaseOrderNumber":{
            "maxLength":30,
            "type":"string",
            "description":"Order number for purchasing the learning.",
            "nullable":true,
            "x-queryable":true
        },
        "reassignNumber":{
            "type":"number",
            "description":"Quantity for the measurement indicating when the learning assignment should be reassigned, such as 1.",
            "nullable":true,
            "x-queryable":true
        },
        "reassignOnDay":{
            "type":"number",
            "description":"Day when the renewal assignment should be created.",
            "nullable":true,
            "x-queryable":true
        },
        "reassignOnMonth":{
            "maxLength":30,
            "type":"string",
            "description":"Month when the renewal assignment should be created.",
            "nullable":true,
            "x-queryable":true
        },
        "reassignUOM":{
            "maxLength":30,
            "type":"string",
            "description":"Unit of measure for the quantity that identifies when the renewal assignment should be created, such as days, months, or years",
            "nullable":true,
            "x-queryable":true
        },
        "recommendationCategory":{
            "maxLength":30,
            "type":"string",
            "description":"Category code to which the learning assignment belongs.",
            "nullable":true,
            "x-queryable":true
        },
        "recommendationCategoryMeaning":{
            "maxLength":255,
            "type":"string",
            "description":"Meaning associated with the recommended learning category code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "relatedMaterials":{
            "title":"Related Materials",
            "type":"array",
            "description":"The relatedMaterials resource provides a list of related learning material for its parent resource. It's also used to add and remove related material.",
            "items":{
                "$ref":"#/components/schemas/learningAssignmentProfiles-relatedMaterials-item-response"
            }
        },
        "renewalOption":{
            "maxLength":30,
            "type":"string",
            "description":"Rule to identify the start date of the renewal assignment.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "renewalPeriod":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates when the learning assignment should be renewed. Valid values are ORA_ANNUAL_DUE_DATE and ORA_REL_TO_PRIOR_COMPLETION.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "requestedCompletionDate":{
            "type":"string",
            "description":"Requested date by when the learner should complete the related learning assignment.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "requestedStartDate":{
            "type":"string",
            "description":"Start date for the requested learning assignment.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "retakeInNumber":{
            "type":"number",
            "description":"Quantity for the measurement indicating when learners should retake the learning, such as 1.",
            "nullable":true,
            "x-queryable":true
        },
        "retakeInUnitOfMeasure":{
            "maxLength":30,
            "type":"string",
            "description":"Unit of measure for the quantity that identifies when learners should retake the learning, such as days, months, or years.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "retakeRule":{
            "maxLength":30,
            "type":"string",
            "description":"Rule indicating when learners should retake the learning again. Valid values are ORA_EXEMPT_LEARNING, ORA_RETAKE_LEARNING, ORA_RETAKE_WITH_EXEMPT_DATE and ORA_RETAKE_WITH_EXEMPT_BEFORE.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "retakeWhenCompletedBeforeDate":{
            "type":"string",
            "description":"Learners with assignment completions before this date need to retake the learning.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "runAsPersonId":{
            "type":"integer",
            "description":"Unique identifier of the person associated with the assignment profile.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "runAsPersonNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Friendly identifier for the person associated with the assignment profile.",
            "nullable":true,
            "x-queryable":true
        },
        "sourceId":{
            "title":"Enrollment Source Identifier",
            "type":"integer",
            "description":"Unique identifier for the source where this assignment was created.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "sourceType":{
            "title":"Enrollment Source Type",
            "maxLength":30,
            "type":"string",
            "description":"Type for the source where this assignment was created, such as Recommendation or Search.",
            "nullable":true,
            "x-queryable":true
        },
        "statusChangeComments":{
            "maxLength":400,
            "type":"string",
            "description":"Status change comment for the learning assignment.",
            "nullable":true,
            "x-queryable":true
        },
        "statusChangeReasonCode":{
            "maxLength":30,
            "type":"string",
            "description":"Reason code for the learning assignment status change.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "targetAssignmentStatus":{
            "maxLength":30,
            "type":"string",
            "description":"Status to set for the learning assignment.",
            "nullable":true,
            "x-queryable":true
        },
        "validityPeriodBeginRule":{
            "maxLength":30,
            "type":"string",
            "description":"Rule identifying when the validity period for the completed learning assignment starts..",
            "nullable":true,
            "x-queryable":true
        },
        "validityPeriodExpiryDay":{
            "type":"number",
            "description":"Day when the learning assignment validity should expire.",
            "nullable":true,
            "x-queryable":true
        },
        "validityPeriodExpiryFrom":{
            "maxLength":30,
            "type":"string",
            "description":"Rule to calculate when he learning assignment's validity period should expire.",
            "nullable":true,
            "x-queryable":true
        },
        "validityPeriodExpiryMonth":{
            "maxLength":255,
            "type":"string",
            "description":"Month in which the learning assignment validity should expire.",
            "nullable":true,
            "x-queryable":true
        },
        "validityPeriodExpiryNumber":{
            "type":"number",
            "description":"Quantity for the measurement indicating when the learning assignment expires, such as 1.",
            "nullable":true,
            "x-queryable":true
        },
        "validityPeriodExpiryRule":{
            "maxLength":255,
            "type":"string",
            "description":"Rule that identifies when the learning assignment's validity period expires. Valid values are ORA_EXP_NEVER, ORA_EXP_ DATE and ORA_EXP_RELATIVE_DATE.",
            "nullable":true,
            "x-queryable":true
        },
        "validityPeriodExpiryUOM":{
            "maxLength":30,
            "type":"string",
            "description":"Unit of measure for the quantity that identifies when the learning assignment expires.",
            "nullable":true,
            "x-queryable":true
        },
        "waiveComments":{
            "maxLength":4000,
            "type":"string",
            "description":"Comments provided when waiving prerequisites for the assignments.",
            "nullable":true,
            "x-queryable":true
        },
        "waivePrerequisites":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the prerequisites need to be waived while creating learning assignments. Valid values are Y or N.",
            "nullable":true,
            "default":"N",
            "x-queryable":true
        },
        "waiveReasonCode":{
            "maxLength":30,
            "type":"string",
            "description":"Reason for waiving assignment prerequisites.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "withdrawOnProcessing":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates whether the assignment needs to be withdrawn for learners who are no longer part of the assignment profile audience. Valid values are Y or N.",
            "nullable":true,
            "default":"Y",
            "x-queryable":true
        }
    }
}

Nested Schema : assignmentDFF

Type: array

Show Source

• Array of: object learningAssignmentProfiles-assignmentDFF-item-response

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/learningAssignmentProfiles-assignmentDFF-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : Assignment Profiles

Type: array

Title: Assignment Profiles

The assignment profile records associated with the learning assignment.

Show Source

• Array of: object learningAssignmentProfiles-assignmentProfileRecords-item-response

{
    "title":"Assignment Profiles",
    "type":"array",
    "description":"The assignment profile records associated with the learning assignment.",
    "items":{
        "$ref":"#/components/schemas/learningAssignmentProfiles-assignmentProfileRecords-item-response"
    }
}

Nested Schema : Leaning Assignment Profile Criteria

Type: array

Title: Leaning Assignment Profile Criteria

The learningAssignmentProfileCriteria resource associates 1 or more learners with a learning item.

Show Source

• Array of: object learningAssignmentProfiles-learningAssignmentProfileCriteria-item-response

{
    "title":"Leaning Assignment Profile Criteria",
    "type":"array",
    "description":"The learningAssignmentProfileCriteria resource associates 1 or more learners with a learning item.",
    "items":{
        "$ref":"#/components/schemas/learningAssignmentProfiles-learningAssignmentProfileCriteria-item-response"
    }
}

Nested Schema : Noncatalog Learning Item

Type: array

Title: Noncatalog Learning Item

The learning item details required to create noncatalog requests or record external learning under the assignment profile.

Show Source

• Array of: object learningAssignmentProfiles-learningItem-item-response

{
    "title":"Noncatalog Learning Item",
    "type":"array",
    "description":"The learning item details required to create noncatalog requests or record external learning under the assignment profile.",
    "items":{
        "$ref":"#/components/schemas/learningAssignmentProfiles-learningItem-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 : Related Materials

Type: array

Title: Related Materials

The relatedMaterials resource provides a list of related learning material for its parent resource. It's also used to add and remove related material.

Show Source

• Array of: object learningAssignmentProfiles-relatedMaterials-item-response

{
    "title":"Related Materials",
    "type":"array",
    "description":"The relatedMaterials resource provides a list of related learning material for its parent resource. It's also used to add and remove related material.",
    "items":{
        "$ref":"#/components/schemas/learningAssignmentProfiles-relatedMaterials-item-response"
    }
}

Nested Schema : learningAssignmentProfiles-assignmentDFF-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 30

  Context Segment
• __FLEX_Context_DisplayValue: string
  Title: Context Segment

  Context Segment
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• RequestDetailId: integer (int64)

{
    "type":"object",
    "properties":{
        "RequestDetailId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":30,
            "type":"string",
            "description":"Context Segment",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "description":"Context Segment",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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

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

Type: object

Show Source

• assignmentProfileCriteriaCount: integer
  Read Only: true

  Count of learners who are part of the learning assignment profile audience criteria.
• assignmentProfileCriteriaId: integer (int64)
  Unique identifier for the assignment profile criteria details.
• assignmentProfileCriteriaSourceName: string
  Maximum Length: 255

  Name of the source associated with the learning assignment profile audience criteria.
• assignmentProfileCriteriaType: string
  Maximum Length: 30

  Type of learner.
• assignmentProfileCriteriaTypeId: integer (int64)
  The unique identifier of the learner that the learning is being assigned to.
• assignmentProfileCriteriaTypeMeaning: string
  Read Only: true

  Maximum Length: 255

  Description for the type of criteria.
• assignmentProfileCriteriaTypeNumber: string
  Maximum Length: 255

  Friendly number for the criteria.
• assignmentProfileId: integer (int64)
  Unique identifier of the assignment profile's details.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• personAttachment: array Learning Contributor Person List Attachment
  Title: Learning Contributor Person List Attachment

  The personAttachment resource is used to attach the list of person IDs or person emails for the recipients getting assignments generated by the specified assignment profile.
• reportName: string
  Maximum Length: 255

  Name of the analysis report.

{
    "type":"object",
    "properties":{
        "assignmentProfileCriteriaCount":{
            "type":"integer",
            "description":"Count of learners who are part of the learning assignment profile audience criteria.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "assignmentProfileCriteriaId":{
            "type":"integer",
            "description":"Unique identifier for the assignment profile criteria details.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "assignmentProfileCriteriaSourceName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the source associated with the learning assignment profile audience criteria.",
            "nullable":true,
            "x-queryable":true
        },
        "assignmentProfileCriteriaType":{
            "maxLength":30,
            "type":"string",
            "description":"Type of learner.",
            "nullable":true,
            "x-queryable":true
        },
        "assignmentProfileCriteriaTypeId":{
            "type":"integer",
            "description":"The unique identifier of the learner that the learning is being assigned to.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "assignmentProfileCriteriaTypeMeaning":{
            "maxLength":255,
            "type":"string",
            "description":"Description for the type of criteria.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "assignmentProfileCriteriaTypeNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Friendly number for the criteria.",
            "nullable":true,
            "x-queryable":true
        },
        "assignmentProfileId":{
            "type":"integer",
            "description":"Unique identifier of the assignment profile's details.",
            "format":"int64",
            "nullable":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"
            }
        },
        "personAttachment":{
            "title":"Learning Contributor Person List Attachment",
            "type":"array",
            "description":"The personAttachment resource is used to attach the list of person IDs or person emails for the recipients getting assignments generated by the specified assignment profile.",
            "items":{
                "$ref":"#/components/schemas/learningAssignmentProfiles-learningAssignmentProfileCriteria-personAttachment-item-response"
            },
            "x-cardinality":"1"
        },
        "reportName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the analysis report.",
            "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 : Learning Contributor Person List Attachment

Type: array

Title: Learning Contributor Person List Attachment

The personAttachment resource is used to attach the list of person IDs or person emails for the recipients getting assignments generated by the specified assignment profile.

Show Source

• Array of: object learningAssignmentProfiles-learningAssignmentProfileCriteria-personAttachment-item-response

{
    "title":"Learning Contributor Person List Attachment",
    "type":"array",
    "description":"The personAttachment resource is used to attach the list of person IDs or person emails for the recipients getting assignments generated by the specified assignment profile.",
    "items":{
        "$ref":"#/components/schemas/learningAssignmentProfiles-learningAssignmentProfileCriteria-personAttachment-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : learningAssignmentProfiles-learningAssignmentProfileCriteria-personAttachment-item-response

Type: object

Show Source

• AsyncTrackerId: string
  Title: Asynchronous Upload Tracker Id

  Attribute provided by the Attachment UI components to support the upload of files.
• AttachedDocumentId: integer (int64)
  Title: Attached Document Id

  Unique identifier of the attached document.
• CategoryName: string
  Title: Category

  Maximum Length: 30

  Category name of the attachment. This is a read-only attribute.
• ContentRepositoryFileShared: boolean
  Title: Shared

  Indicates whether the file can be shared. The default value is false and it's the only supported value.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 255

  Attachment creator.
• CreatedByUserName: string
  Title: Created By User Name

  Read Only: true

  User name of the attachment creator.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  Date when the attachment was created.
• DatatypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: FILE

  Attachment Type such as FILE or TEXT, or WEB_PAGE.
• Description: string
  Title: Description

  Maximum Length: 255

  Description for the attachment.
• DmDocumentId: string
  Maximum Length: 255

  Surrogate identifier for the document attached.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  Folder path where the attachment will be created.
• DmVersionNumber: string
  Maximum Length: 255

  Version number for the attachment.
• DownloadInfo: string
  Title: DownloadInfo

  JSON object represented as a string that contains information used to programmatically retrieve a file attachment.
• ErrorStatusCode: string
  Title: Error Status Code

  Error status code, if any, for the attachment.
• ErrorStatusMessage: string
  Title: Error Status Message

  Expiration date for the attachment. This is a read-only attribute.
• ExpirationDate: string (date-time)
  Title: Expiration Date

  Expiration date of the attachment. This is a read-only attribute.
• FileContents: string (byte)
  Title: File Contents

  Actual content of the attachment.
• FileName: string
  Title: File Name

  Maximum Length: 2048

  Name for the attachment file.
• FileUrl: string
  Title: File Url

  File URL for the attachment.
• FileWebImage: string (byte)
  Title: File Web Image

  Read Only: true

  Base64 encoded image file displayed in .png format when the source is a convertible image.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  Date when attachment record was most recently updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 255

  Name of the person who most recently updated the attachment record.
• LastUpdatedByUserName: string
  Title: Last Updated By User

  Read Only: true

  User name of the person who most recently updated the attachment.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PostProcessingAction: string
  Title: PostProcessingAction

  Name of the action that can be done after an attachment is uploaded.
• Title: string
  Title: Title

  Title of the attachment.
• UploadedFileContentType: string
  Title: Uploaded File Content Type

  Content type of the uploaded file. This is a read-only attribute.
• UploadedFileLength: integer
  Title: File Size

  Size of the uploaded file. This is a read-only attribute.
• UploadedFileName: string
  Title: Uploaded File Name

  Name of the uploaded file. This is a read-only attribute.
• UploadedText: string
  Title: Uploaded Text

  Text uploaded in the attachment.
• Uri: string
  Title: Uri

  Maximum Length: 4000

  URI for the attachment. This is a read-only attribute.
• Url: string
  Title: Url

  Maximum Length: 4000

  URL for a web page type attachment.
• UserName: string
  Title: User Name

  Read Only: true

  Maximum Length: 255

  User name of the person who uploaded the attachment.

{
    "type":"object",
    "properties":{
        "AsyncTrackerId":{
            "title":"Asynchronous Upload Tracker Id",
            "type":"string",
            "description":"Attribute provided by the Attachment UI components to support the upload of files.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            }
        },
        "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
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"Category name of the attachment. This is a read-only attribute.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Indicates whether the file can be shared. The default value is false and it's the only supported value.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":255,
            "type":"string",
            "description":"Attachment creator.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "CreatedByUserName":{
            "title":"Created By User Name",
            "type":"string",
            "description":"User name of the attachment creator.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date when the attachment was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"Attachment Type such as FILE or TEXT, or WEB_PAGE.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":255,
            "type":"string",
            "description":"Description for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmDocumentId":{
            "maxLength":255,
            "type":"string",
            "description":"Surrogate identifier for the document attached.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":1000,
            "type":"string",
            "description":"Folder path where the attachment will be created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DmVersionNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Version number for the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"JSON object represented as a string that contains information used to programmatically retrieve a file attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"Error status code, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"Expiration date for the attachment. This is a read-only attribute.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"Expiration date of the attachment. This is a read-only attribute.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"Actual content of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":2048,
            "type":"string",
            "description":"Name for the attachment file.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"File URL for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileWebImage":{
            "title":"File Web Image",
            "type":"string",
            "description":"Base64 encoded image file displayed in .png format when the source is a convertible image.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide",
                "PAYLOADHINT":"Show"
            }
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"Date when attachment record was most recently updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "FMT_FORMAT":"d-MMM-yyyy HH:mm:ss"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":255,
            "type":"string",
            "description":"Name of the person who most recently updated the attachment record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "LastUpdatedByUserName":{
            "title":"Last Updated By User",
            "type":"string",
            "description":"User name of the person who most recently updated the attachment.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "PostProcessingAction":{
            "title":"PostProcessingAction",
            "type":"string",
            "description":"Name of the action that can be done 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"
            }
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"Content type of the uploaded file. This is a read-only attribute.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"Size of the uploaded file. This is a read-only attribute.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"Name of the uploaded file. This is a read-only attribute.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"Text uploaded in the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":4000,
            "type":"string",
            "description":"URI for the attachment. This is a read-only attribute.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "Url":{
            "title":"Url",
            "maxLength":4000,
            "type":"string",
            "description":"URL for a web page type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "UserName":{
            "title":"User Name",
            "maxLength":255,
            "type":"string",
            "description":"User name of the person who uploaded the attachment.",
            "nullable":false,
            "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"
            }
        }
    }
}

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

Type: object

Show Source

• actualCpeUnits: number
  Title: Actual CPE Units

  Continuing professional education units that the learner achieved for this assignment.
• learningItemCpeType: string
  Title: Learning Item CPE Type

  Maximum Length: 30

  Continuing professional education type for the learning item. Valid values are defined in the CpeTypeLOV list.
• learningItemCpeTypeMeaning: string
  Read Only: true

  Maximum Length: 255

  Description of the continuing professional education type for the learning item.
• learningItemDescription: string
  Maximum Length: 4000

  Description of the learning item.
• learningItemDFF: array learningItemDFF
• learningItemExpectedEffort: number
  Expected effort to complete the learning item
• learningItemExpectedEffortInSeconds: number
  Expected effort, in seconds, to complete the assigned learning item.
• learningItemExpectedEffortUnits: string
  Maximum Length: 30

  Default Value: ORA_DUR_HOUR

  Unit of measurement for the expected and actual effort to complete the learning item, such as day, hour, minute. Valid values are defined in the list EffortUnitsLOV.
• learningItemExpectedEffortUnitsMeaning: string
  Read Only: true

  Maximum Length: 255

  Description of expected effort units of measure.
• learningItemId: integer (int64)
  Unique identifier of the assigned learning item.
• learningItemNumber: string
  Maximum Length: 2000

  Number given to the assigned learning item.
• learningItemPrice: number
  Cost
• learningItemPriceCurrency: string
  Maximum Length: 30

  Currency of the price for the learning item. Valid values are defined in the list PriceCurrencyLOVVA.
• learningItemSubType: string
  Maximum Length: 30

  Learning item subtype, such as Video or Tutorial. Valid values are defined in the AssignedLearningItemSubTypeLOV list.
• learningItemSubTypeMeaning: string
  Read Only: true

  Maximum Length: 255

  Description of the learning item subtype.
• learningItemTitle: string
  Maximum Length: 250

  Title of the learning item.
• learningItemType: string
  Maximum Length: 32

  Learning item type, such as Course, Specialization, Tutorial, Video, or eLearning. Valid values are defined in the list AssignedLearningItemTypeLOV.
• learningItemTypeMeaning: string
  Read Only: true

  Maximum Length: 255

  Meaning associated with the learning item type.
• learningItemURL: string
  Maximum Length: 4000

  URL that can be used to embed the learning item page in other pages.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "actualCpeUnits":{
            "title":"Actual CPE Units",
            "type":"number",
            "description":"Continuing professional education units that the learner achieved for this assignment.",
            "nullable":true,
            "x-queryable":true
        },
        "learningItemCpeType":{
            "title":"Learning Item CPE Type",
            "maxLength":30,
            "type":"string",
            "description":"Continuing professional education type for the learning item. Valid values are defined in the CpeTypeLOV list.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "learningItemCpeTypeMeaning":{
            "maxLength":255,
            "type":"string",
            "description":"Description of the continuing professional education type for the learning item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "learningItemDFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/learningAssignmentProfiles-learningItem-learningItemDFF-item-response"
            },
            "x-cardinality":"1"
        },
        "learningItemDescription":{
            "maxLength":4000,
            "type":"string",
            "description":"Description of the learning item.",
            "nullable":true,
            "x-queryable":true
        },
        "learningItemExpectedEffort":{
            "type":"number",
            "description":"Expected effort to complete the learning item",
            "nullable":true,
            "x-queryable":true
        },
        "learningItemExpectedEffortInSeconds":{
            "type":"number",
            "description":"Expected effort, in seconds, to complete the assigned learning item.",
            "nullable":true,
            "x-queryable":true
        },
        "learningItemExpectedEffortUnits":{
            "maxLength":30,
            "type":"string",
            "description":"Unit of measurement for the expected and actual effort to complete the learning item, such as day, hour, minute. Valid values are defined in the list EffortUnitsLOV.",
            "nullable":true,
            "default":"ORA_DUR_HOUR",
            "x-queryable":true
        },
        "learningItemExpectedEffortUnitsMeaning":{
            "maxLength":255,
            "type":"string",
            "description":"Description of expected effort units of measure.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "learningItemId":{
            "type":"integer",
            "description":"Unique identifier of the assigned learning item.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "learningItemNumber":{
            "maxLength":2000,
            "type":"string",
            "description":"Number given to the assigned learning item.",
            "nullable":false,
            "x-queryable":true
        },
        "learningItemPrice":{
            "type":"number",
            "description":"Cost",
            "nullable":true,
            "x-queryable":true
        },
        "learningItemPriceCurrency":{
            "maxLength":30,
            "type":"string",
            "description":"Currency of the price for the learning item. Valid values are defined in the list PriceCurrencyLOVVA.",
            "nullable":true,
            "x-queryable":true
        },
        "learningItemSubType":{
            "maxLength":30,
            "type":"string",
            "description":"Learning item subtype, such as Video or Tutorial. Valid values are defined in the AssignedLearningItemSubTypeLOV list.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "learningItemSubTypeMeaning":{
            "maxLength":255,
            "type":"string",
            "description":"Description of the learning item subtype.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "learningItemTitle":{
            "maxLength":250,
            "type":"string",
            "description":"Title of the learning item.",
            "nullable":true,
            "x-queryable":true
        },
        "learningItemType":{
            "maxLength":32,
            "type":"string",
            "description":"Learning item type, such as Course, Specialization, Tutorial, Video, or eLearning. Valid values are defined in the list AssignedLearningItemTypeLOV.",
            "nullable":false,
            "x-queryable":true
        },
        "learningItemTypeMeaning":{
            "maxLength":255,
            "type":"string",
            "description":"Meaning associated with the learning item type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "learningItemURL":{
            "maxLength":4000,
            "type":"string",
            "description":"URL that can be used to embed the learning item page in other pages.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : learningItemDFF

Type: array

Show Source

• Array of: object learningAssignmentProfiles-learningItem-learningItemDFF-item-response

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/learningAssignmentProfiles-learningItem-learningItemDFF-item-response"
    },
    "x-cardinality":"1"
}

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

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 30

  Context Segment
• __FLEX_Context_DisplayValue: string
  Title: Context Segment

  Context Segment
• EffectiveEndDate: string (date)
• EffectiveStartDate: string (date)
• LearningItemId: integer (int64)
• LearningItemType: string
  Maximum Length: 32
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "EffectiveEndDate":{
            "type":"string",
            "format":"date",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "EffectiveStartDate":{
            "type":"string",
            "format":"date",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "LearningItemId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "LearningItemType":{
            "maxLength":32,
            "type":"string",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":30,
            "type":"string",
            "description":"Context Segment",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"HIDDEN"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "description":"Context Segment",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"HIDDEN"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• relatedMaterialsBinaries: array Attachments
  Title: Attachments

  The attachments resource is used to view, create, and update attachments.
• visibility: string
  Maximum Length: 80

  Determines who can view or edit the attachments, such as Administrators, Administrators and Enrollees, or Administrators and Self Service.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "relatedMaterialsBinaries":{
            "title":"Attachments",
            "type":"array",
            "description":"The attachments resource is used to view, create, and update attachments.",
            "items":{
                "$ref":"#/components/schemas/learningAssignmentProfiles-relatedMaterials-relatedMaterialsBinaries-item-response"
            }
        },
        "visibility":{
            "maxLength":80,
            "type":"string",
            "description":"Determines who can view or edit the attachments, such as Administrators, Administrators and Enrollees, or Administrators and Self Service.",
            "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 : Attachments

Type: array

Title: Attachments

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

Show Source

• Array of: object learningAssignmentProfiles-relatedMaterials-relatedMaterialsBinaries-item-response

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

Nested Schema : learningAssignmentProfiles-relatedMaterials-relatedMaterialsBinaries-item-response

Type: object

Show Source

• AsyncTrackerId: string
  Title: Asynchronous Upload Tracker Id

  Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.
• AttachedDocumentId: integer (int64)
  Title: Attached Document Id

  The unique identifier of the attached document.
• CategoryName: string
  Title: Category

  Maximum Length: 30

  The 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

  The user who created the record.
• CreatedByUserName: string
  Title: Created By User Name

  Read Only: true

  The user name who created the record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the record was created.
• DatatypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: FILE

  A value that indicates the data type.
• Description: string
  Title: Description

  Maximum Length: 255

  The description of the attachment.
• DmDocumentId: string
  Maximum Length: 255

  The document ID from which the attachment is created.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  The folder path from which the attachment is created.
• DmVersionNumber: string
  Maximum Length: 255

  The document version number from which the attachment is created.
• 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

  The error code, if any, for the attachment.
• ErrorStatusMessage: string
  Title: Error Status Message

  The error message, if any, for the attachment.
• ExpirationDate: string (date-time)
  Title: Expiration Date

  The expiration date of the contents in the attachment.
• FileContents: string (byte)
  Title: File Contents

  The contents of the attachment.
• FileName: string
  Title: File Name

  Maximum Length: 2048

  The file name of the attachment.
• FileUrl: string
  Title: File Url

  The URI of the file.
• FileWebImage: string (byte)
  Title: File Web Image

  Read Only: true

  The 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

  The date when the record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 255

  The user who last updated the record.
• LastUpdatedByUserName: string
  Title: Last Updated By User

  Read Only: true

  The user name who last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PostProcessingAction: string
  Title: PostProcessingAction

  The name of the action that can be performed after an attachment is uploaded.
• Title: string
  Title: Title

  The title of the attachment.
• UploadedFileContentType: string
  Title: Uploaded File Content Type

  The content type of the attachment.
• UploadedFileLength: integer
  Title: File Size

  The size of the attachment file.
• UploadedFileName: string
  Title: Uploaded File Name

  The name to assign to a new attachment file.
• UploadedText: string
  Title: Uploaded Text

  The text content for a new text attachment.
• Uri: string
  Title: Uri

  Maximum Length: 4000

  The URI of a Topology Manager type attachment.
• Url: string
  Title: Url

  Maximum Length: 4000

  The URL of a web page type attachment.
• UserName: string
  Title: User Name

  Read Only: true

  Maximum Length: 255

  The login credentials of the user who created the attachment.

{
    "type":"object",
    "properties":{
        "AsyncTrackerId":{
            "title":"Asynchronous Upload Tracker Id",
            "type":"string",
            "description":"Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            }
        },
        "AttachedDocumentId":{
            "title":"Attached Document Id",
            "type":"integer",
            "description":"The 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
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"The category of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "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"
            }
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":255,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "CreatedByUserName":{
            "title":"Created By User Name",
            "type":"string",
            "description":"The user name who created the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"A value that indicates the data type.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":255,
            "type":"string",
            "description":"The description of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmDocumentId":{
            "maxLength":255,
            "type":"string",
            "description":"The document ID from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":1000,
            "type":"string",
            "description":"The folder path from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DmVersionNumber":{
            "maxLength":255,
            "type":"string",
            "description":"The document version number from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "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"
            }
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"The error code, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"The error message, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The expiration date of the contents in the attachment.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"The contents of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":2048,
            "type":"string",
            "description":"The file name of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"The URI of the file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileWebImage":{
            "title":"File Web Image",
            "type":"string",
            "description":"The 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"
            }
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The 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
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":255,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "LastUpdatedByUserName":{
            "title":"Last Updated By User",
            "type":"string",
            "description":"The user name who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "PostProcessingAction":{
            "title":"PostProcessingAction",
            "type":"string",
            "description":"The 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":"The title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"The content type of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"The size of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"The name to assign to a new attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"The text content for a new text attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":4000,
            "type":"string",
            "description":"The 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":"The URL of a web page type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "UserName":{
            "title":"User Name",
            "maxLength":255,
            "type":"string",
            "description":"The login credentials of the user who created the attachment.",
            "nullable":false,
            "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"
            }
        }
    }
}

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

Links

assignAsLOVVA

Operation: /fscmRestApi/resources/11.13.18.05/commonLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_WLF_ASSIGN_ATTR_LOOKUP

The following properties are defined on the LOV link relation:

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

assignmentDFF

Operation: /hcmRestApi/resources/11.13.18.05/learningAssignmentProfiles/{learningAssignmentProfilesUniqID}/child/assignmentDFF

Parameters:

• learningAssignmentProfilesUniqID: $request.path.learningAssignmentProfilesUniqID

assignmentDueInUnitsVA

Operation: /fscmRestApi/resources/11.13.18.05/commonLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_WLF_ASSGN_RULE_UOM

The following properties are defined on the LOV link relation:

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

assignmentProfileRecords

Operation: /hcmRestApi/resources/11.13.18.05/learningAssignmentProfiles/{learningAssignmentProfilesUniqID}/child/assignmentProfileRecords

Parameters:

• learningAssignmentProfilesUniqID: $request.path.learningAssignmentProfilesUniqID

The assignment profile records associated with the learning assignment.

assignmentRecordStatusLookupLOVVA

Operation: /fscmRestApi/resources/11.13.18.05/commonLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_INITIAL_ASSGN_STATUS

The following properties are defined on the LOV link relation:

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

assignmentTypeVA

Operation: /fscmRestApi/resources/11.13.18.05/commonLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_WLF_ENROLLMENT_TYPE

The following properties are defined on the LOV link relation:

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

existingCompletionValidityRuleVA

Operation: /fscmRestApi/resources/11.13.18.05/commonLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_WLF_ASSGN_CMPL_CONF_RULES

The following properties are defined on the LOV link relation:

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

learningAssignmentProfileCriteria

Operation: /hcmRestApi/resources/11.13.18.05/learningAssignmentProfiles/{learningAssignmentProfilesUniqID}/child/learningAssignmentProfileCriteria

Parameters:

• learningAssignmentProfilesUniqID: $request.path.learningAssignmentProfilesUniqID

The learningAssignmentProfileCriteria resource associates 1 or more learners with a learning item.

learningItem

Operation: /hcmRestApi/resources/11.13.18.05/learningAssignmentProfiles/{learningAssignmentProfilesUniqID}/child/learningItem

Parameters:

• learningAssignmentProfilesUniqID: $request.path.learningAssignmentProfilesUniqID

The learning item details required to create noncatalog requests or record external learning under the assignment profile.

ongoingDueInUnitsVA

Operation: /fscmRestApi/resources/11.13.18.05/commonLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_WLF_ASSGN_RULE_UOM

The following properties are defined on the LOV link relation:

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

process

Operation: /hcmRestApi/resources/11.13.18.05/learningAssignmentProfiles/{learningAssignmentProfilesUniqID}/action/process

Parameters:

• learningAssignmentProfilesUniqID: $request.path.learningAssignmentProfilesUniqID

Processes the learning assignment profile and creates or updates the learning assignments.

processingFrequencyLOVVA

Operation: /fscmRestApi/resources/11.13.18.05/commonLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_WLF_LRN_ASSGN_PROCESS_FREQ

The following properties are defined on the LOV link relation:

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

processingRuleVA

Operation: /fscmRestApi/resources/11.13.18.05/commonLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_WLF_ASSGN_PROCESS_RULE

The following properties are defined on the LOV link relation:

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

relatedMaterials

Operation: /hcmRestApi/resources/11.13.18.05/learningAssignmentProfiles/{learningAssignmentProfilesUniqID}/child/relatedMaterials

Parameters:

• learningAssignmentProfilesUniqID: $request.path.learningAssignmentProfilesUniqID

The relatedMaterials resource provides a list of related learning material for its parent resource. It's also used to add and remove related material.

renewalOptionVA

Operation: /fscmRestApi/resources/11.13.18.05/commonLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_WLF_ASSGN_RENEWAL_OPTIONS

The following properties are defined on the LOV link relation:

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

renewalPeriodVA

Operation: /fscmRestApi/resources/11.13.18.05/commonLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_WLF_ASSGN_RENEWAL_PERIOD

The following properties are defined on the LOV link relation:

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

retakeInUnitOfMeasureVA

Operation: /fscmRestApi/resources/11.13.18.05/commonLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_WLF_ASSGN_RETAKE_UOM

The following properties are defined on the LOV link relation:

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

statusChangeReasonCodeLOVVA

Operation: /fscmRestApi/resources/11.13.18.05/commonLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_WLF_ASSGN_PRF_CNCL_LOOKUP

The following properties are defined on the LOV link relation:

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

Back to Top