Jump to

• Request
• Response

Get a transcript note

get

/fscmRestApi/resources/11.13.18.05/transcriptNotes/{TranscriptNoteId}

Request

Path Parameters

• TranscriptNoteId(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=

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

Header Parameters

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

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  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 : transcriptNotes-item-response

Type: object

Show Source

• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

  The date and time when the transcript note was created.
• Description: string
  Title: Description

  Maximum Length: 240

  The description of a transcript note.
• EnabledFlag: boolean
  Title: Enabled

  Maximum Length: 1

  The status of the transcript note. Values are true or false. The default value is true.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The user who last updated the transcript note.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The date and time when the transcript note was last updated.
• links: array Links
  Title: Links

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

  Maximum Length: 50

  The code of a transcript note.
• TranscriptNoteId: integer (int64)
  Title: Transcript Note ID

  The generated primary key column for a transcript note.
• TranscriptNoteName: string
  Title: Note Name

  Maximum Length: 50

  The name of a transcript note.
• TranscriptNoteType: string
  Title: Note Type

  Maximum Length: 30

  The type of transcript note. Valid values are ORA_CURRICULUM_TYPE or ORA_ACADEMIC_LEVEL. A list of accepted values is defined in the lookup type ORA_HER_TRANSCRIPT_NOTE_TYPE.
• TranscriptNoteTypeMeaning: string
  Title: Note Type Description

  Read Only: true

  Maximum Length: 80

  The meaning of the transcript note type. Valid values are Curriculum type or Student record. A list of accepted values is defined in the lookup type ORA_HER_TRANSCRIPT_NOTE_TYPE.
• validAcademicLevels: array Valid Academic Levels
  Title: Valid Academic Levels

  The valid academic levels resource is a child of the transcript notes resource and lists all the academic levels associated with a transcript note.
• validCurriculumTypes: array Valid Curriculum Types
  Title: Valid Curriculum Types

  The valid curriculum types resource is a child of the transcript notes resource and lists all the curriculum types associated with a transcript note.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The date and time when the transcript note was last updated.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TranscriptNoteType":{
            "title":"Note Type",
            "maxLength":"30",
            "type":"string",
            "description":"The type of transcript note. Valid values are ORA_CURRICULUM_TYPE or ORA_ACADEMIC_LEVEL. A list of accepted values is defined in the lookup type ORA_HER_TRANSCRIPT_NOTE_TYPE.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the transcript note was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "validCurriculumTypes":{
            "title":"Valid Curriculum Types",
            "type":"array",
            "description":"The valid curriculum types resource is a child of the transcript notes resource and lists all the curriculum types associated with a transcript note.",
            "items":{
                "$ref":"#/components/schemas/transcriptNotes-validCurriculumTypes-item-response"
            }
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the transcript note.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"240",
            "type":"string",
            "description":"The description of a transcript note.",
            "nullable":false,
            "x-queryable":true
        },
        "TranscriptNoteTypeMeaning":{
            "title":"Note Type Description",
            "maxLength":"80",
            "type":"string",
            "description":"The meaning of the transcript note type. Valid values are Curriculum type or Student record. A list of accepted values is defined in the lookup type ORA_HER_TRANSCRIPT_NOTE_TYPE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TranscriptNoteId":{
            "title":"Transcript Note ID",
            "type":"integer",
            "description":"The generated primary key column for a transcript note.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "TranscriptNoteName":{
            "title":"Note Name",
            "maxLength":"50",
            "type":"string",
            "description":"The name of a transcript note.",
            "nullable":false,
            "x-queryable":true
        },
        "validAcademicLevels":{
            "title":"Valid Academic Levels",
            "type":"array",
            "description":"The valid academic levels resource is a child of the transcript notes resource and lists all the academic levels associated with a transcript note.",
            "items":{
                "$ref":"#/components/schemas/transcriptNotes-validAcademicLevels-item-response"
            }
        },
        "TranscriptNoteCode":{
            "title":"Code",
            "maxLength":"50",
            "type":"string",
            "description":"The code of a transcript note.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":"1",
            "type":"boolean",
            "description":"The status of the transcript note. Values are true or false. The default value is true.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The user who last updated the transcript note.",
            "format":"date-time",
            "nullable":false,
            "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 : Valid Academic Levels

Type: array

Title: Valid Academic Levels

The valid academic levels resource is a child of the transcript notes resource and lists all the academic levels associated with a transcript note.

Show Source

• Array of: object transcriptNotes-validAcademicLevels-item-response

{
    "title":"Valid Academic Levels",
    "type":"array",
    "description":"The valid academic levels resource is a child of the transcript notes resource and lists all the academic levels associated with a transcript note.",
    "items":{
        "$ref":"#/components/schemas/transcriptNotes-validAcademicLevels-item-response"
    }
}

Nested Schema : Valid Curriculum Types

Type: array

Title: Valid Curriculum Types

The valid curriculum types resource is a child of the transcript notes resource and lists all the curriculum types associated with a transcript note.

Show Source

• Array of: object transcriptNotes-validCurriculumTypes-item-response

{
    "title":"Valid Curriculum Types",
    "type":"array",
    "description":"The valid curriculum types resource is a child of the transcript notes resource and lists all the curriculum types associated with a transcript note.",
    "items":{
        "$ref":"#/components/schemas/transcriptNotes-validCurriculumTypes-item-response"
    }
}

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 : transcriptNotes-validAcademicLevels-item-response

Type: object

Show Source

• AcademicLevelCode: string
  Title: Academic Level Code

  Maximum Length: 100

  The code of an academic level.
• AcademicLevelId: integer (int64)
  Title: Academic Level ID

  The unique identifier for an academic level which is associated with transcript note, such as graduate.
• AcademicLevelName: string
  Title: Academic Level Name

  Read Only: true

  Maximum Length: 100

  The name of an academic level.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the academic level.
• CreationDate: string (date-time)
  Read Only: true

  The date and time when the academic level was created.
• LastUpdateDate: string (date-time)
  Read Only: true

  The user who last updated the academic level.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The date and time when the academic level was last updated.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• NoteAssignmentId: integer (int64)
  Title: Note Assignment ID

  The unique identifier for a child valid academic level of a transcript note.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The date and time when the academic level was last updated.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the academic level was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AcademicLevelCode":{
            "title":"Academic Level Code",
            "maxLength":"100",
            "type":"string",
            "description":"The code of an academic level.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the academic level.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AcademicLevelId":{
            "title":"Academic Level ID",
            "type":"integer",
            "description":"The unique identifier for an academic level which is associated with transcript note, such as graduate.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AcademicLevelName":{
            "title":"Academic Level Name",
            "maxLength":"100",
            "type":"string",
            "description":"The name of an academic level.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The user who last updated the academic level.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "NoteAssignmentId":{
            "title":"Note Assignment ID",
            "type":"integer",
            "description":"The unique identifier for a child valid academic level of a transcript note.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"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 : transcriptNotes-validCurriculumTypes-item-response

Type: object

Show Source

• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

  The date and time when the curriculum type was created.
• CurriculumTypeCode: string
  Title: Curriculum Type

  Maximum Length: 30

  The code of a curriculum type.
• CurriculumTypeId: integer (int64)
  Title: Curriculum Type ID

  The unique identifier for a curriculum type which is associated with a transcript note, such as a course.
• CurriculumTypeName: string
  Title: Curriculum Type Name

  Read Only: true

  Maximum Length: 50

  The name of a curriculum type.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time when the curriculum type was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the curriculum type.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• NoteAssignmentId: integer (int64)
  Title: Note Assignment ID

  The unique identifier for a child valid curriculum type of a transcript note.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the curriculum type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the curriculum type was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurriculumTypeCode":{
            "title":"Curriculum Type",
            "maxLength":"30",
            "type":"string",
            "description":"The code of a curriculum type.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the curriculum type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurriculumTypeId":{
            "title":"Curriculum Type ID",
            "type":"integer",
            "description":"The unique identifier for a curriculum type which is associated with a transcript note, such as a course.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CurriculumTypeName":{
            "title":"Curriculum Type Name",
            "maxLength":"50",
            "type":"string",
            "description":"The name of a curriculum type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the curriculum type was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "NoteAssignmentId":{
            "title":"Note Assignment ID",
            "type":"integer",
            "description":"The unique identifier for a child valid curriculum type of a transcript note.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"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"
    }
}

Links

transcriptNoteTypesLOV

Operation: /fscmRestApi/resources/11.13.18.05/herLookups

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_HER_TRANSCRIPT_NOTE_TYPE

The following properties are defined on the LOV link relation:

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

validAcademicLevels

Operation: /fscmRestApi/resources/11.13.18.05/transcriptNotes/{TranscriptNoteId}/child/validAcademicLevels

Parameters:

• TranscriptNoteId: $request.path.TranscriptNoteId

The valid academic levels resource is a child of the transcript notes resource and lists all the academic levels associated with a transcript note.

validCurriculumTypes

Operation: /fscmRestApi/resources/11.13.18.05/transcriptNotes/{TranscriptNoteId}/child/validCurriculumTypes

Parameters:

• TranscriptNoteId: $request.path.TranscriptNoteId

The valid curriculum types resource is a child of the transcript notes resource and lists all the curriculum types associated with a transcript note.

Back to Top