Jump to

• Request
• Response

Create an application form

post

/fscmRestApi/resources/11.13.18.05/applicationFormDefinitions

Request

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.
• Upsert-Mode:
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• AcademicLevelId(required): integer (int64)
  Title: Academic Level ID

  Admissions application academic level identifier.
• AcademicProgramGroupId: integer (int64)
  Title: Academic Group ID

  Academic group identifier for the program.
• AcademicProgramTypeCode(required): string
  Title: Academic Program Type

  Maximum Length: 30

  Type of program, such as a program with specialization.
• AdmitEndDate: string (date)
  Title: Admit End Date

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

  Admit academic period starting date.
• AdmitStartTypeCode(required): string
  Title: Admit Start Type

  Maximum Length: 30

  Admit start type, for example starting academic period or start 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.
• CampusId: integer (int64)
  Title: Campus ID

  Unique identifier for the campus associated with the form.
• 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.
• 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.
• FormId: integer (int64)
  Title: Form ID

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

  Maximum Length: 30

  Code for form type, for example admissions application or residency appeal.
• InstitutionId(required): integer (int64)
  Title: Institution ID

  Unique identifier for the institution associated with the form.
• 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":[
        "AcademicLevelId",
        "AcademicProgramTypeCode",
        "AdmitStartTypeCode",
        "DisplayName",
        "FormCode",
        "FormTypeCode",
        "InstitutionId",
        "Name",
        "StatusCode",
        "VersionName"
    ],
    "type":"object",
    "properties":{
        "AdmitEndDate":{
            "title":"Admit End Date",
            "type":"string",
            "description":"Admit academic period ending date.",
            "format":"date",
            "nullable":true
        },
        "VersionDescription":{
            "title":"Version Description",
            "maxLength":"240",
            "type":"string",
            "description":"The description of a published, unpublished, or draft form version.",
            "nullable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"240",
            "type":"string",
            "description":"The description of an application form.",
            "nullable":true,
            "x-queryable":false
        },
        "InstitutionId":{
            "title":"Institution ID",
            "type":"integer",
            "description":"Unique identifier for the institution associated with the form.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":"18",
                "LabelFromField":"InstitutionName"
            }
        },
        "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-post-request"
            }
        },
        "AcademicProgramGroupId":{
            "title":"Academic Group ID",
            "type":"integer",
            "description":"Academic group identifier for the program.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":"18",
                "LabelFromField":"AcademicProgramGroupName"
            }
        },
        "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"
            }
        },
        "AdmitStartTypeCode":{
            "title":"Admit Start Type",
            "maxLength":"30",
            "type":"string",
            "description":"Admit start type, for example starting academic period or start date.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "LabelFromField":"AdmitStartTypeMeaning"
            }
        },
        "AdmitStartDate":{
            "title":"Admit Start Date",
            "type":"string",
            "description":"Admit academic period starting date.",
            "format":"date",
            "nullable":true
        },
        "Name":{
            "title":"Form Name",
            "maxLength":"100",
            "type":"string",
            "description":"Form name, such as arts admissions application form.",
            "nullable":false
        },
        "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"
            }
        },
        "AcademicProgramTypeCode":{
            "title":"Academic Program Type",
            "maxLength":"30",
            "type":"string",
            "description":"Type of program, such as a program with specialization.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "LabelFromField":"AcademicProgramTypeMeaning"
            }
        },
        "AcademicLevelId":{
            "title":"Academic Level ID",
            "type":"integer",
            "description":"Admissions application academic level identifier.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":"18",
                "LabelFromField":"AcademicLevelName"
            }
        },
        "CampusId":{
            "title":"Campus ID",
            "type":"integer",
            "description":"Unique identifier for the campus associated with the form.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":"18",
                "LabelFromField":"CampusName"
            }
        },
        "DisplayName":{
            "title":"Display Name",
            "maxLength":"100",
            "type":"string",
            "description":"Form name that's displayed to the user.",
            "nullable":false
        },
        "VersionName":{
            "title":"Version Name",
            "maxLength":"50",
            "type":"string",
            "description":"The name of a published, unpublished, or draft form version.",
            "nullable":false
        },
        "FormId":{
            "title":"Form ID",
            "type":"integer",
            "description":"The generated unique identifier for form.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"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"
            }
        },
        "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-post-request"
            }
        },
        "FormCode":{
            "title":"Form Code",
            "maxLength":"50",
            "type":"string",
            "description":"The unique code of a form.",
            "nullable":false
        },
        "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-post-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-post-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 schema

{
    "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-post-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-post-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• AdmitAcademicPeriodId: integer (int64)
  Title: Admit Academic Period ID

  Admit academic period identifier.
• FormAdmitPeriodId: integer (int64)
  Title: Admit Period

  Form admit period identifier.
• 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":{
        "FormAdmitPeriodId":{
            "title":"Admit Period",
            "type":"integer",
            "description":"Form admit period identifier.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"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
        },
        "AdmitAcademicPeriodId":{
            "title":"Admit Academic Period ID",
            "type":"integer",
            "description":"Admit academic period identifier.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            }
        }
    }
}

Nested Schema : schema

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

  Form admissions application program identifier.
• ProgramItemCurriculumId: integer (int64)
  Title: Program Item Curriculum ID

  Curriculum item identifier for the 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"
            }
        },
        "FormApplicationProgId":{
            "title":"Form Application Program ID",
            "type":"integer",
            "description":"Form admissions application program identifier.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"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
        },
        "ProgramItemCurriculumId":{
            "title":"Program Item Curriculum ID",
            "type":"integer",
            "description":"Curriculum item identifier for the program.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":"18",
                "LabelFromField":"AdmitTypeMeaning"
            }
        }
    }
}

Nested Schema : schema

Type: object

Show Source

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

  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.
• 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,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"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
        },
        "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
        },
        "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"
            }
        }
    }
}

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

• AcademicLevelId: integer (int64)
  Title: Academic Level ID

  Admissions application academic level identifier.
• AcademicLevelName: string
  Title: Academic Level

  Read Only: true

  Maximum Length: 100

  Name of academic level.
• AcademicProgramGroupId: integer (int64)
  Title: Academic Group ID

  Academic group identifier for the program.
• AcademicProgramGroupName: string
  Title: Academic Group

  Read Only: true

  Maximum Length: 50

  Name of academic program group.
• AcademicProgramTypeCode: string
  Title: Academic Program Type

  Maximum Length: 30

  Type of program, such as a program with specialization.
• AcademicProgramTypeMeaning: string
  Title: Academic Program Type

  Read Only: true

  Maximum Length: 80

  Meaning of type of program.
• AdmitEndDate: string (date)
  Title: Admit End Date

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

  Admit academic period starting date.
• AdmitStartTypeCode: string
  Title: Admit Start Type

  Maximum Length: 30

  Admit start type, for example starting academic period or start date.
• AdmitStartTypeMeaning: string
  Title: Admit Start Type

  Read Only: true

  Maximum Length: 80

  Meaning of admit start type code.
• 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.
• CampusId: integer (int64)
  Title: Campus ID

  Unique identifier for the campus associated with the form.
• CampusName: string
  Title: Campus

  Read Only: true

  Maximum Length: 50

  Name of the campus.
• 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.
• 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

  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.
• InstitutionId: integer (int64)
  Title: Institution ID

  Unique identifier for the institution associated with the form.
• InstitutionName: string
  Title: Institution

  Read Only: true

  Maximum Length: 50

  Name of the institution.
• 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
        },
        "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
        },
        "CampusName":{
            "title":"Campus",
            "maxLength":"50",
            "type":"string",
            "description":"Name of the campus.",
            "nullable":false,
            "readOnly":true,
            "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
        },
        "AdmitStartTypeCode":{
            "title":"Admit Start Type",
            "maxLength":"30",
            "type":"string",
            "description":"Admit start type, for example starting academic period or start date.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "LabelFromField":"AdmitStartTypeMeaning"
            },
            "x-queryable":true
        },
        "AdmitStartDate":{
            "title":"Admit Start Date",
            "type":"string",
            "description":"Admit academic period starting date.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "FormTypeMeaning":{
            "title":"Form Type",
            "maxLength":"80",
            "type":"string",
            "description":"Meaning of form type code.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Name":{
            "title":"Form Name",
            "maxLength":"100",
            "type":"string",
            "description":"Form name, such as arts admissions application form.",
            "nullable":false,
            "x-queryable":true
        },
        "AcademicProgramTypeCode":{
            "title":"Academic Program Type",
            "maxLength":"30",
            "type":"string",
            "description":"Type of program, such as a program with specialization.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "LabelFromField":"AcademicProgramTypeMeaning"
            },
            "x-queryable":true
        },
        "AcademicLevelId":{
            "title":"Academic Level ID",
            "type":"integer",
            "description":"Admissions application academic level identifier.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":"18",
                "LabelFromField":"AcademicLevelName"
            },
            "x-queryable":true
        },
        "AcademicLevelName":{
            "title":"Academic Level",
            "maxLength":"100",
            "type":"string",
            "description":"Name of academic level.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DisplayName":{
            "title":"Display Name",
            "maxLength":"100",
            "type":"string",
            "description":"Form name that's displayed to the user.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AdmitStartTypeMeaning":{
            "title":"Admit Start Type",
            "maxLength":"80",
            "type":"string",
            "description":"Meaning of admit start type code.",
            "nullable":false,
            "readOnly":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
        },
        "FormId":{
            "title":"Form ID",
            "type":"integer",
            "description":"The generated unique identifier for form.",
            "format":"int64",
            "nullable":false,
            "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
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"Indicates who last updated a record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"Indicates who created a record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "VersionDescription":{
            "title":"Version Description",
            "maxLength":"240",
            "type":"string",
            "description":"The description of a published, unpublished, or draft form version.",
            "nullable":true,
            "x-queryable":true
        },
        "InstitutionName":{
            "title":"Institution",
            "maxLength":"50",
            "type":"string",
            "description":"Name of the institution.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "InstitutionId":{
            "title":"Institution ID",
            "type":"integer",
            "description":"Unique identifier for the institution associated with the form.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":"18",
                "LabelFromField":"InstitutionName"
            },
            "x-queryable":true
        },
        "AcademicProgramGroupName":{
            "title":"Academic Group",
            "maxLength":"50",
            "type":"string",
            "description":"Name of academic program group.",
            "nullable":false,
            "readOnly":true,
            "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"
            }
        },
        "AcademicProgramGroupId":{
            "title":"Academic Group ID",
            "type":"integer",
            "description":"Academic group identifier for the program.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":"18",
                "LabelFromField":"AcademicProgramGroupName"
            },
            "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
        },
        "AcademicProgramTypeMeaning":{
            "title":"Academic Program Type",
            "maxLength":"80",
            "type":"string",
            "description":"Meaning of type of program.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StatusMeaning":{
            "title":"Status",
            "maxLength":"80",
            "type":"string",
            "description":"Meaning of status code.",
            "nullable":false,
            "readOnly":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
        },
        "CampusId":{
            "title":"Campus ID",
            "type":"integer",
            "description":"Unique identifier for the campus associated with the form.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":"18",
                "LabelFromField":"CampusName"
            },
            "x-queryable":true
        },
        "AdmitTypeMeaning":{
            "title":"Admit Type",
            "maxLength":"80",
            "type":"string",
            "description":"Meaning of admit type code.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "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"
            }
        },
        "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
        },
        "FormCode":{
            "title":"Form Code",
            "maxLength":"50",
            "type":"string",
            "description":"The unique code of a form.",
            "nullable":false,
            "x-queryable":true
        },
        "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"
            }
        }
    }
}

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 : 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

• AdmitAcademicPeriodId: integer (int64)
  Title: Admit Academic Period ID

  Admit academic period identifier.
• AdmitAcademicPeriodName: string
  Title: Admit Academic Period

  Read Only: true

  Maximum Length: 50

  Name of admit academic period identifier.
• FormAdmitPeriodId: integer (int64)
  Title: Admit Period

  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":{
        "AdmitAcademicPeriodName":{
            "title":"Admit Academic Period",
            "maxLength":"50",
            "type":"string",
            "description":"Name of admit academic period identifier.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "FormAdmitPeriodId":{
            "title":"Admit Period",
            "type":"integer",
            "description":"Form admit period identifier.",
            "format":"int64",
            "nullable":false,
            "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
        },
        "AdmitAcademicPeriodId":{
            "title":"Admit Academic Period ID",
            "type":"integer",
            "description":"Admit academic period identifier.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

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

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

  The link relations associated with the resource instance.
• ProgramItemCurriculumId: integer (int64)
  Title: Program Item Curriculum ID

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

  Read Only: true

  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
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "FormApplicationProgId":{
            "title":"Form Application Program ID",
            "type":"integer",
            "description":"Form admissions application program identifier.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ProgramName":{
            "title":"Program",
            "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
        },
        "ProgramItemCurriculumId":{
            "title":"Program Item Curriculum ID",
            "type":"integer",
            "description":"Curriculum item identifier for the program.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":"18",
                "LabelFromField":"AdmitTypeMeaning"
            },
            "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 : applicationFormDefinitions-formFragments-item-response

Type: object

Show Source

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

  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,
            "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"
            }
        },
        "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
        },
        "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
        },
        "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
        }
    }
}

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

AcademicGroupItemLOV

Operation: /fscmRestApi/resources/11.13.18.05/academicGroups

The following properties are defined on the LOV link relation:

• Source Attribute: AcademicProgramGroupId; Target Attribute: AcademicGroupId
• Display Attribute: CurriculumName

AcademicLevelLOV

Operation: /fscmRestApi/resources/11.13.18.05/academicLevels

The following properties are defined on the LOV link relation:

• Source Attribute: AcademicLevelId; Target Attribute: AcademicLevelId
• Display Attribute: LevelName

AcademicProgramTypeLOV

Operation: /fscmRestApi/resources/11.13.18.05/heqLookups

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_HEQ_RELEVANT_PROGRAMS

The following properties are defined on the LOV link relation:

• Source Attribute: AcademicProgramTypeCode; Target Attribute: LookupCode
• Display Attribute: LookupCode

AdmitStartTypeCodeLOV

Operation: /fscmRestApi/resources/11.13.18.05/heqLookups

Parameters:

• finder: ByLookupTypeFinder%3BLookupType%3DORA_HEQ_ADMIT_START_TYPE%2CLookupCode%3D{AdmitStartTypeCode}

The following properties are defined on the LOV link relation:

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

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

CampusLOV

Operation: /fscmRestApi/resources/11.13.18.05/campuses

The following properties are defined on the LOV link relation:

• Source Attribute: CampusId; Target Attribute: CampusId
• Display Attribute: CampusName

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

InstitutionLOV

Operation: /fscmRestApi/resources/11.13.18.05/academicInstitutions

The following properties are defined on the LOV link relation:

• Source Attribute: InstitutionId; Target Attribute: InstitutionId
• Display Attribute: InstitutionName

applicationAdmitPeriods

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

Parameters:

• FormId: $request.path.FormId

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/{FormId}/child/applicationPrograms

Parameters:

• FormId: $request.path.FormId

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

formFragments

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

Parameters:

• FormId: $request.path.FormId

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

Back to Top