Jump to

• Request
• Response

Get all academic groups

get

/fscmRestApi/resources/11.13.18.05/academicGroups

Request

Query Parameters

• effectiveDate: string
  This query parameter is used to fetch resources which are effective dated as of the specified start date. The value of this query parameter is a string having a date in yyyy-MM-dd format
• 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
• finder: string
  Used as a predefined finder to search the collection.
  
  Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables
  
  

  • AcademicGroupIdFinder Find all academic groups that match the given bind variable.
    Finder Variables
    • BindAcademicGroupId; integer; Bind variable for the academic group ID finder.
  • PrimaryKey Finds all academic groups that match the primary key criteria specified.
    Finder Variables
    • CurriculumHeaderId; integer; Unique identifier for the academic group.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• 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
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • AcademicGroupId; integer; The unique identifier for a curriculum item.
  • AcademicLevelId; integer; The unique identifier for an academic level.
  • AcademicOrgId; integer; The unique identifier for an academic organization.
  • CurriculumBuildStatusId; integer; The unique identifier for a curriculum build status. A build status refers to the life cycle of a curriculum item.
  • CurriculumBuildStatusName; string; The name of a build or lifecycle status code.
  • CurriculumHeaderId; integer; The unique identifier for a curriculum header record, which is the record that's shared across all curriculum item types.
  • CurriculumName; string; The name or short description of a curriculum item.
  • CurriculumTitle; string; The title of a curriculum item.
  • DefaultPlanFormatId; integer; The unique identifier for a plan format.
  • InstitutionId; integer; The unique identifier for an institution.
  • PlanFormatName; string; The name of a plan format, such as 4 year regular undergraduate.
  • RequirementLongDescription; string; The description of the course and other requirements for a curriculum registry academic group definition.
  • SystemStatusCode; string; A code for a build or life cycle status for an academic group, such as Under Review or Approved.
  • SystemStatusMeaning; string; A value that determines whether a curriculum build status code is considered active or inactive.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

Header Parameters

• Effective-Of:
  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:
  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 : academicGroups

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/academicGroups-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"BusinessObject",
        "group":"HED"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object academicGroups-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/academicGroups-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 : academicGroups-item-response

Type: object

Show Source

• AcademicGroupId: integer (int64)
  Title: Curriculum ID

  Read Only: true

  The unique identifier for a curriculum item.
• AcademicLevelId: integer (int64)
  Title: Academic Level ID

  Read Only: true

  The unique identifier for an academic level.
• AcademicOrgId: integer (int64)
  Title: Academic Organization ID

  Read Only: true

  The unique identifier for an academic organization.
• CurriculumBuildStatusId: integer (int64)
  Title: Curriculum Build Status ID

  Read Only: true

  The unique identifier for a curriculum build status. A build status refers to the life cycle of a curriculum item.
• CurriculumBuildStatusName: string
  Title: Build Status

  Read Only: true

  Maximum Length: 50

  The name of a build or lifecycle status code.
• CurriculumHeaderId: integer (int64)
  Title: Curriculum Header ID

  Read Only: true

  The unique identifier for a curriculum header record, which is the record that's shared across all curriculum item types.
• CurriculumName: string
  Title: Name

  Read Only: true

  Maximum Length: 150

  The name or short description of a curriculum item.
• CurriculumTitle: string
  Title: Title

  Read Only: true

  Maximum Length: 100

  The title of a curriculum item.
• DefaultPlanFormatId: integer (int64)
  Title: Plan Format ID

  Read Only: true

  The unique identifier for a plan format.
• elements: array Elements
  Title: Elements

  The elements resource is a child of the academic groups resource and lists all the elements associated with an academic group.
• InstitutionId: integer (int64)
  Title: Institution ID

  Read Only: true

  The unique identifier for an institution.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• parameters: array Parameters
  Title: Parameters

  The parameters resource is a child of the programs resource and provides a list of program parameters for a program.
• PlanFormatName: string
  Title: Format Name

  Read Only: true

  Maximum Length: 50

  The name of a plan format, such as 4 year regular undergraduate.
• RequirementLongDescription: string
  Title: Requirements

  Read Only: true

  The description of the course and other requirements for a curriculum registry academic group definition.
• results: array Results
  Title: Results

  The results resource is a child of the academic groups resource and lists all the results associated with an academic group.
• SystemStatusCode: string
  Title: Build Status Code

  Read Only: true

  Maximum Length: 30

  A code for a build or life cycle status for an academic group, such as Under Review or Approved.
• SystemStatusMeaning: string
  Title: Curriculum Build Status

  Read Only: true

  A value that determines whether a curriculum build status code is considered active or inactive.

{
    "type":"object",
    "properties":{
        "AcademicOrgId":{
            "title":"Academic Organization ID",
            "type":"integer",
            "description":"The unique identifier for an academic organization.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "RequirementLongDescription":{
            "title":"Requirements",
            "type":"string",
            "description":"The description of the course and other requirements for a curriculum registry academic group definition.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "InstitutionId":{
            "title":"Institution ID",
            "type":"integer",
            "description":"The unique identifier for an institution.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            },
            "x-queryable":true
        },
        "CurriculumBuildStatusId":{
            "title":"Curriculum Build Status ID",
            "type":"integer",
            "description":"The unique identifier for a curriculum build status. A build status refers to the life cycle of a curriculum item.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SystemStatusCode":{
            "title":"Build Status Code",
            "maxLength":"30",
            "type":"string",
            "description":"A code for a build or life cycle status for an academic group, such as Under Review or Approved.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurriculumName":{
            "title":"Name",
            "maxLength":"150",
            "type":"string",
            "description":"The name or short description of a curriculum item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanFormatName":{
            "title":"Format Name",
            "maxLength":"50",
            "type":"string",
            "description":"The name of a plan format, such as 4 year regular undergraduate.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DefaultPlanFormatId":{
            "title":"Plan Format ID",
            "type":"integer",
            "description":"The unique identifier for a plan format.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SystemStatusMeaning":{
            "title":"Curriculum Build Status",
            "type":"string",
            "description":"A value that determines whether a curriculum build status code is considered active or inactive.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AcademicGroupId":{
            "title":"Curriculum ID",
            "type":"integer",
            "description":"The unique identifier for a curriculum item.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CurriculumBuildStatusName":{
            "title":"Build Status",
            "maxLength":"50",
            "type":"string",
            "description":"The name of a build or lifecycle status code.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AcademicLevelId":{
            "title":"Academic Level ID",
            "type":"integer",
            "description":"The unique identifier for an academic level.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            },
            "x-queryable":true
        },
        "elements":{
            "title":"Elements",
            "type":"array",
            "description":"The elements resource is a child of the academic groups resource and lists all the elements associated with an academic group.",
            "items":{
                "$ref":"#/components/schemas/academicGroups-elements-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CurriculumHeaderId":{
            "title":"Curriculum Header ID",
            "type":"integer",
            "description":"The unique identifier for a curriculum header record, which is the record that's shared across all curriculum item types.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "parameters":{
            "title":"Parameters",
            "type":"array",
            "description":"The parameters resource is a child of the programs resource and provides a list of program parameters for a program.",
            "items":{
                "$ref":"#/components/schemas/academicGroups-parameters-item-response"
            }
        },
        "results":{
            "title":"Results",
            "type":"array",
            "description":"The results resource is a child of the academic groups resource and lists all the results associated with an academic group.",
            "items":{
                "$ref":"#/components/schemas/academicGroups-results-item-response"
            }
        },
        "CurriculumTitle":{
            "title":"Title",
            "maxLength":"100",
            "type":"string",
            "description":"The title of a curriculum item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Elements

Type: array

Title: Elements

The elements resource is a child of the academic groups resource and lists all the elements associated with an academic group.

Show Source

• Array of: object academicGroups-elements-item-response

{
    "title":"Elements",
    "type":"array",
    "description":"The elements resource is a child of the academic groups resource and lists all the elements associated with an academic group.",
    "items":{
        "$ref":"#/components/schemas/academicGroups-elements-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 : Parameters

Type: array

Title: Parameters

The parameters resource is a child of the programs resource and provides a list of program parameters for a program.

Show Source

• Array of: object academicGroups-parameters-item-response

{
    "title":"Parameters",
    "type":"array",
    "description":"The parameters resource is a child of the programs resource and provides a list of program parameters for a program.",
    "items":{
        "$ref":"#/components/schemas/academicGroups-parameters-item-response"
    }
}

Nested Schema : Results

Type: array

Title: Results

The results resource is a child of the academic groups resource and lists all the results associated with an academic group.

Show Source

• Array of: object academicGroups-results-item-response

{
    "title":"Results",
    "type":"array",
    "description":"The results resource is a child of the academic groups resource and lists all the results associated with an academic group.",
    "items":{
        "$ref":"#/components/schemas/academicGroups-results-item-response"
    }
}

Nested Schema : academicGroups-elements-item-response

Type: object

Show Source

• ConnectorCode: string
  Title: Connector Code

  Read Only: true

  Maximum Length: 30

  The code for the connectors between the elements of a curriculum item. Valid values include ORA_AND or ORA_OR. A list of accepted values is defined in the lookup type ORA_HER__ELEMENT_CONNECTOR_CODE.
• ConnectorMeaning: string
  Title: Connector

  Read Only: true

  A logical connector used to connect curriculum item child elements. Valid values include And or Or. A list of accepted values is defined in the lookup type ORA_HER__ELEMENT_CONNECTOR_CODE.
• CurriculumId: integer (int64)
  Title: Element Curriculum ID

  Read Only: true

  The curriculum ID for an item that's a child element of another curriculum item.
• CurriculumName: string
  Title: Name

  Read Only: true

  Maximum Length: 150

  The name or short description of a curriculum item.
• CurriculumType: string
  Title: Curriculum Type

  Read Only: true

  Maximum Length: 50

  The name of a curriculum type for which a curriculum build status code is valid.
• ElementId: integer (int64)
  Title: Curriculum Element ID

  Read Only: true

  The unique identifier for a child element of a curriculum item. A child element might be a course or course list.
• LeftParenthesesQuantity: integer (int32)
  Title: Left Parentheses Quantity

  Read Only: true

  The number of left parentheses included in a curriculum element row.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• RequirementCategoryCode: string
  Title: Requirement Category Code

  Read Only: true

  Maximum Length: 30

  The code for a requirement category, used for categorizing requirements in the Curriculum Registry.
• RequirementCategoryId: integer (int64)
  Title: Requirement Category ID

  Read Only: true

  The unique identifier for a requirement category code.
• RequirementCategoryName: string
  Title: Name

  Read Only: true

  Maximum Length: 50

  The name or short description of a requirement category code.
• RightParenthesesQuantity: integer (int32)
  Title: Right Parentheses Quantity

  Read Only: true

  The number of right parentheses included in a curriculum element row.
• SortNumber: integer (int32)
  Title: Sort Number

  Read Only: true

  Determines the order in which the curriculum item elements are sorted.

{
    "type":"object",
    "properties":{
        "CurriculumType":{
            "title":"Curriculum Type",
            "maxLength":"50",
            "type":"string",
            "description":"The name of a curriculum type for which a curriculum build status code is valid.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ConnectorCode":{
            "title":"Connector Code",
            "maxLength":"30",
            "type":"string",
            "description":"The code for the connectors between the elements of a curriculum item. Valid values include ORA_AND or ORA_OR. A list of accepted values is defined in the lookup type ORA_HER__ELEMENT_CONNECTOR_CODE.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RequirementCategoryId":{
            "title":"Requirement Category ID",
            "type":"integer",
            "description":"The unique identifier for a requirement category code.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "RightParenthesesQuantity":{
            "title":"Right Parentheses Quantity",
            "type":"integer",
            "description":"The number of right parentheses included in a curriculum element row.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "RequirementCategoryName":{
            "title":"Name",
            "maxLength":"50",
            "type":"string",
            "description":"The name or short description of a requirement category code.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurriculumName":{
            "title":"Name",
            "maxLength":"150",
            "type":"string",
            "description":"The name or short description of a curriculum item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RequirementCategoryCode":{
            "title":"Requirement Category Code",
            "maxLength":"30",
            "type":"string",
            "description":"The code for a requirement category, used for categorizing requirements in the Curriculum Registry.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurriculumId":{
            "title":"Element Curriculum ID",
            "type":"integer",
            "description":"The curriculum ID for an item that's a child element of another curriculum item.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SortNumber":{
            "title":"Sort Number",
            "type":"integer",
            "description":"Determines the order in which the curriculum item elements are sorted.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "LeftParenthesesQuantity":{
            "title":"Left Parentheses Quantity",
            "type":"integer",
            "description":"The number of left parentheses included in a curriculum element row.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ElementId":{
            "title":"Curriculum Element ID",
            "type":"integer",
            "description":"The unique identifier for a child element of a curriculum item. A child element might be a course or course list.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ConnectorMeaning":{
            "title":"Connector",
            "type":"string",
            "description":"A logical connector used to connect curriculum item child elements. Valid values include And or Or. A list of accepted values is defined in the lookup type ORA_HER__ELEMENT_CONNECTOR_CODE.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

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

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

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

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

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

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

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

Nested Schema : properties

Type: object

Show Source

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

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

Nested Schema : academicGroups-parameters-item-response

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MaximumCoursesQuantity: integer (int32)
  Title: Maximum Number of Courses

  Read Only: true

  Default Value: 0

  The maximum number of courses that can be taken toward satisfying a program parameter.
• MaximumUnitsQuantity: integer (int32)
  Title: Maximum Units

  Read Only: true

  Default Value: 0

  The maximum number of credits available for a program.
• MinimumCoursesQuantity: integer (int32)
  Title: Minimum Number of Courses

  Read Only: true

  Default Value: 0

  The minimum number of courses that must be taken toward satisfying a program parameter.
• MinimumUnitsQuantity: integer (int32)
  Title: Minimum Units

  Read Only: true

  Default Value: 0

  The minimum number of credits available for a program.
• ParameterId: integer (int64)
  Title: Curriculum Parameter ID

  Read Only: true

  The unique identifier for a parameter that's associated with a program element.
• ParameterSequenceNumber: integer (int32)
  Title: Parameter Sequence Number

  Read Only: true

  The sequence number for a program parameter row.
• RequirementCategoryCode: string
  Title: Requirement Category Code

  Read Only: true

  Maximum Length: 30

  A code that categorizes program course requirements.
• RequirementCategoryId: integer (int64)
  Title: Requirement Category ID

  Read Only: true

  The unique identifier for a requirement category code assigned to a program parameter.
• RequirementCategoryName: string
  Title: Name

  Read Only: true

  Maximum Length: 50

  The name of the requirement category code.

{
    "type":"object",
    "properties":{
        "MaximumCoursesQuantity":{
            "title":"Maximum Number of Courses",
            "type":"integer",
            "description":"The maximum number of courses that can be taken toward satisfying a program parameter.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "default":"0",
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "ParameterSequenceNumber":{
            "title":"Parameter Sequence Number",
            "type":"integer",
            "description":"The sequence number for a program parameter row.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "MinimumUnitsQuantity":{
            "title":"Minimum Units",
            "type":"integer",
            "description":"The minimum number of credits available for a program.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "default":"0",
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "RequirementCategoryId":{
            "title":"Requirement Category ID",
            "type":"integer",
            "description":"The unique identifier for a requirement category code assigned to a program parameter.",
            "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"
            }
        },
        "RequirementCategoryName":{
            "title":"Name",
            "maxLength":"50",
            "type":"string",
            "description":"The name of the requirement category code.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MinimumCoursesQuantity":{
            "title":"Minimum Number of Courses",
            "type":"integer",
            "description":"The minimum number of courses that must be taken toward satisfying a program parameter.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "default":"0",
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "MaximumUnitsQuantity":{
            "title":"Maximum Units",
            "type":"integer",
            "description":"The maximum number of credits available for a program.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "default":"0",
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "ParameterId":{
            "title":"Curriculum Parameter ID",
            "type":"integer",
            "description":"The unique identifier for a parameter that's associated with a program element.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "RequirementCategoryCode":{
            "title":"Requirement Category Code",
            "maxLength":"30",
            "type":"string",
            "description":"A code that categorizes program course requirements.",
            "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 : academicGroups-results-item-response

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ResultId: integer (int64)
  Title: Curriculum Result ID

  Read Only: true

  The unique identifier for a curriculum result record.
• ResultSetCode: string
  Title: Code

  Read Only: true

  Maximum Length: 30

  The unique code for the result type.
• ResultSetId: integer (int64)
  Title: Result Set ID

  Read Only: true

  The unique identifier for a result set.
• ResultSetName: string
  Title: Name

  Read Only: true

  Maximum Length: 50

  The name of the result set which is used to evaluate result types.
• ResultTypeCode: string
  Title: Result Type Code

  Read Only: true

  Maximum Length: 30

  The result type code for a student result record, such as cumulative GPA.
• ResultTypeId: integer (int64)
  Title: Result Type ID

  Read Only: true

  The unique identifier for a result type.
• ResultTypeName: string
  Title: Result Type

  Read Only: true

  Maximum Length: 50

  The name of the result type assigned to the student, such as final grade or competency.

{
    "type":"object",
    "properties":{
        "ResultSetCode":{
            "title":"Code",
            "maxLength":"30",
            "type":"string",
            "description":"The unique code for the result type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ResultTypeCode":{
            "title":"Result Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"The result type code for a student result record, such as cumulative GPA.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ResultSetId":{
            "title":"Result Set ID",
            "type":"integer",
            "description":"The unique identifier for a result set.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ResultTypeName":{
            "title":"Result Type",
            "maxLength":"50",
            "type":"string",
            "description":"The name of the result type assigned to the student, such as final grade or competency.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ResultSetName":{
            "title":"Name",
            "maxLength":"50",
            "type":"string",
            "description":"The name of the result set which is used to evaluate result types.",
            "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"
            }
        },
        "ResultId":{
            "title":"Curriculum Result ID",
            "type":"integer",
            "description":"The unique identifier for a curriculum result record.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ResultTypeId":{
            "title":"Result Type ID",
            "type":"integer",
            "description":"The unique identifier for a result type.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "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"
    }
}

Back to Top