Jump to

• Request
• Response

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 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 : admissionApplications-applicationPrograms-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "AcademicProgramItemName":{
            "title":"Name",
            "maxLength":"150",
            "type":"string",
            "description":"Curriculum item name of the program.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AcademicGroupActionMeaning":{
            "title":"Academic Group Action",
            "maxLength":"80",
            "type":"string",
            "description":"Item action meaning associated with the program group.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AcademicGroupActionDate":{
            "title":"Academic Group Action Date",
            "type":"string",
            "description":"Date when the program group item action was applied.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InstitutionName":{
            "title":"Institution",
            "maxLength":"50",
            "type":"string",
            "description":"Admissions application institution name.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "InstitutionId":{
            "title":"Institution ID",
            "type":"integer",
            "description":"Admissions application institution identifier.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AcademicGroupActionCode":{
            "title":"Academic Group Action Code",
            "maxLength":"30",
            "type":"string",
            "description":"Item action code associated with the program group.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AcademicGroupItemName":{
            "title":"Academic Group",
            "maxLength":"150",
            "type":"string",
            "description":"Curriculum item name of the program's academic group.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "applicationProgramItemStatuses":{
            "title":"Application Program Item Statuses",
            "type":"array",
            "description":"The application program item statuses resource captures the status history of an application program.",
            "items":{
                "$ref":"#/components/schemas/admissionApplications-applicationPrograms-applicationProgramItemStatuses-item-response"
            }
        },
        "CampusName":{
            "title":"Campus",
            "maxLength":"50",
            "type":"string",
            "description":"Name of the campus of the program to which the applicant is applying.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AcademicGroupItemId":{
            "title":"Academic Group ID",
            "type":"integer",
            "description":"Curriculum item identifier for the program's academic group.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ApplicationProgramId":{
            "title":"Application Program ID",
            "type":"integer",
            "description":"Admissions application program identifier.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ProgramSequence":{
            "title":"Program Sequence",
            "type":"integer",
            "description":"Admissions application program sequence, for example, application submission order.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"3"
            },
            "x-queryable":true
        },
        "AcademicGroupStatusCode":{
            "title":"Academic Group Status Code",
            "maxLength":"30",
            "type":"string",
            "description":"Item status code associated with the program group.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AcademicLevelId":{
            "title":"Academic Level ID",
            "type":"integer",
            "description":"Academic level identifier for the program.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AcademicGroupStatusCodeMeaning":{
            "title":"Academic Group Status",
            "maxLength":"80",
            "type":"string",
            "description":"Item status meaning associated with the program group.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CampusId":{
            "title":"Campus ID",
            "type":"integer",
            "description":"Unique identifier for the campus of the program to which the applicant is applying.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "dependencies":[
                    "InstitutionId"
                ]
            },
            "x-queryable":true
        },
        "AcademicGroupActionReasonName":{
            "title":"Academic Group Action Reason",
            "maxLength":"50",
            "type":"string",
            "description":"Action reason name associated with the program group.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AcademicLevelName":{
            "title":"Academic Level",
            "maxLength":"100",
            "type":"string",
            "description":"Academic level name of the program.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AcademicGroupActionReasonCode":{
            "title":"Academic Group Action Reason Code",
            "maxLength":"30",
            "type":"string",
            "description":"Action reason code associated with the program group.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AcademicProgramItemId":{
            "title":"Academic Program ID",
            "type":"integer",
            "description":"Curriculum item identifier for the program.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AcademicGroupStatusDate":{
            "title":"Academic Group Status Date",
            "type":"string",
            "description":"Date when the program group item status was applied.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AcademicGroupActionReasonId":{
            "title":"Academic Group Action Reason ID",
            "type":"integer",
            "description":"Action reason identifier associated with the program group.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "dependencies":[
                    "AcadGroupActionReasonId"
                ]
            },
            "x-queryable":true
        }
    }
}

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

• Array of: object admissionApplications-applicationPrograms-applicationProgramItemStatuses-item-response

{
    "title":"Application Program Item Statuses",
    "type":"array",
    "description":"The application program item statuses resource captures the status history of an application program.",
    "items":{
        "$ref":"#/components/schemas/admissionApplications-applicationPrograms-applicationProgramItemStatuses-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 : admissionApplications-applicationPrograms-applicationProgramItemStatuses-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "StatusMeaning":{
            "title":"Status",
            "maxLength":"80",
            "type":"string",
            "description":"Status code meaning associated with the program item or admissions application.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StatusDate":{
            "title":"Status Date",
            "type":"string",
            "description":"Date when the admissions application or program item status was applied.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ActionCode":{
            "title":"Action Code",
            "maxLength":"30",
            "type":"string",
            "description":"Action code associated with the admissions application or program item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ActionReasonName":{
            "title":"Action Reason",
            "maxLength":"50",
            "type":"string",
            "description":"Action reason name associated with the admissions application or program action.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ActionReasonId":{
            "title":"Action Reason ID",
            "type":"integer",
            "description":"Action reason identifier associated with the admissions application or program action.",
            "format":"int64",
            "nullable":false,
            "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"
            }
        },
        "ApplicationProgramItemStatusId":{
            "title":"Application Program Item Status ID",
            "type":"integer",
            "description":"Admissions application program item status identifier.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "StatusCode":{
            "title":"Status Code",
            "maxLength":"30",
            "type":"string",
            "description":"Status code associated with the program item or admissions application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ActionMeaning":{
            "title":"Action",
            "maxLength":"80",
            "type":"string",
            "description":"Action meaning associated with the admissions application or program item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ActionDate":{
            "title":"Action Date",
            "type":"string",
            "description":"Date when the admissions application or program item action was applied.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ActionReasonCode":{
            "title":"Action Reason Code",
            "maxLength":"30",
            "type":"string",
            "description":"Action reason code associated with the admissions application or program action.",
            "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 : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

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

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

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

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

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

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

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

Nested Schema : properties

Type: object

Show Source

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

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

Links

ActionCodeLOV

Operation: /fscmRestApi/resources/11.13.18.05/heqLookups

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

ActionReasonCodeLOV

Operation: /fscmRestApi/resources/11.13.18.05/applicationActionReasons

The following properties are defined on the LOV link relation:

• Source Attribute: AcademicGroupActionReasonCode; Target Attribute: ActionReasonCode
• Display Attribute: ActionReasonName

applicationProgramItemStatuses

Operation: /fscmRestApi/resources/11.13.18.05/admissionApplications/{ApplicationId}/child/applicationPrograms/{ApplicationProgramId}/child/applicationProgramItemStatuses

Parameters:

• ApplicationId: $request.path.ApplicationId
• ApplicationProgramId: $request.path.ApplicationProgramId

The application program item statuses resource captures the status history of an application program.

Back to Top