Jump to

• Request
• Response

Update an external course

patch

/fscmRestApi/resources/11.13.18.05/externalOrganizations/{PartyId}/child/externalCourses/{ExternalCourseRowId}

Request

Path Parameters

• ExternalCourseRowId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
• PartyId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

Header Parameters

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

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• ActiveFlag: boolean
  Maximum Length: 1

  Indicates whether the subject is active or inactive.
• CourseIdentifier: string
  Maximum Length: 50

  Alternate unique identifier for the course defined for an external organization.
• CourseLevelCode: string
  Maximum Length: 30

  The course level code. A list of accepted values is defined in the lookup type ORA_HER_EXT_COURSE_LEVEL.
• CourseName: string
  Maximum Length: 50

  The name for the external course.
• CourseTypeCode: string
  Maximum Length: 30

  The course type code. A list of accepted values is defined in the lookup type ORA_HER_EXT_COURSE_TYPE.
• CourseUnits: number
  The number of units earned in the course.
• Description: string
  Description for the external course.
• EffectiveEndDate: string (date)
  Date Effective Entity: indicates the date at the beginning of the date range within which the row is effective.
• EffectiveStartDate: string (date)
  Date Effective Entity: indicates the date at the end of the date range within which the row is effective.
• ExternalAcademicLevelCode: string
  Maximum Length: 30

  The external academic level code. A list of accepted values is defined in the lookup type ORA_HER_EXT_ACAD_LEVEL.
• ExternalCourseRowId: integer (int64)
  External subject unique identifier.
• ExternalSubjectId: integer (int64)
  External subject unique identifier.
• OrganizationId: integer (int64)
  External organization unique identifier that owns this subject.

{
    "type":"object",
    "properties":{
        "CourseName":{
            "maxLength":"50",
            "type":"string",
            "description":"The name for the external course.",
            "nullable":false
        },
        "Description":{
            "type":"string",
            "description":"Description for the external course.",
            "nullable":true
        },
        "EffectiveEndDate":{
            "type":"string",
            "description":"Date Effective Entity: indicates the date at the beginning of the date range within which the row is effective.",
            "format":"date",
            "nullable":false
        },
        "ExternalCourseRowId":{
            "type":"integer",
            "description":"External subject unique identifier.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "CourseTypeCode":{
            "maxLength":"30",
            "type":"string",
            "description":"The course type code. A list of accepted values is defined in the lookup type ORA_HER_EXT_COURSE_TYPE.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CourseLevelCode":{
            "maxLength":"30",
            "type":"string",
            "description":"The course level code. A list of accepted values is defined in the lookup type ORA_HER_EXT_COURSE_LEVEL.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "OrganizationId":{
            "type":"integer",
            "description":"External organization unique identifier that owns this subject.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "CourseIdentifier":{
            "maxLength":"50",
            "type":"string",
            "description":"Alternate unique identifier for the course defined for an external organization.",
            "nullable":false
        },
        "ActiveFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the subject is active or inactive.",
            "nullable":false
        },
        "CourseUnits":{
            "type":"number",
            "description":"The number of units earned in the course.",
            "nullable":true,
            "x-hints":{
                "precision":"3",
                "scale":"2"
            }
        },
        "ExternalAcademicLevelCode":{
            "maxLength":"30",
            "type":"string",
            "description":"The external academic level code. A list of accepted values is defined in the lookup type ORA_HER_EXT_ACAD_LEVEL.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "EffectiveStartDate":{
            "type":"string",
            "description":"Date Effective Entity: indicates the date at the end of the date range within which the row is effective.",
            "format":"date",
            "nullable":false
        },
        "ExternalSubjectId":{
            "type":"integer",
            "description":"External subject unique identifier.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        }
    }
}

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 : externalOrganizations-externalCourses-item-response

Type: object

Show Source

• ActiveFlag: boolean
  Maximum Length: 1

  Indicates whether the subject is active or inactive.
• CourseIdentifier: string
  Maximum Length: 50

  Alternate unique identifier for the course defined for an external organization.
• CourseLevelCode: string
  Maximum Length: 30

  The course level code. A list of accepted values is defined in the lookup type ORA_HER_EXT_COURSE_LEVEL.
• CourseLevelMeaning: string
  Read Only: true

  Maximum Length: 80

  The course level meaning. A list of accepted values is defined in the lookup type ORA_HER_EXT_COURSE_LEVEL.
• CourseName: string
  Maximum Length: 50

  The name for the external course.
• CourseTypeCode: string
  Maximum Length: 30

  The course type code. A list of accepted values is defined in the lookup type ORA_HER_EXT_COURSE_TYPE.
• CourseTypeMeaning: string
  Read Only: true

  Maximum Length: 80

  The course type meaning. A list of accepted values is defined in the lookup type ORA_HER_EXT_COURSE_TYPE.
• CourseUnits: number
  The number of units earned in the course.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who first created the row for the identifier.
• CreationDate: string (date-time)
  Read Only: true

  The date and time of the creation of the row for the identifier.
• Description: string
  Description for the external course.
• EffectiveEndDate: string (date)
  Date Effective Entity: indicates the date at the beginning of the date range within which the row is effective.
• EffectiveStartDate: string (date)
  Date Effective Entity: indicates the date at the end of the date range within which the row is effective.
• ExternalAcademicLevelCode: string
  Maximum Length: 30

  The external academic level code. A list of accepted values is defined in the lookup type ORA_HER_EXT_ACAD_LEVEL.
• ExternalAcademicLevelMeaning: string
  Read Only: true

  Maximum Length: 80

  The external academic level meaning. A list of accepted values is defined in the lookup type ORA_HER_EXT_ACAD_LEVEL.
• ExternalCourseId: integer (int64)
  External subject unique identifier.
• ExternalCourseRowId: integer (int64)
  External subject unique identifier.
• ExternalSubjectId: integer (int64)
  External subject unique identifier.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OrganizationId: integer (int64)
  External organization unique identifier that owns this subject.
• SubjectCode: string
  Read Only: true

  Maximum Length: 50

  The external subject defined for an external organization associated with the external course.

{
    "type":"object",
    "properties":{
        "CourseName":{
            "maxLength":"50",
            "type":"string",
            "description":"The name for the external course.",
            "nullable":false,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time of the creation of the row for the identifier.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who first created the row for the identifier.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "type":"string",
            "description":"Description for the external course.",
            "nullable":true,
            "x-queryable":true
        },
        "EffectiveEndDate":{
            "type":"string",
            "description":"Date Effective Entity: indicates the date at the beginning of the date range within which the row is effective.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "ExternalCourseRowId":{
            "type":"integer",
            "description":"External subject unique identifier.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "CourseTypeCode":{
            "maxLength":"30",
            "type":"string",
            "description":"The course type code. A list of accepted values is defined in the lookup type ORA_HER_EXT_COURSE_TYPE.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CourseLevelMeaning":{
            "maxLength":"80",
            "type":"string",
            "description":"The course level meaning. A list of accepted values is defined in the lookup type ORA_HER_EXT_COURSE_LEVEL.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ExternalAcademicLevelMeaning":{
            "maxLength":"80",
            "type":"string",
            "description":"The external academic level meaning. A list of accepted values is defined in the lookup type ORA_HER_EXT_ACAD_LEVEL.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CourseLevelCode":{
            "maxLength":"30",
            "type":"string",
            "description":"The course level code. A list of accepted values is defined in the lookup type ORA_HER_EXT_COURSE_LEVEL.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"External organization unique identifier that owns this subject.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CourseIdentifier":{
            "maxLength":"50",
            "type":"string",
            "description":"Alternate unique identifier for the course defined for an external organization.",
            "nullable":false,
            "x-queryable":true
        },
        "ActiveFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the subject is active or inactive.",
            "nullable":false,
            "x-queryable":true
        },
        "CourseUnits":{
            "type":"number",
            "description":"The number of units earned in the course.",
            "nullable":true,
            "x-hints":{
                "precision":"3",
                "scale":"2"
            },
            "x-queryable":true
        },
        "SubjectCode":{
            "maxLength":"50",
            "type":"string",
            "description":"The external subject defined for an external organization associated with the external course.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CourseTypeMeaning":{
            "maxLength":"80",
            "type":"string",
            "description":"The course type meaning. A list of accepted values is defined in the lookup type ORA_HER_EXT_COURSE_TYPE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ExternalCourseId":{
            "type":"integer",
            "description":"External subject unique identifier.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ExternalAcademicLevelCode":{
            "maxLength":"30",
            "type":"string",
            "description":"The external academic level code. A list of accepted values is defined in the lookup type ORA_HER_EXT_ACAD_LEVEL.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "EffectiveStartDate":{
            "type":"string",
            "description":"Date Effective Entity: indicates the date at the end of the date range within which the row is effective.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "ExternalSubjectId":{
            "type":"integer",
            "description":"External subject unique identifier.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

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

Nested Schema : properties

Type: object

Show Source

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

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

Links

CourseLevelCodeHerLookup

Operation: /fscmRestApi/resources/11.13.18.05/herLookups

The following properties are defined on the LOV link relation:

• Source Attribute: CourseLevelCode; Target Attribute: LookupCode
• Display Attribute: DisplayedField

CourseTypeCodeHerLookup

Operation: /fscmRestApi/resources/11.13.18.05/herLookups

The following properties are defined on the LOV link relation:

• Source Attribute: CourseTypeCode; Target Attribute: LookupCode
• Display Attribute: DisplayedField

ExternalAcademicLevelCodeHerLookup

Operation: /fscmRestApi/resources/11.13.18.05/herLookups

The following properties are defined on the LOV link relation:

• Source Attribute: ExternalAcademicLevelCode; Target Attribute: LookupCode
• Display Attribute: DisplayedField

Back to Top