Get an application program
get
/fscmRestApi/resources/11.13.18.05/admissionApplications/{ApplicationId}/child/applicationPrograms/{ApplicationProgramId}
Request
Path Parameters
-
ApplicationId(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=
-
ApplicationProgramId(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 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 : admissionApplications-applicationPrograms-item-response
Type:
Show Source
object
-
AcademicGroupActionCode: string
Title:
Academic Group Action Code
Maximum Length:30
Item action code associated with the program group. -
AcademicGroupActionDate: string
(date)
Title:
Academic Group Action Date
Read Only:true
Date when the program group item action was applied. -
AcademicGroupActionMeaning: string
Title:
Academic Group Action
Read Only:true
Maximum Length:80
Item action meaning associated with the program group. -
AcademicGroupActionReasonCode: string
Title:
Academic Group Action Reason Code
Maximum Length:30
Action reason code associated with the program group. -
AcademicGroupActionReasonId: integer
(int64)
Title:
Academic Group Action Reason ID
Action reason identifier associated with the program group. -
AcademicGroupActionReasonName: string
Title:
Academic Group Action Reason
Read Only:true
Maximum Length:50
Action reason name associated with the program group. -
AcademicGroupItemId: integer
(int64)
Title:
Academic Group ID
Read Only:true
Curriculum item identifier for the program's academic group. -
AcademicGroupItemName: string
Title:
Academic Group
Read Only:true
Maximum Length:150
Curriculum item name of the program's academic group. -
AcademicGroupStatusCode: string
Title:
Academic Group Status Code
Read Only:true
Maximum Length:30
Item status code associated with the program group. -
AcademicGroupStatusCodeMeaning: string
Title:
Academic Group Status
Read Only:true
Maximum Length:80
Item status meaning associated with the program group. -
AcademicGroupStatusDate: string
(date)
Title:
Academic Group Status Date
Read Only:true
Date when the program group item status was applied. -
AcademicLevelId: integer
(int64)
Title:
Academic Level ID
Read Only:true
Academic level identifier for the program. -
AcademicLevelName: string
Title:
Academic Level
Read Only:true
Maximum Length:100
Academic level name of the program. -
AcademicProgramItemId: integer
(int64)
Title:
Academic Program ID
Read Only:true
Curriculum item identifier for the program. -
AcademicProgramItemName: string
Title:
Name
Read Only:true
Maximum Length:150
Curriculum item name of the program. -
ApplicationProgramId: integer
(int64)
Title:
Application Program ID
Read Only:true
Admissions application program identifier. -
applicationProgramItemStatuses: array
Application Program Item Statuses
Title:
Application Program Item Statuses
The application program item statuses resource captures the status history of an application program. -
CampusId: integer
(int64)
Title:
Campus ID
Read Only:true
Unique identifier for the campus of the program to which the applicant is applying. -
CampusName: string
Title:
Campus
Read Only:true
Maximum Length:50
Name of the campus of the program to which the applicant is applying. -
InstitutionId: integer
(int64)
Title:
Institution ID
Read Only:true
Admissions application institution identifier. -
InstitutionName: string
Title:
Institution
Read Only:true
Maximum Length:50
Admissions application institution name. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ProgramSequence: integer
(int32)
Title:
Program Sequence
Read Only:true
Admissions application program sequence, for example, application submission order.
Nested Schema : Application Program Item Statuses
Type:
array
Title:
Application Program Item Statuses
The application program item statuses resource captures the status history of an application program.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : admissionApplications-applicationPrograms-applicationProgramItemStatuses-item-response
Type:
Show Source
object
-
ActionCode: string
Title:
Action Code
Read Only:true
Maximum Length:30
Action code associated with the admissions application or program item. -
ActionDate: string
(date)
Title:
Action Date
Read Only:true
Date when the admissions application or program item action was applied. -
ActionMeaning: string
Title:
Action
Read Only:true
Maximum Length:80
Action meaning associated with the admissions application or program item. -
ActionReasonCode: string
Title:
Action Reason Code
Read Only:true
Maximum Length:30
Action reason code associated with the admissions application or program action. -
ActionReasonId: integer
(int64)
Title:
Action Reason ID
Read Only:true
Action reason identifier associated with the admissions application or program action. -
ActionReasonName: string
Title:
Action Reason
Read Only:true
Maximum Length:50
Action reason name associated with the admissions application or program action. -
ApplicationProgramItemStatusId: integer
(int64)
Title:
Application Program Item Status ID
Read Only:true
Admissions application program item status identifier. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
StatusCode: string
Title:
Status Code
Read Only:true
Maximum Length:30
Status code associated with the program item or admissions application. -
StatusDate: string
(date)
Title:
Status Date
Read Only:true
Date when the admissions application or program item status was applied. -
StatusMeaning: string
Title:
Status
Read Only:true
Maximum Length:80
Status code meaning associated with the program item or admissions application.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
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.
Links
- ActionCodeLOV
-
Parameters:
- finder:
ByLookupTypeFinder%3BLookupType%3DORA_HEQ_ADM_APPL_ACTIONS%2CLookupCode%3D{AcademicGroupActionCode}
The following properties are defined on the LOV link relation:- Source Attribute: AcademicGroupActionCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- ActionReasonCodeLOV
-
The following properties are defined on the LOV link relation:
- Source Attribute: AcademicGroupActionReasonCode; Target Attribute: ActionReasonCode
- Display Attribute: ActionReasonName
- applicationProgramItemStatuses
-
Parameters:
- ApplicationId:
$request.path.ApplicationId
- ApplicationProgramId:
$request.path.ApplicationProgramId
The application program item statuses resource captures the status history of an application program. - ApplicationId: