Jump to

• Request
• Response

Update an application form

patch

/fscmRestApi/resources/11.13.18.05/applicationFormDefinitions/{applicationFormDefinitionsUniqID}

Request

Path Parameters

• applicationFormDefinitionsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Application Form Definitions resource and used to uniquely identify an instance of Application Form Definitions. The client should not generate the hash key value. Instead, the client should query on the Application Form Definitions collection resource in order to navigate to a specific instance of Application Form Definitions to get the hash key.

Header Parameters

• Metadata-Context: string
  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: string
  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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• AdmitEndDate: string (date)
  Title: Admit End Date

  Admit academic period ending date.
• AdmitStartDate: string (date)
  Title: Admit Start Date

  Admit academic period starting date.
• AdmitTypeCode: string
  Title: Admit Type

  Maximum Length: 30

  Type of applicant before entry to the academic institution, for example a transfer applicant.
• applicationAdmitPeriods: array Application Admit Periods
  Title: Application Admit Periods

  The application admit period is child to application form definition and provides information about the admit periods form metadata.
• applicationPrograms: array Application Programs
  Title: Application Programs

  The application program is child to the application form definition and provides information about the programs form metadata.
• Description: string
  Title: Description

  Maximum Length: 240

  The description of an application form.
• DisplayName(required): string
  Title: Display Name

  Maximum Length: 100

  Form name that's displayed to the user.
• entityAssignments: array Entity Assignments
  Title: Entity Assignments

  Academic entities such as institutions, campuses, or organizations assigned to application forms.
• FormCode(required): string
  Title: Form Code

  Maximum Length: 50

  The unique code of a form.
• formFragments: array Form Fragments
  Title: Form Fragments

  The form fragment is child to the application form definition and provides information about various parts of the form.
• FormTypeCode(required): string
  Title: Form Type

  Maximum Length: 30

  Code for form type, for example admissions application or residency appeal.
• Name(required): string
  Title: Form Name

  Maximum Length: 100

  Form name, such as arts admissions application form.
• StatusCode(required): string
  Title: Status

  Maximum Length: 30

  Form status code, for example unpublished, published, or archived.
• VersionDescription: string
  Title: Version Description

  Maximum Length: 240

  The description of a published, unpublished, or draft form version.
• VersionName(required): string
  Title: Version Name

  Maximum Length: 50

  The name of a published, unpublished, or draft form version.

{
    "required":[
        "DisplayName",
        "FormCode",
        "FormTypeCode",
        "Name",
        "StatusCode",
        "VersionName"
    ],
    "type":"object",
    "properties":{
        "AdmitEndDate":{
            "title":"Admit End Date",
            "type":"string",
            "description":"Admit academic period ending date.",
            "format":"date",
            "nullable":true
        },
        "AdmitStartDate":{
            "title":"Admit Start Date",
            "type":"string",
            "description":"Admit academic period starting date.",
            "format":"date",
            "nullable":true
        },
        "AdmitTypeCode":{
            "title":"Admit Type",
            "maxLength":30,
            "type":"string",
            "description":"Type of applicant before entry to the academic institution, for example a transfer applicant.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "LabelFromField":"AdmitTypeMeaning"
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"The description of an application form.",
            "nullable":true,
            "x-queryable":false
        },
        "DisplayName":{
            "title":"Display Name",
            "maxLength":100,
            "type":"string",
            "description":"Form name that's displayed to the user.",
            "nullable":false
        },
        "FormCode":{
            "title":"Form Code",
            "maxLength":50,
            "type":"string",
            "description":"The unique code of a form.",
            "nullable":false
        },
        "FormTypeCode":{
            "title":"Form Type",
            "maxLength":30,
            "type":"string",
            "description":"Code for form type, for example admissions application or residency appeal.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "LabelFromField":"FormTypeMeaning"
            }
        },
        "Name":{
            "title":"Form Name",
            "maxLength":100,
            "type":"string",
            "description":"Form name, such as arts admissions application form.",
            "nullable":false
        },
        "StatusCode":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"Form status code, for example unpublished, published, or archived.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "LabelFromField":"StatusMeaning"
            }
        },
        "VersionDescription":{
            "title":"Version Description",
            "maxLength":240,
            "type":"string",
            "description":"The description of a published, unpublished, or draft form version.",
            "nullable":true
        },
        "VersionName":{
            "title":"Version Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of a published, unpublished, or draft form version.",
            "nullable":false
        },
        "applicationAdmitPeriods":{
            "title":"Application Admit Periods",
            "type":"array",
            "description":"The application admit period is child to application form definition and provides information about the admit periods form metadata.",
            "items":{
                "$ref":"#/components/schemas/applicationFormDefinitions-applicationAdmitPeriods-item-patch-request"
            }
        },
        "applicationPrograms":{
            "title":"Application Programs",
            "type":"array",
            "description":"The application program is child to the application form definition and provides information about the programs form metadata.",
            "items":{
                "$ref":"#/components/schemas/applicationFormDefinitions-applicationPrograms-item-patch-request"
            }
        },
        "entityAssignments":{
            "title":"Entity Assignments",
            "type":"array",
            "description":"Academic entities such as institutions, campuses, or organizations assigned to application forms.",
            "items":{
                "$ref":"#/components/schemas/applicationFormDefinitions-entityAssignments-item-patch-request"
            }
        },
        "formFragments":{
            "title":"Form Fragments",
            "type":"array",
            "description":"The form fragment is child to the application form definition and provides information about various parts of the form.",
            "items":{
                "$ref":"#/components/schemas/applicationFormDefinitions-formFragments-item-patch-request"
            }
        }
    }
}

Nested Schema : Application Admit Periods

Type: array

Title: Application Admit Periods

The application admit period is child to application form definition and provides information about the admit periods form metadata.

Show Source

• Array of: object schema

{
    "title":"Application Admit Periods",
    "type":"array",
    "description":"The application admit period is child to application form definition and provides information about the admit periods form metadata.",
    "items":{
        "$ref":"#/components/schemas/applicationFormDefinitions-applicationAdmitPeriods-item-patch-request"
    }
}

Nested Schema : Application Programs

Type: array

Title: Application Programs

The application program is child to the application form definition and provides information about the programs form metadata.

Show Source

• Array of: object applicationFormDefinitions-applicationPrograms-item-patch-request

{
    "title":"Application Programs",
    "type":"array",
    "description":"The application program is child to the application form definition and provides information about the programs form metadata.",
    "items":{
        "$ref":"#/components/schemas/applicationFormDefinitions-applicationPrograms-item-patch-request"
    }
}

Nested Schema : Entity Assignments

Type: array

Title: Entity Assignments

Academic entities such as institutions, campuses, or organizations assigned to application forms.

Show Source

• Array of: object schema

{
    "title":"Entity Assignments",
    "type":"array",
    "description":"Academic entities such as institutions, campuses, or organizations assigned to application forms.",
    "items":{
        "$ref":"#/components/schemas/applicationFormDefinitions-entityAssignments-item-patch-request"
    }
}

Nested Schema : Form Fragments

Type: array

Title: Form Fragments

The form fragment is child to the application form definition and provides information about various parts of the form.

Show Source

• Array of: object schema

{
    "title":"Form Fragments",
    "type":"array",
    "description":"The form fragment is child to the application form definition and provides information about various parts of the form.",
    "items":{
        "$ref":"#/components/schemas/applicationFormDefinitions-formFragments-item-patch-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• RequestAction: string
  Title: Request Action

  Maximum Length: 80

  The request action that's performed when passed by the client during an update. When set to DELETE, the record is deleted. The only accepted value for request action is DELETE.

{
    "type":"object",
    "properties":{
        "RequestAction":{
            "title":"Request Action",
            "maxLength":80,
            "type":"string",
            "description":"The request action that's performed when passed by the client during an update. When set to DELETE, the record is deleted. The only accepted value for request action is DELETE.",
            "nullable":true,
            "x-queryable":false
        }
    }
}

Nested Schema : applicationFormDefinitions-applicationPrograms-item-patch-request

Type: object

Show Source

• CourseSelectorFlag: boolean
  Title: Course Selector

  Maximum Length: 1

  Default Value: false

  Indicates if the course selector is used for this program.
• RequestAction: string
  Title: Request Action

  Maximum Length: 80

  The request action that's performed when passed by the client during an update. When set to DELETE, the record is deleted. The only accepted value for request action is DELETE.

{
    "type":"object",
    "properties":{
        "CourseSelectorFlag":{
            "title":"Course Selector",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if the course selector is used for this program.",
            "nullable":false,
            "default":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "RequestAction":{
            "title":"Request Action",
            "maxLength":80,
            "type":"string",
            "description":"The request action that's performed when passed by the client during an update. When set to DELETE, the record is deleted. The only accepted value for request action is DELETE.",
            "nullable":true,
            "x-queryable":false
        }
    }
}

Nested Schema : schema

Type: object

Show Source

• RequestAction: string
  Title: Request Action

  Maximum Length: 80

  The request action performed when passed by the user during an update. If set to DELETE, the record is deleted. The only accepted value for request action is DELETE.

{
    "type":"object",
    "properties":{
        "RequestAction":{
            "title":"Request Action",
            "maxLength":80,
            "type":"string",
            "description":"The request action performed when passed by the user during an update. If set to DELETE, the record is deleted. The only accepted value for request action is DELETE.",
            "nullable":true,
            "x-queryable":false
        }
    }
}

Nested Schema : schema

Type: object

Show Source

• FragmentContent: string (byte)
  Title: Fragment Content

  Form fragment content, for example, the XML content of the section.
• FragmentTypeCode: string
  Title: Fragment Type Code

  Maximum Length: 30

  Form fragment type code, for example form and section.
• RequestAction: string
  Title: Request Action

  Maximum Length: 80

  The request action that's performed when passed by the client during an update. When set to DELETE, the record is deleted. The only accepted value for request action is DELETE.

{
    "type":"object",
    "properties":{
        "FragmentContent":{
            "title":"Fragment Content",
            "type":"string",
            "description":"Form fragment content, for example, the XML content of the section.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "FragmentTypeCode":{
            "title":"Fragment Type Code",
            "maxLength":30,
            "type":"string",
            "description":"Form fragment type code, for example form and section.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "LabelFromField":"FragmentTypeMeaning"
            }
        },
        "RequestAction":{
            "title":"Request Action",
            "maxLength":80,
            "type":"string",
            "description":"The request action that's performed when passed by the client during an update. When set to DELETE, the record is deleted. The only accepted value for request action is DELETE.",
            "nullable":true,
            "x-queryable":false
        }
    }
}

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 : applicationFormDefinitions-item-response

Type: object

Show Source

• AdmitEndDate: string (date)
  Title: Admit End Date

  Admit academic period ending date.
• AdmitStartDate: string (date)
  Title: Admit Start Date

  Admit academic period starting date.
• AdmitTypeCode: string
  Title: Admit Type

  Maximum Length: 30

  Type of applicant before entry to the academic institution, for example a transfer applicant.
• AdmitTypeMeaning: string
  Title: Admit Type

  Read Only: true

  Maximum Length: 80

  Meaning of admit type code.
• applicationAdmitPeriods: array Application Admit Periods
  Title: Application Admit Periods

  The application admit period is child to application form definition and provides information about the admit periods form metadata.
• applicationPrograms: array Application Programs
  Title: Application Programs

  The application program is child to the application form definition and provides information about the programs form metadata.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  Indicates who created a record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  Date when the record was created.
• Description: string
  Title: Description

  Maximum Length: 240

  The description of an application form.
• DisplayName: string
  Title: Display Name

  Maximum Length: 100

  Form name that's displayed to the user.
• entityAssignments: array Entity Assignments
  Title: Entity Assignments

  Academic entities such as institutions, campuses, or organizations assigned to application forms.
• FormCode: string
  Title: Form Code

  Maximum Length: 50

  The unique code of a form.
• formFragments: array Form Fragments
  Title: Form Fragments

  The form fragment is child to the application form definition and provides information about various parts of the form.
• FormId: integer (int64)
  Title: Form ID

  Read Only: true

  The generated unique identifier for form.
• FormTypeCode: string
  Title: Form Type

  Maximum Length: 30

  Code for form type, for example admissions application or residency appeal.
• FormTypeMeaning: string
  Title: Form Type

  Read Only: true

  Maximum Length: 80

  Meaning of form type code.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  Date when the record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  Indicates who last updated a record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Name: string
  Title: Form Name

  Maximum Length: 100

  Form name, such as arts admissions application form.
• StatusCode: string
  Title: Status

  Maximum Length: 30

  Form status code, for example unpublished, published, or archived.
• StatusMeaning: string
  Title: Status

  Read Only: true

  Maximum Length: 80

  Meaning of status code.
• VersionDescription: string
  Title: Version Description

  Maximum Length: 240

  The description of a published, unpublished, or draft form version.
• VersionName: string
  Title: Version Name

  Maximum Length: 50

  The name of a published, unpublished, or draft form version.
• VersionNumber: integer (int32)
  Title: Version Number

  Read Only: true

  The version number of a published, unpublished, or draft form version.

{
    "type":"object",
    "properties":{
        "AdmitEndDate":{
            "title":"Admit End Date",
            "type":"string",
            "description":"Admit academic period ending date.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "AdmitStartDate":{
            "title":"Admit Start Date",
            "type":"string",
            "description":"Admit academic period starting date.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "AdmitTypeCode":{
            "title":"Admit Type",
            "maxLength":30,
            "type":"string",
            "description":"Type of applicant before entry to the academic institution, for example a transfer applicant.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "LabelFromField":"AdmitTypeMeaning"
            },
            "x-queryable":true
        },
        "AdmitTypeMeaning":{
            "title":"Admit Type",
            "maxLength":80,
            "type":"string",
            "description":"Meaning of admit type code.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"Indicates who created a record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "Description":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"The description of an application form.",
            "nullable":true,
            "x-queryable":false
        },
        "DisplayName":{
            "title":"Display Name",
            "maxLength":100,
            "type":"string",
            "description":"Form name that's displayed to the user.",
            "nullable":false,
            "x-queryable":true
        },
        "FormCode":{
            "title":"Form Code",
            "maxLength":50,
            "type":"string",
            "description":"The unique code of a form.",
            "nullable":false,
            "x-queryable":true
        },
        "FormId":{
            "title":"Form ID",
            "type":"integer",
            "description":"The generated unique identifier for form.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "FormTypeCode":{
            "title":"Form Type",
            "maxLength":30,
            "type":"string",
            "description":"Code for form type, for example admissions application or residency appeal.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "LabelFromField":"FormTypeMeaning"
            },
            "x-queryable":true
        },
        "FormTypeMeaning":{
            "title":"Form Type",
            "maxLength":80,
            "type":"string",
            "description":"Meaning of form type code.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"Indicates who last updated a record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "Name":{
            "title":"Form Name",
            "maxLength":100,
            "type":"string",
            "description":"Form name, such as arts admissions application form.",
            "nullable":false,
            "x-queryable":true
        },
        "StatusCode":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"Form status code, for example unpublished, published, or archived.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "LabelFromField":"StatusMeaning"
            },
            "x-queryable":true
        },
        "StatusMeaning":{
            "title":"Status",
            "maxLength":80,
            "type":"string",
            "description":"Meaning of status code.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "VersionDescription":{
            "title":"Version Description",
            "maxLength":240,
            "type":"string",
            "description":"The description of a published, unpublished, or draft form version.",
            "nullable":true,
            "x-queryable":true
        },
        "VersionName":{
            "title":"Version Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of a published, unpublished, or draft form version.",
            "nullable":false,
            "x-queryable":true
        },
        "VersionNumber":{
            "title":"Version Number",
            "type":"integer",
            "description":"The version number of a published, unpublished, or draft form version.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "applicationAdmitPeriods":{
            "title":"Application Admit Periods",
            "type":"array",
            "description":"The application admit period is child to application form definition and provides information about the admit periods form metadata.",
            "items":{
                "$ref":"#/components/schemas/applicationFormDefinitions-applicationAdmitPeriods-item-response"
            }
        },
        "applicationPrograms":{
            "title":"Application Programs",
            "type":"array",
            "description":"The application program is child to the application form definition and provides information about the programs form metadata.",
            "items":{
                "$ref":"#/components/schemas/applicationFormDefinitions-applicationPrograms-item-response"
            }
        },
        "entityAssignments":{
            "title":"Entity Assignments",
            "type":"array",
            "description":"Academic entities such as institutions, campuses, or organizations assigned to application forms.",
            "items":{
                "$ref":"#/components/schemas/applicationFormDefinitions-entityAssignments-item-response"
            }
        },
        "formFragments":{
            "title":"Form Fragments",
            "type":"array",
            "description":"The form fragment is child to the application form definition and provides information about various parts of the form.",
            "items":{
                "$ref":"#/components/schemas/applicationFormDefinitions-formFragments-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Application Admit Periods

Type: array

Title: Application Admit Periods

The application admit period is child to application form definition and provides information about the admit periods form metadata.

Show Source

• Array of: object applicationFormDefinitions-applicationAdmitPeriods-item-response

{
    "title":"Application Admit Periods",
    "type":"array",
    "description":"The application admit period is child to application form definition and provides information about the admit periods form metadata.",
    "items":{
        "$ref":"#/components/schemas/applicationFormDefinitions-applicationAdmitPeriods-item-response"
    }
}

Nested Schema : Application Programs

Type: array

Title: Application Programs

The application program is child to the application form definition and provides information about the programs form metadata.

Show Source

• Array of: object applicationFormDefinitions-applicationPrograms-item-response

{
    "title":"Application Programs",
    "type":"array",
    "description":"The application program is child to the application form definition and provides information about the programs form metadata.",
    "items":{
        "$ref":"#/components/schemas/applicationFormDefinitions-applicationPrograms-item-response"
    }
}

Nested Schema : Entity Assignments

Type: array

Title: Entity Assignments

Academic entities such as institutions, campuses, or organizations assigned to application forms.

Show Source

• Array of: object applicationFormDefinitions-entityAssignments-item-response

{
    "title":"Entity Assignments",
    "type":"array",
    "description":"Academic entities such as institutions, campuses, or organizations assigned to application forms.",
    "items":{
        "$ref":"#/components/schemas/applicationFormDefinitions-entityAssignments-item-response"
    }
}

Nested Schema : Form Fragments

Type: array

Title: Form Fragments

The form fragment is child to the application form definition and provides information about various parts of the form.

Show Source

• Array of: object applicationFormDefinitions-formFragments-item-response

{
    "title":"Form Fragments",
    "type":"array",
    "description":"The form fragment is child to the application form definition and provides information about various parts of the form.",
    "items":{
        "$ref":"#/components/schemas/applicationFormDefinitions-formFragments-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 : applicationFormDefinitions-applicationAdmitPeriods-item-response

Type: object

Show Source

• AdmissionEndDate: string (date-time)
  Title: Admission End Date

  Read Only: true

  The date when an admission period ends.
• AdmissionPeriodCode: string
  Title: Period Code

  Maximum Length: 30

  The code for the admission period.
• AdmissionPeriodId: integer (int64)
  Title: Admission Period ID

  The unique identifier for the admissions period assigned to the application.
• AdmissionPeriodName: string
  Title: Admission Period

  Read Only: true

  Maximum Length: 50

  The name of the admission period.
• AdmissionStartDate: string (date-time)
  Title: Admission Start Date

  Read Only: true

  The date when an admission period starts.
• FormAdmitPeriodId: integer (int64)
  Title: Admit Period

  Read Only: true

  Form admit period identifier.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• RequestAction: string
  Title: Request Action

  Maximum Length: 80

  The request action that's performed when passed by the client during an update. When set to DELETE, the record is deleted. The only accepted value for request action is DELETE.

{
    "type":"object",
    "properties":{
        "AdmissionEndDate":{
            "title":"Admission End Date",
            "type":"string",
            "description":"The date when an admission period ends.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AdmissionPeriodCode":{
            "title":"Period Code",
            "maxLength":30,
            "type":"string",
            "description":"The code for the admission period.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AdmissionPeriodId":{
            "title":"Admission Period ID",
            "type":"integer",
            "description":"The unique identifier for the admissions period assigned to the application.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AdmissionPeriodName":{
            "title":"Admission Period",
            "maxLength":50,
            "type":"string",
            "description":"The name of the admission period.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AdmissionStartDate":{
            "title":"Admission Start Date",
            "type":"string",
            "description":"The date when an admission period starts.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FormAdmitPeriodId":{
            "title":"Admit Period",
            "type":"integer",
            "description":"Form admit period identifier.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "RequestAction":{
            "title":"Request Action",
            "maxLength":80,
            "type":"string",
            "description":"The request action that's performed when passed by the client during an update. When set to DELETE, the record is deleted. The only accepted value for request action is DELETE.",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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

Type: object

Show Source

• CourseSelectorFlag: boolean
  Title: Course Selector

  Maximum Length: 1

  Default Value: false

  Indicates if the course selector is used for this program.
• FormApplicationProgId: integer (int64)
  Title: Form Application Program ID

  Read Only: true

  Form admissions application program identifier.
• links: array Links
  Title: Links

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

  Maximum Length: 150

  The curriculum code of the program.
• ProgramItemCurriculumId: integer (int64)
  Title: Program Item Curriculum ID

  Curriculum item identifier for the program.
• ProgramName: string
  Title: Program

  Read Only: true

  Maximum Length: 150

  Name of the curriculum program.
• RequestAction: string
  Title: Request Action

  Maximum Length: 80

  The request action that's performed when passed by the client during an update. When set to DELETE, the record is deleted. The only accepted value for request action is DELETE.

{
    "type":"object",
    "properties":{
        "CourseSelectorFlag":{
            "title":"Course Selector",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if the course selector is used for this program.",
            "nullable":false,
            "default":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "FormApplicationProgId":{
            "title":"Form Application Program ID",
            "type":"integer",
            "description":"Form admissions application program identifier.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ProgramItemCurriculumCode":{
            "title":"Program Code",
            "maxLength":150,
            "type":"string",
            "description":"The curriculum code of the program.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ProgramItemCurriculumId":{
            "title":"Program Item Curriculum ID",
            "type":"integer",
            "description":"Curriculum item identifier for the program.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "LabelFromField":"AdmitTypeMeaning"
            },
            "x-queryable":true
        },
        "ProgramName":{
            "title":"Program",
            "maxLength":150,
            "type":"string",
            "description":"Name of the curriculum program.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RequestAction":{
            "title":"Request Action",
            "maxLength":80,
            "type":"string",
            "description":"The request action that's performed when passed by the client during an update. When set to DELETE, the record is deleted. The only accepted value for request action is DELETE.",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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 : applicationFormDefinitions-entityAssignments-item-response

Type: object

Show Source

• AssignedEntityCode: string
  Title: Entity Code

  Maximum Length: 100

  The code of the associated entity.
• AssignedEntityId: integer (int64)
  Title: Entity ID

  The unique identifier of the associated entity.
• AssignedEntityName: string
  Title: Entity Name

  Read Only: true

  Maximum Length: 100

  The name of the associated entity.
• AssignedEntityTypeCode: string
  Title: Entity Type Code

  Maximum Length: 30

  The entity type code of the associated entity. A list of accepted values is defined in the lookup type ORA_HER_ASSOCIATED_OBJECT_TYPE.
• AssignedEntityTypeMeaning: string
  Title: Entity Type

  Read Only: true

  Maximum Length: 80

  The entity type of the associated entity.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• RequestAction: string
  Title: Request Action

  Maximum Length: 80

  The request action performed when passed by the user during an update. If set to DELETE, the record is deleted. The only accepted value for request action is DELETE.
• SettingsAssignmentId: integer (int64)
  Title: Settings Assignment ID

  Read Only: true

  The unique identifier for the setup association record.

{
    "type":"object",
    "properties":{
        "AssignedEntityCode":{
            "title":"Entity Code",
            "maxLength":100,
            "type":"string",
            "description":"The code of the associated entity.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AssignedEntityId":{
            "title":"Entity ID",
            "type":"integer",
            "description":"The unique identifier of the associated entity.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AssignedEntityName":{
            "title":"Entity Name",
            "maxLength":100,
            "type":"string",
            "description":"The name of the associated entity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssignedEntityTypeCode":{
            "title":"Entity Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The entity type code of the associated entity. A list of accepted values is defined in the lookup type ORA_HER_ASSOCIATED_OBJECT_TYPE.",
            "nullable":false,
            "x-queryable":true
        },
        "AssignedEntityTypeMeaning":{
            "title":"Entity Type",
            "maxLength":80,
            "type":"string",
            "description":"The entity type of the associated entity.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RequestAction":{
            "title":"Request Action",
            "maxLength":80,
            "type":"string",
            "description":"The request action performed when passed by the user during an update. If set to DELETE, the record is deleted. The only accepted value for request action is DELETE.",
            "nullable":true,
            "x-queryable":false
        },
        "SettingsAssignmentId":{
            "title":"Settings Assignment ID",
            "type":"integer",
            "description":"The unique identifier for the setup association record.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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 : applicationFormDefinitions-formFragments-item-response

Type: object

Show Source

• FormFragmentId: integer (int64)
  Title: Form Fragment ID

  Read Only: true

  Form builder form fragment identifier.
• FragmentContent: string (byte)
  Title: Fragment Content

  Form fragment content, for example, the XML content of the section.
• FragmentTypeCode: string
  Title: Fragment Type Code

  Maximum Length: 30

  Form fragment type code, for example form and section.
• FragmentTypeMeaning: string
  Title: Fragment Type

  Read Only: true

  Maximum Length: 80

  Meaning of form type code.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• RequestAction: string
  Title: Request Action

  Maximum Length: 80

  The request action that's performed when passed by the client during an update. When set to DELETE, the record is deleted. The only accepted value for request action is DELETE.

{
    "type":"object",
    "properties":{
        "FormFragmentId":{
            "title":"Form Fragment ID",
            "type":"integer",
            "description":"Form builder form fragment identifier.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "FragmentContent":{
            "title":"Fragment Content",
            "type":"string",
            "description":"Form fragment content, for example, the XML content of the section.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "FragmentTypeCode":{
            "title":"Fragment Type Code",
            "maxLength":30,
            "type":"string",
            "description":"Form fragment type code, for example form and section.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "LabelFromField":"FragmentTypeMeaning"
            },
            "x-queryable":true
        },
        "FragmentTypeMeaning":{
            "title":"Fragment Type",
            "maxLength":80,
            "type":"string",
            "description":"Meaning of form type code.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RequestAction":{
            "title":"Request Action",
            "maxLength":80,
            "type":"string",
            "description":"The request action that's performed when passed by the client during an update. When set to DELETE, the record is deleted. The only accepted value for request action is DELETE.",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Links

AdmitTypeCodeLOV

Operation: /fscmRestApi/resources/11.13.18.05/heqLookups

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_HEQ_ADMIT_TYPE

The following properties are defined on the LOV link relation:

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

FormStatusCodeLOV

Operation: /fscmRestApi/resources/11.13.18.05/heyLookups

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_HEY_VERSION_STATUS

The following properties are defined on the LOV link relation:

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

FormTypeCodeLOV

Operation: /fscmRestApi/resources/11.13.18.05/heyLookups

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_HEY_FORM_TYPE

The following properties are defined on the LOV link relation:

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

applicationAdmitPeriods

Operation: /fscmRestApi/resources/11.13.18.05/applicationFormDefinitions/{applicationFormDefinitionsUniqID}/child/applicationAdmitPeriods

Parameters:

• applicationFormDefinitionsUniqID: $request.path.applicationFormDefinitionsUniqID

The application admit period is child to application form definition and provides information about the admit periods form metadata.

applicationPrograms

Operation: /fscmRestApi/resources/11.13.18.05/applicationFormDefinitions/{applicationFormDefinitionsUniqID}/child/applicationPrograms

Parameters:

• applicationFormDefinitionsUniqID: $request.path.applicationFormDefinitionsUniqID

The application program is child to the application form definition and provides information about the programs form metadata.

entityAssignments

Operation: /fscmRestApi/resources/11.13.18.05/applicationFormDefinitions/{applicationFormDefinitionsUniqID}/child/entityAssignments

Parameters:

• applicationFormDefinitionsUniqID: $request.path.applicationFormDefinitionsUniqID

Academic entities such as institutions, campuses, or organizations assigned to application forms.

formFragments

Operation: /fscmRestApi/resources/11.13.18.05/applicationFormDefinitions/{applicationFormDefinitionsUniqID}/child/formFragments

Parameters:

• applicationFormDefinitionsUniqID: $request.path.applicationFormDefinitionsUniqID

The form fragment is child to the application form definition and provides information about various parts of the form.

Back to Top