Jump to

• Request
• Response

Create a status scheme

post

/fscmRestApi/resources/11.13.18.05/hedWorkflowStatusSchemes

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

• ActiveFlag(required): boolean
  Title: Active

  Maximum Length: 1

  Indicates whether the status scheme is active or inactive.
• CategoryId(required): integer (int64)
  Title: Category ID

  The unique identifier of the category associated with the status scheme.
• CategoryName: string
  Title: Category

  Maximum Length: 50

  The name of the associated category.
• InstitutionId: integer (int64)
  Title: Institution ID

  The unique identifier of the institution associated with the status scheme.
• InstitutionName: string
  Title: Institution

  Maximum Length: 50

  The name of the associated institution.
• SeedDataLock: integer (int32)
  Title: Predefined Data

  Default Value: 0

  Indicates whether the record is predefined. The value 0 means the record isn't predefined. The value 1 means the record is predefined and can't be updated. A value greater than 1 means the record is predefined but can be updated.
• statuses: array Statuses
  Title: Statuses

  The statuses resource is used to view, create, or modify statuses in a status scheme.
• StatusSchemeCode(required): string
  Title: Status Scheme Code

  Maximum Length: 30

  The status scheme code, such as a code for a group of statuses for admissions.
• StatusSchemeDescription: string
  Title: Description

  Maximum Length: 240

  The description for the status scheme, such as a description for admissions statuses.
• StatusSchemeId: integer (int64)
  Title: Status Scheme ID

  The unique identifier of a status scheme.
• StatusSchemeName(required): string
  Title: Name

  Maximum Length: 60

  The name of the status scheme, such as admissions statuses.

{
    "required":[
        "ActiveFlag",
        "CategoryId",
        "StatusSchemeCode",
        "StatusSchemeName"
    ],
    "type":"object",
    "properties":{
        "CategoryId":{
            "title":"Category ID",
            "type":"integer",
            "description":"The unique identifier of the category associated with the status scheme.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "InstitutionName":{
            "title":"Institution",
            "maxLength":50,
            "type":"string",
            "description":"The name of the associated institution.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "StatusSchemeName":{
            "title":"Name",
            "maxLength":60,
            "type":"string",
            "description":"The name of the status scheme, such as admissions statuses.",
            "nullable":false
        },
        "InstitutionId":{
            "title":"Institution ID",
            "type":"integer",
            "description":"The unique identifier of the institution associated with the status scheme.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "StatusSchemeCode":{
            "title":"Status Scheme Code",
            "maxLength":30,
            "type":"string",
            "description":"The status scheme code, such as a code for a group of statuses for admissions.",
            "nullable":false
        },
        "SeedDataLock":{
            "title":"Predefined Data",
            "type":"integer",
            "description":"Indicates whether the record is predefined. The value 0 means the record isn't predefined. The value 1 means the record is predefined and can't be updated. A value greater than 1 means the record is predefined but can be updated.",
            "format":"int32",
            "nullable":false,
            "default":0,
            "x-hints":{
                "precision":1
            }
        },
        "StatusSchemeDescription":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"The description for the status scheme, such as a description for admissions statuses.",
            "nullable":true
        },
        "StatusSchemeId":{
            "title":"Status Scheme ID",
            "type":"integer",
            "description":"The unique identifier of a status scheme.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":50,
            "type":"string",
            "description":"The name of the associated category.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "CategoryId"
                ]
            }
        },
        "statuses":{
            "title":"Statuses",
            "type":"array",
            "description":"The statuses resource is used to view, create, or modify statuses in a status scheme.",
            "items":{
                "$ref":"#/components/schemas/hedWorkflowStatusSchemes-statuses-item-post-request"
            }
        },
        "ActiveFlag":{
            "title":"Active",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the status scheme is active or inactive.",
            "nullable":false
        }
    }
}

Nested Schema : Statuses

Type: array

Title: Statuses

The statuses resource is used to view, create, or modify statuses in a status scheme.

Show Source

• Array of: object hedWorkflowStatusSchemes-statuses-item-post-request

{
    "title":"Statuses",
    "type":"array",
    "description":"The statuses resource is used to view, create, or modify statuses in a status scheme.",
    "items":{
        "$ref":"#/components/schemas/hedWorkflowStatusSchemes-statuses-item-post-request"
    }
}

Nested Schema : hedWorkflowStatusSchemes-statuses-item-post-request

Type: object

Show Source

• DefaultFlag: boolean
  Maximum Length: 1

  Indicates whether the status scheme status is the default value.
• DisplayOrder: integer (int32)
  Title: Display Order

  Display order of statuses in the status scheme.
• StatusCode: string
  Title: Status Code

  Maximum Length: 30

  The code for a status code. A list of accepted values is defined in the lookup type ORA_HEY_STATUS.
• StatusSchemeStatusId: integer (int64)
  Title: Status Scheme Status ID

  The unique identifier for a status in a status scheme.
• StatusTypeCode: string
  Title: Status Type Code

  Maximum Length: 30

  The code for a status type. A list of accepted values is defined in the lookup type ORA_HEY_STATUS_TYPE.

{
    "type":"object",
    "properties":{
        "StatusTypeCode":{
            "title":"Status Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The code for a status type. A list of accepted values is defined in the lookup type ORA_HEY_STATUS_TYPE.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "DefaultFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the status scheme status is the default value.",
            "nullable":true
        },
        "DisplayOrder":{
            "title":"Display Order",
            "type":"integer",
            "description":"Display order of statuses in the status scheme.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":4
            }
        },
        "StatusSchemeStatusId":{
            "title":"Status Scheme Status ID",
            "type":"integer",
            "description":"The unique identifier for a status in a status scheme.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "StatusCode":{
            "title":"Status Code",
            "maxLength":30,
            "type":"string",
            "description":"The code for a status code. A list of accepted values is defined in the lookup type ORA_HEY_STATUS.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context(required):
  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(required):
  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 : hedWorkflowStatusSchemes-item-response

Type: object

Show Source

• ActiveFlag: boolean
  Title: Active

  Maximum Length: 1

  Indicates whether the status scheme is active or inactive.
• CategoryId: integer (int64)
  Title: Category ID

  The unique identifier of the category associated with the status scheme.
• CategoryName: string
  Title: Category

  Maximum Length: 50

  The name of the associated category.
• InstitutionId: integer (int64)
  Title: Institution ID

  The unique identifier of the institution associated with the status scheme.
• InstitutionName: string
  Title: Institution

  Maximum Length: 50

  The name of the associated institution.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date on which a status scheme was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

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

  The link relations associated with the resource instance.
• SeedDataLock: integer (int32)
  Title: Predefined Data

  Default Value: 0

  Indicates whether the record is predefined. The value 0 means the record isn't predefined. The value 1 means the record is predefined and can't be updated. A value greater than 1 means the record is predefined but can be updated.
• statuses: array Statuses
  Title: Statuses

  The statuses resource is used to view, create, or modify statuses in a status scheme.
• StatusSchemeCode: string
  Title: Status Scheme Code

  Maximum Length: 30

  The status scheme code, such as a code for a group of statuses for admissions.
• StatusSchemeDescription: string
  Title: Description

  Maximum Length: 240

  The description for the status scheme, such as a description for admissions statuses.
• StatusSchemeId: integer (int64)
  Title: Status Scheme ID

  The unique identifier of a status scheme.
• StatusSchemeName: string
  Title: Name

  Maximum Length: 60

  The name of the status scheme, such as admissions statuses.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"Indicates who last updated a status scheme.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CategoryId":{
            "title":"Category ID",
            "type":"integer",
            "description":"The unique identifier of the category associated with the status scheme.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "InstitutionName":{
            "title":"Institution",
            "maxLength":50,
            "type":"string",
            "description":"The name of the associated institution.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "InstitutionId":{
            "title":"Institution ID",
            "type":"integer",
            "description":"The unique identifier of the institution associated with the status scheme.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SeedDataLock":{
            "title":"Predefined Data",
            "type":"integer",
            "description":"Indicates whether the record is predefined. The value 0 means the record isn't predefined. The value 1 means the record is predefined and can't be updated. A value greater than 1 means the record is predefined but can be updated.",
            "format":"int32",
            "nullable":false,
            "default":0,
            "x-hints":{
                "precision":1
            },
            "x-queryable":true
        },
        "ActiveFlag":{
            "title":"Active",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the status scheme is active or inactive.",
            "nullable":false,
            "x-queryable":true
        },
        "StatusSchemeName":{
            "title":"Name",
            "maxLength":60,
            "type":"string",
            "description":"The name of the status scheme, such as admissions statuses.",
            "nullable":false,
            "x-queryable":true
        },
        "StatusSchemeCode":{
            "title":"Status Scheme Code",
            "maxLength":30,
            "type":"string",
            "description":"The status scheme code, such as a code for a group of statuses for admissions.",
            "nullable":false,
            "x-queryable":true
        },
        "StatusSchemeDescription":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"The description for the status scheme, such as a description for admissions statuses.",
            "nullable":true,
            "x-queryable":true
        },
        "StatusSchemeId":{
            "title":"Status Scheme ID",
            "type":"integer",
            "description":"The unique identifier of a status scheme.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":50,
            "type":"string",
            "description":"The name of the associated category.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "CategoryId"
                ]
            },
            "x-queryable":true
        },
        "statuses":{
            "title":"Statuses",
            "type":"array",
            "description":"The statuses resource is used to view, create, or modify statuses in a status scheme.",
            "items":{
                "$ref":"#/components/schemas/hedWorkflowStatusSchemes-statuses-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date on which a status scheme was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : Statuses

Type: array

Title: Statuses

The statuses resource is used to view, create, or modify statuses in a status scheme.

Show Source

• Array of: object hedWorkflowStatusSchemes-statuses-item-response

{
    "title":"Statuses",
    "type":"array",
    "description":"The statuses resource is used to view, create, or modify statuses in a status scheme.",
    "items":{
        "$ref":"#/components/schemas/hedWorkflowStatusSchemes-statuses-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 : hedWorkflowStatusSchemes-statuses-item-response

Type: object

Show Source

• DefaultFlag: boolean
  Maximum Length: 1

  Indicates whether the status scheme status is the default value.
• DisplayOrder: integer (int32)
  Title: Display Order

  Display order of statuses in the status scheme.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• StatusCode: string
  Title: Status Code

  Maximum Length: 30

  The code for a status code. A list of accepted values is defined in the lookup type ORA_HEY_STATUS.
• StatusMeaning: string
  Title: Status

  Read Only: true

  Maximum Length: 80

  The meaning of the status code, such as admitted or withdrawn. A list of accepted values is defined in the lookup type ORA_HEY_STATUS.
• StatusSchemeStatusId: integer (int64)
  Title: Status Scheme Status ID

  The unique identifier for a status in a status scheme.
• StatusTypeCode: string
  Title: Status Type Code

  Maximum Length: 30

  The code for a status type. A list of accepted values is defined in the lookup type ORA_HEY_STATUS_TYPE.
• StatusTypeMeaning: string
  Title: Status Type

  Read Only: true

  Maximum Length: 80

  The meaning of the status type code, such as in progress or completed. A list of accepted values is defined in the lookup type ORA_HEY_STATUS_TYPE.

{
    "type":"object",
    "properties":{
        "StatusTypeCode":{
            "title":"Status Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The code for a status type. A list of accepted values is defined in the lookup type ORA_HEY_STATUS_TYPE.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "StatusMeaning":{
            "title":"Status",
            "maxLength":80,
            "type":"string",
            "description":"The meaning of the status code, such as admitted or withdrawn. A list of accepted values is defined in the lookup type ORA_HEY_STATUS.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DisplayOrder":{
            "title":"Display Order",
            "type":"integer",
            "description":"Display order of statuses in the status scheme.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":4
            },
            "x-queryable":true
        },
        "StatusTypeMeaning":{
            "title":"Status Type",
            "maxLength":80,
            "type":"string",
            "description":"The meaning of the status type code, such as in progress or completed. A list of accepted values is defined in the lookup type ORA_HEY_STATUS_TYPE.",
            "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"
            }
        },
        "DefaultFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the status scheme status is the default value.",
            "nullable":true,
            "x-queryable":true
        },
        "StatusSchemeStatusId":{
            "title":"Status Scheme Status ID",
            "type":"integer",
            "description":"The unique identifier for a status in a status scheme.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "StatusCode":{
            "title":"Status Code",
            "maxLength":30,
            "type":"string",
            "description":"The code for a status code. A list of accepted values is defined in the lookup type ORA_HEY_STATUS.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "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

academicInstitutionsLOV

Operation: /fscmRestApi/resources/11.13.18.05/academicInstitutions

The list of values for the institution associated with the status scheme.

statuses

Operation: /fscmRestApi/resources/11.13.18.05/hedWorkflowStatusSchemes/{StatusSchemeId}/child/statuses

Parameters:

• StatusSchemeId: $request.path.StatusSchemeId

The statuses resource is used to view, create, or modify statuses in a status scheme.

studentManagementCategoriesLOV

Operation: /fscmRestApi/resources/11.13.18.05/studentManagementCategories

The list of values for the category associated with the status scheme.

Back to Top