Jump to

• Request
• Response

Update an application program

patch

/fscmRestApi/resources/11.13.18.05/applicationFormDefinitions/{FormId}/child/applicationPrograms/{applicationProgramsUniqID}

Request

Path Parameters

• FormId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
• applicationProgramsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Application Programs resource and used to uniquely identify an instance of Application Programs. The client should not generate the hash key value. Instead, the client should query on the Application Programs collection resource in order to navigate to a specific instance of Application Programs to get the hash key.

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.

Supported Media Types

• application/json

Request Body - application/json ()

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

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

Type: object

Show Source

• href: string
  Title: hyperlink reference

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

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

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

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

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

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

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

Nested Schema : properties

Type: object

Show Source

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

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

Links

ProgramLOV

Operation: /fscmRestApi/resources/11.13.18.05/programs

The following properties are defined on the LOV link relation:

• Source Attribute: ProgramItemCurriculumId; Target Attribute: CurriculumId
• Display Attribute: CurriculumName

Back to Top