Get all academic organizations
get
/fscmRestApi/resources/11.13.18.05/academicInstitutions/{InstitutionId}/child/academicOrganizations
Request
Path Parameters
-
InstitutionId(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 -
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- ByInstitutionNameFinder Find all academic organizations that match the keyword specified.
Finder Variables- bindInstitutionName; string; Keyword; string; for the institution name.
- ByKeywordFinder Finds all academic organizations that match the keyword provided. The keyword will be used to search academic organization name, academic organization type and academic organization status.
Finder Variables- Keyword; string; The keyword used to search the academic organizations.
- PrimaryKey Find all academic organizations that match the primary key criteria specified.
Finder Variables- AcademicOrgId; integer; Unique identifier for an academic organization.
- ByInstitutionNameFinder Find all academic organizations that match the keyword specified.
-
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:- AcademicOrgId; integer; The unique identifier for an academic organization.
- AcademicOrgName; string; The name of the academic organization.
- AcademicOrgTypeCode; string; Indicates the type of academic organization. A list of accepted values is defined in the lookup type ORA_HER_ACADEMIC_ORG_TYPE.
- AcademicOrgTypeMeaning; string; The meaning of the academic organization type code. A list of accepted values is defined in the lookup type ORA_HER_ACADEMIC_ORG_TYPE.
- ActiveFlag; boolean; Indicates whether the academic organization is active and available to use.
- BusinessUnitId; integer; The business unit associated with the academic organization.
- CampusId; integer; The unique identifier for the campus associated with the academic organization.
- CampusName; string; The name of the campus associated with the academic organization.
- CreatedBy; string; The user who created the row.
- CreationDate; string; The date the row was created.
- Description; string; The description of the academic organization.
- EndDate; string; The end or expiration date of the academic organization.
- InstitutionId; integer; The unique identifier for the academic institution associated with the academic organization.
- InstitutionName; string; The name of the institution associated with the academic organization.
- LastUpdateDate; string; The date the row was last updated.
- LastUpdatedBy; string; The user who last updated the row.
- OrganizationCode; string; The code identifier of an academic organization.
- StartDate; string; The start date of the academic organization.
- StatusCode; string; The status code of the academic organization. This controls the availability of the academic organization for associations with other academic entities.
- StatusMeaning; string; The status of the academic organization.
- StorefrontOptionCode; string; The storefront option code of the academic organization.
-
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
-
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 TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
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(required):
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.
Root Schema : academicInstitutions-academicOrganizations
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : academicInstitutions-academicOrganizations-item-response
Type:
Show Source
object
-
AcademicOrgId: integer
(int64)
Title:
Academic Organization ID
The unique identifier for an academic organization. -
AcademicOrgName: string
Title:
Academic Organization
Maximum Length:50
The name of the academic organization. -
AcademicOrgTypeCode: string
Maximum Length:
30
Indicates the type of academic organization. A list of accepted values is defined in the lookup type ORA_HER_ACADEMIC_ORG_TYPE. -
AcademicOrgTypeMeaning: string
Read Only:
true
Maximum Length:80
The meaning of the academic organization type code. A list of accepted values is defined in the lookup type ORA_HER_ACADEMIC_ORG_TYPE. -
ActiveFlag: boolean
Title:
Active
Maximum Length:1
Default Value:true
Indicates whether the academic organization is active and available to use. -
BusinessUnitId: integer
(int64)
Title:
Business Unit
The business unit associated with the academic organization. -
CampusId: integer
(int64)
Title:
Campus ID
The unique identifier for the campus associated with the academic organization. -
CampusName: string
Title:
Campus
Read Only:true
The name of the campus associated with the academic organization. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the row. -
CreationDate: string
(date-time)
Read Only:
true
The date the row was created. -
Description: string
Title:
Description
Maximum Length:240
The description of the academic organization. -
EndDate: string
(date)
The end or expiration date of the academic organization.
-
InstitutionId: integer
(int64)
Title:
Institution ID
The unique identifier for the academic institution associated with the academic organization. -
InstitutionName: string
Title:
Institution
Read Only:true
The name of the institution associated with the academic organization. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date the row was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the row. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OrganizationCode: string
Maximum Length:
100
The code identifier of an academic organization. -
organizationStorefronts: array
Offering Storefronts
Title:
Offering Storefronts
The offering storefronts resource is a child of the programs resource and provides a list of offering storefronts associated with a program. -
StartDate: string
(date)
The start date of the academic organization.
-
StatusCode: string
Maximum Length:
30
Default Value:ORA_ACTIVE
The status code of the academic organization. This controls the availability of the academic organization for associations with other academic entities. -
StatusMeaning: string
Read Only:
true
Maximum Length:80
The status of the academic organization. -
StorefrontOptionCode: string
Title:
Storefront
Maximum Length:30
The storefront option code of the academic organization.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Offering Storefronts
Type:
array
Title:
Offering Storefronts
The offering storefronts resource is a child of the programs resource and provides a list of offering storefronts associated with a program.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : academicInstitutions-academicOrganizations-organizationStorefronts-item-response
Type:
Show Source
object
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
StorefrontId: integer
(int64)
Title:
Storefront ID
Read Only:true
The unique identifier for the offering storefront. -
StorefrontName: string
Title:
Storefront Name
Read Only:true
The name of the offering storefront.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source