Jump to

• Request
• Response

Create a requisite scheme

post

/fscmRestApi/resources/11.13.18.05/requisiteSchemes

Request

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.
• Upsert-Mode: string
  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

• EnabledFlag: boolean
  Title: Enable

  Maximum Length: 1

  Default Value: true

  Indicates whether the requisite scheme is enabled or active and available for use. The default value is true.
• MappingOptionCode: string
  Title: Mapping Option Code

  Maximum Length: 30

  Default Value: ORA_OUTCOMES

  The type of mapping used by the requisite scheme. A list of accepted values is defined in the lookup type ORA_HER_REQUISITE_SCHEME_MAP.
• requisiteSchemeDetails: array Requisite Scheme Details
  Title: Requisite Scheme Details

  The requisite schemes details resource lists the details of the requisite evaluation schemes used to define required outcomes and results when evaluating a course requisite.
• SchemeCode(required): string
  Title: Code

  Maximum Length: 30

  The code for the requisite scheme.
• SchemeDescription: string
  Title: Description

  Maximum Length: 240

  The description of the requisite scheme.
• SchemeName(required): string
  Title: Name

  Maximum Length: 50

  The name of the requisite scheme.

{
    "required":[
        "SchemeCode",
        "SchemeName"
    ],
    "type":"object",
    "properties":{
        "EnabledFlag":{
            "title":"Enable",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the requisite scheme is enabled or active and available for use. The default value is true.",
            "nullable":false,
            "default":true
        },
        "MappingOptionCode":{
            "title":"Mapping Option Code",
            "maxLength":30,
            "type":"string",
            "description":"The type of mapping used by the requisite scheme. A list of accepted values is defined in the lookup type ORA_HER_REQUISITE_SCHEME_MAP.",
            "nullable":false,
            "default":"ORA_OUTCOMES",
            "x-hints":{
                "controlType":"choice",
                "PAYLOADHINT":"Show"
            }
        },
        "SchemeCode":{
            "title":"Code",
            "maxLength":30,
            "type":"string",
            "description":"The code for the requisite scheme.",
            "nullable":false
        },
        "SchemeDescription":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"The description of the requisite scheme.",
            "nullable":true
        },
        "SchemeName":{
            "title":"Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of the requisite scheme.",
            "nullable":false
        },
        "requisiteSchemeDetails":{
            "title":"Requisite Scheme Details",
            "type":"array",
            "description":"The requisite schemes details resource lists the details of the requisite evaluation schemes used to define required outcomes and results when evaluating a course requisite.",
            "items":{
                "$ref":"#/components/schemas/requisiteSchemes-requisiteSchemeDetails-item-post-request"
            }
        }
    }
}

Nested Schema : Requisite Scheme Details

Type: array

Title: Requisite Scheme Details

The requisite schemes details resource lists the details of the requisite evaluation schemes used to define required outcomes and results when evaluating a course requisite.

Show Source

• Array of: object requisiteSchemes-requisiteSchemeDetails-item-post-request

{
    "title":"Requisite Scheme Details",
    "type":"array",
    "description":"The requisite schemes details resource lists the details of the requisite evaluation schemes used to define required outcomes and results when evaluating a course requisite.",
    "items":{
        "$ref":"#/components/schemas/requisiteSchemes-requisiteSchemeDetails-item-post-request"
    }
}

Nested Schema : requisiteSchemes-requisiteSchemeDetails-item-post-request

Type: object

Show Source

• DetailSortSequence: integer (int32)
  Title: Detail Sort Sequence

  The sort sequence of the requisite scheme details.
• OutcomeCode: string
  Title: Outcome Code

  Maximum Length: 30

  The outcome code of the result set detail.
• RequisiteStatusCode: string
  Title: Requisite Status Code

  Maximum Length: 30

  The code for the requisite status on a requisite scheme.
• ResultSetId: integer (int64)
  Title: Result Set ID

  The unique identifier for a result set.
• SequenceNumber: integer (int32)
  Title: Detail Sequence Number

  The display order of the result set detail.

{
    "type":"object",
    "properties":{
        "DetailSortSequence":{
            "title":"Detail Sort Sequence",
            "type":"integer",
            "description":"The sort sequence of the requisite scheme details.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            }
        },
        "OutcomeCode":{
            "title":"Outcome Code",
            "maxLength":30,
            "type":"string",
            "description":"The outcome code of the result set detail.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "PAYLOADHINT":"Show"
            }
        },
        "RequisiteStatusCode":{
            "title":"Requisite Status Code",
            "maxLength":30,
            "type":"string",
            "description":"The code for the requisite status on a requisite scheme.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "PAYLOADHINT":"Show"
            }
        },
        "ResultSetId":{
            "title":"Result Set ID",
            "type":"integer",
            "description":"The unique identifier for a result set.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "SequenceNumber":{
            "title":"Detail Sequence Number",
            "type":"integer",
            "description":"The display order of the result set detail.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":9
            }
        }
    }
}

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

Type: object

Show Source

• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the row.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date the row was created.
• EnabledFlag: boolean
  Title: Enable

  Maximum Length: 1

  Default Value: true

  Indicates whether the requisite scheme is enabled or active and available for use. The default value is true.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date the row was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the row.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MappingOptionCode: string
  Title: Mapping Option Code

  Maximum Length: 30

  Default Value: ORA_OUTCOMES

  The type of mapping used by the requisite scheme. A list of accepted values is defined in the lookup type ORA_HER_REQUISITE_SCHEME_MAP.
• MappingOptionMeaning: string
  Title: Mapping Option

  Read Only: true

  Maximum Length: 80

  The meaning of the mapping option code. A list of accepted values is defined in the lookup type ORA_HER_REQUISITE_SCHEME_MAP.
• requisiteSchemeDetails: array Requisite Scheme Details
  Title: Requisite Scheme Details

  The requisite schemes details resource lists the details of the requisite evaluation schemes used to define required outcomes and results when evaluating a course requisite.
• RequisiteSchemeId: integer (int64)
  Title: Requisite Scheme ID

  Read Only: true

  The unique identifier for a requisite scheme.
• SchemeCode: string
  Title: Code

  Maximum Length: 30

  The code for the requisite scheme.
• SchemeDescription: string
  Title: Description

  Maximum Length: 240

  The description of the requisite scheme.
• SchemeName: string
  Title: Name

  Maximum Length: 50

  The name of the requisite scheme.

{
    "type":"object",
    "properties":{
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date the row was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EnabledFlag":{
            "title":"Enable",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the requisite scheme is enabled or active and available for use. The default value is true.",
            "nullable":false,
            "default":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date the row was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MappingOptionCode":{
            "title":"Mapping Option Code",
            "maxLength":30,
            "type":"string",
            "description":"The type of mapping used by the requisite scheme. A list of accepted values is defined in the lookup type ORA_HER_REQUISITE_SCHEME_MAP.",
            "nullable":false,
            "default":"ORA_OUTCOMES",
            "x-hints":{
                "controlType":"choice",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "MappingOptionMeaning":{
            "title":"Mapping Option",
            "maxLength":80,
            "type":"string",
            "description":"The meaning of the mapping option code. A list of accepted values is defined in the lookup type ORA_HER_REQUISITE_SCHEME_MAP.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RequisiteSchemeId":{
            "title":"Requisite Scheme ID",
            "type":"integer",
            "description":"The unique identifier for a requisite scheme.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "SchemeCode":{
            "title":"Code",
            "maxLength":30,
            "type":"string",
            "description":"The code for the requisite scheme.",
            "nullable":false,
            "x-queryable":true
        },
        "SchemeDescription":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"The description of the requisite scheme.",
            "nullable":true,
            "x-queryable":true
        },
        "SchemeName":{
            "title":"Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of the requisite scheme.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "requisiteSchemeDetails":{
            "title":"Requisite Scheme Details",
            "type":"array",
            "description":"The requisite schemes details resource lists the details of the requisite evaluation schemes used to define required outcomes and results when evaluating a course requisite.",
            "items":{
                "$ref":"#/components/schemas/requisiteSchemes-requisiteSchemeDetails-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 : Requisite Scheme Details

Type: array

Title: Requisite Scheme Details

The requisite schemes details resource lists the details of the requisite evaluation schemes used to define required outcomes and results when evaluating a course requisite.

Show Source

• Array of: object requisiteSchemes-requisiteSchemeDetails-item-response

{
    "title":"Requisite Scheme Details",
    "type":"array",
    "description":"The requisite schemes details resource lists the details of the requisite evaluation schemes used to define required outcomes and results when evaluating a course requisite.",
    "items":{
        "$ref":"#/components/schemas/requisiteSchemes-requisiteSchemeDetails-item-response"
    }
}

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 : requisiteSchemes-requisiteSchemeDetails-item-response

Type: object

Show Source

• Description: string
  Title: Description

  Read Only: true

  Maximum Length: 240

  The description of the requisite scheme details.
• DetailSortSequence: integer (int32)
  Title: Detail Sort Sequence

  The sort sequence of the requisite scheme details.
• FromNumericValue: number
  Title: From

  Read Only: true

  The starting number for the result set detail.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OutcomeCode: string
  Title: Outcome Code

  Maximum Length: 30

  The outcome code of the result set detail.
• OutcomeMeaning: string
  Title: Outcome

  Read Only: true

  Maximum Length: 80

  The outcome of the result set detail.
• RequisiteSchemeDetailId: integer (int64)
  Title: Requisite Scheme Detail ID

  Read Only: true

  The unique identifier for the result set detail.
• RequisiteStatusCode: string
  Title: Requisite Status Code

  Maximum Length: 30

  The code for the requisite status on a requisite scheme.
• RequisiteStatusMeaning: string
  Title: Requisite Status

  Read Only: true

  Maximum Length: 80

  The description of the requisite status on a requisite scheme.
• ResultSetId: integer (int64)
  Title: Result Set ID

  The unique identifier for a result set.
• ResultSetName: string
  Title: Result Set Name

  Read Only: true

  Maximum Length: 50

  The name of a result set.
• SequenceNumber: integer (int32)
  Title: Detail Sequence Number

  The display order of the result set detail.
• TextValue: string
  Title: Text Value

  Read Only: true

  Maximum Length: 30

  The text value of the result set detail.
• ToNumericValue: number
  Title: To

  Read Only: true

  The ending number of the result set detail.

{
    "type":"object",
    "properties":{
        "Description":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"The description of the requisite scheme details.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DetailSortSequence":{
            "title":"Detail Sort Sequence",
            "type":"integer",
            "description":"The sort sequence of the requisite scheme details.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "FromNumericValue":{
            "title":"From",
            "type":"number",
            "description":"The starting number for the result set detail.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "scale":9
            },
            "x-queryable":true
        },
        "OutcomeCode":{
            "title":"Outcome Code",
            "maxLength":30,
            "type":"string",
            "description":"The outcome code of the result set detail.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "OutcomeMeaning":{
            "title":"Outcome",
            "maxLength":80,
            "type":"string",
            "description":"The outcome of the result set detail.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RequisiteSchemeDetailId":{
            "title":"Requisite Scheme Detail ID",
            "type":"integer",
            "description":"The unique identifier for the result set detail.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "RequisiteStatusCode":{
            "title":"Requisite Status Code",
            "maxLength":30,
            "type":"string",
            "description":"The code for the requisite status on a requisite scheme.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "RequisiteStatusMeaning":{
            "title":"Requisite Status",
            "maxLength":80,
            "type":"string",
            "description":"The description of the requisite status on a requisite scheme.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ResultSetId":{
            "title":"Result Set ID",
            "type":"integer",
            "description":"The unique identifier for a result set.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "ResultSetName":{
            "title":"Result Set Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of a result set.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SequenceNumber":{
            "title":"Detail Sequence Number",
            "type":"integer",
            "description":"The display order of the result set detail.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":9
            },
            "x-queryable":true
        },
        "TextValue":{
            "title":"Text Value",
            "maxLength":30,
            "type":"string",
            "description":"The text value of the result set detail.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ToNumericValue":{
            "title":"To",
            "type":"number",
            "description":"The ending number of the result set detail.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "scale":9
            },
            "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"
    }
}

Links

MappingOptionCodeLOV

Operation: /fscmRestApi/resources/11.13.18.05/herLookups

Parameters:

• finder: ByLookupTypeFinder%3BLookupType%3DORA_HER_REQUISITE_SCHEME_MAP%2CLookupCode%3D{MappingOptionCode}

The following properties are defined on the LOV link relation:

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

requisiteSchemeDetails

Operation: /fscmRestApi/resources/11.13.18.05/requisiteSchemes/{RequisiteSchemeId}/child/requisiteSchemeDetails

Parameters:

• RequisiteSchemeId: $request.path.RequisiteSchemeId

The requisite schemes details resource lists the details of the requisite evaluation schemes used to define required outcomes and results when evaluating a course requisite.

Back to Top