Jump to

• Request
• Response

Create a student management category

post

/fscmRestApi/resources/11.13.18.05/studentManagementCategories

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

• ActiveFlag(required): boolean
  Title: Active

  Maximum Length: 1

  Indicates whether a category is active or inactive.
• CategoryCode(required): string
  Title: Category Code

  Maximum Length: 30

  The unique code for a category.
• categoryDataGroups: array Category Data Groups
  Title: Category Data Groups

  Use the category data groups resource to view, create, modify, or delete category data groups.
• CategoryDescription(required): string
  Title: Description

  Maximum Length: 240

  The description of a category.
• categoryEvents: array Category Events
  Title: Category Events

  Use the category events resource to view, create, modify, or delete category events.
• CategoryId: integer (int64)
  Title: Category ID

  The unique identifier for a category.
• CategoryName(required): string
  Title: Category Name

  Maximum Length: 50

  The name of a category, such as Enrollment or Billing.
• categoryRuleAttributes: array Category Rule Attributes
  Title: Category Rule Attributes

  Use the category rule attributes resource to view, create, modify, or delete category rule attributes.
• 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.
• subcategories: array Subcategories
  Title: Subcategories

  Use the student management subcategories resource to view, create, modify, or delete subcategories. For example, an enrollment category can have various subcategories.

{
    "required":[
        "ActiveFlag",
        "CategoryCode",
        "CategoryDescription",
        "CategoryName"
    ],
    "type":"object",
    "properties":{
        "ActiveFlag":{
            "title":"Active",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether a category is active or inactive.",
            "nullable":false,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "CategoryCode":{
            "title":"Category Code",
            "maxLength":30,
            "type":"string",
            "description":"The unique code for a category.",
            "nullable":false,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "CategoryDescription":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"The description of a category.",
            "nullable":false,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "CategoryId":{
            "title":"Category ID",
            "type":"integer",
            "description":"The unique identifier for a category.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "CategoryName":{
            "title":"Category Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of a category, such as Enrollment or Billing.",
            "nullable":false,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"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
            }
        },
        "categoryDataGroups":{
            "title":"Category Data Groups",
            "type":"array",
            "description":"Use the category data groups resource to view, create, modify, or delete category data groups.",
            "items":{
                "$ref":"#/components/schemas/studentManagementCategories-categoryDataGroups-item-post-request"
            }
        },
        "categoryEvents":{
            "title":"Category Events",
            "type":"array",
            "description":"Use the category events resource to view, create, modify, or delete category events.",
            "items":{
                "$ref":"#/components/schemas/studentManagementCategories-categoryEvents-item-post-request"
            }
        },
        "categoryRuleAttributes":{
            "title":"Category Rule Attributes",
            "type":"array",
            "description":"Use the category rule attributes resource to view, create, modify, or delete category rule attributes.",
            "items":{
                "$ref":"#/components/schemas/studentManagementCategories-categoryRuleAttributes-item-post-request"
            },
            "x-cardinality":"1"
        },
        "subcategories":{
            "title":"Subcategories",
            "type":"array",
            "description":"Use the student management subcategories resource to view, create, modify, or delete subcategories. For example, an enrollment category can have various subcategories.",
            "items":{
                "$ref":"#/components/schemas/studentManagementCategories-subcategories-item-post-request"
            }
        }
    }
}

Nested Schema : Category Data Groups

Type: array

Title: Category Data Groups

Use the category data groups resource to view, create, modify, or delete category data groups.

Show Source

• Array of: object schema

{
    "title":"Category Data Groups",
    "type":"array",
    "description":"Use the category data groups resource to view, create, modify, or delete category data groups.",
    "items":{
        "$ref":"#/components/schemas/studentManagementCategories-categoryDataGroups-item-post-request"
    }
}

Nested Schema : Category Events

Type: array

Title: Category Events

Use the category events resource to view, create, modify, or delete category events.

Show Source

• Array of: object schema

{
    "title":"Category Events",
    "type":"array",
    "description":"Use the category events resource to view, create, modify, or delete category events.",
    "items":{
        "$ref":"#/components/schemas/studentManagementCategories-categoryEvents-item-post-request"
    }
}

Nested Schema : Category Rule Attributes

Type: array

Title: Category Rule Attributes

Use the category rule attributes resource to view, create, modify, or delete category rule attributes.

Show Source

• Array of: object schema

{
    "title":"Category Rule Attributes",
    "type":"array",
    "description":"Use the category rule attributes resource to view, create, modify, or delete category rule attributes.",
    "items":{
        "$ref":"#/components/schemas/studentManagementCategories-categoryRuleAttributes-item-post-request"
    },
    "x-cardinality":"1"
}

Nested Schema : Subcategories

Type: array

Title: Subcategories

Use the student management subcategories resource to view, create, modify, or delete subcategories. For example, an enrollment category can have various subcategories.

Show Source

• Array of: object schema

{
    "title":"Subcategories",
    "type":"array",
    "description":"Use the student management subcategories resource to view, create, modify, or delete subcategories. For example, an enrollment category can have various subcategories.",
    "items":{
        "$ref":"#/components/schemas/studentManagementCategories-subcategories-item-post-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• ArtifactGroupId: integer (int64)
  Title: Data Group ID

  The unique identifier for a data group.
• ArtifactGroupName: string
  Title: Data Group Name

  Maximum Length: 50

  The name of a data group.
• CategoryArtifactGroupId: integer (int64)
  Title: Category Data Group ID

  The unique identifier for the data group and category association.

{
    "type":"object",
    "properties":{
        "ArtifactGroupId":{
            "title":"Data Group ID",
            "type":"integer",
            "description":"The unique identifier for a data group.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ArtifactGroupName":{
            "title":"Data Group Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of a data group.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CategoryArtifactGroupId":{
            "title":"Category Data Group ID",
            "type":"integer",
            "description":"The unique identifier for the data group and category association.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        }
    }
}

Nested Schema : schema

Type: object

Show Source

• EventId: integer (int64)
  Title: Event ID

  The unique identifier for an event that occurs in the application, for example, Enrollment Drop and Refund Posted.
• EventName: string
  Title: Event Name

  Maximum Length: 50

  The name of an event, such as Enrollment Drop.

{
    "type":"object",
    "properties":{
        "EventId":{
            "title":"Event ID",
            "type":"integer",
            "description":"The unique identifier for an event that occurs in the application, for example, Enrollment Drop and Refund Posted.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "EventName":{
            "title":"Event Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of an event, such as Enrollment Drop.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        }
    }
}

Nested Schema : schema

Type: object

Show Source

• AllowCallOtherRulesFlag: boolean
  Title: Allow Subcategories

  Maximum Length: 1

  Default Value: true

  Indicates whether rules of this category can call rules that belong to other categories. These other categories are known as subcategories of this category.
• AllowRuleChangesFlag: boolean
  Title: Allow Rule Changes

  Maximum Length: 1

  Default Value: true

  Indicates whether changes to rules are allowed for this category.
• CategoryRuleId: integer (int64)
  Title: Rule Category ID

  The unique identifier for a rule category.

{
    "type":"object",
    "properties":{
        "AllowCallOtherRulesFlag":{
            "title":"Allow Subcategories",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether rules of this category can call rules that belong to other categories. These other categories are known as subcategories of this category.",
            "nullable":false,
            "default":true
        },
        "AllowRuleChangesFlag":{
            "title":"Allow Rule Changes",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether changes to rules are allowed for this category.",
            "nullable":false,
            "default":true
        },
        "CategoryRuleId":{
            "title":"Rule Category ID",
            "type":"integer",
            "description":"The unique identifier for a rule category.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        }
    }
}

Nested Schema : schema

Type: object

Show Source

• CategoryAssociationId: integer (int64)
  Title: Category Association ID

  The unique identifier for the subcategory and category association.
• SubcategoryId: integer (int64)
  Title: Subcategory ID

  The unique identifier for a subcategory.
• SubcategoryName: string
  Title: Subcategory Name

  Maximum Length: 50

  The name of a subcategory.

{
    "type":"object",
    "properties":{
        "CategoryAssociationId":{
            "title":"Category Association ID",
            "type":"integer",
            "description":"The unique identifier for the subcategory and category association.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "SubcategoryId":{
            "title":"Subcategory ID",
            "type":"integer",
            "description":"The unique identifier for a subcategory.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "SubcategoryName"
                ]
            }
        },
        "SubcategoryName":{
            "title":"Subcategory Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of a subcategory.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "PAYLOADHINT":"Show"
            }
        }
    }
}

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

Type: object

Show Source

• ActiveFlag: boolean
  Title: Active

  Maximum Length: 1

  Indicates whether a category is active or inactive.
• CategoryCode: string
  Title: Category Code

  Maximum Length: 30

  The unique code for a category.
• categoryDataGroups: array Category Data Groups
  Title: Category Data Groups

  Use the category data groups resource to view, create, modify, or delete category data groups.
• CategoryDescription: string
  Title: Description

  Maximum Length: 240

  The description of a category.
• categoryEvents: array Category Events
  Title: Category Events

  Use the category events resource to view, create, modify, or delete category events.
• CategoryId: integer (int64)
  Title: Category ID

  The unique identifier for a category.
• CategoryName: string
  Title: Category Name

  Maximum Length: 50

  The name of a category, such as Enrollment or Billing.
• categoryRuleAttributes: array Category Rule Attributes
  Title: Category Rule Attributes

  Use the category rule attributes resource to view, create, modify, or delete category rule attributes.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

  The date and time when the category was created.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time when the category was updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The person who updated the category.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MappedEventCount: integer
  Title: Mapped Events

  Read Only: true

  The number of events mapped to a category.
• 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.
• SeededDataFlag: boolean
  Read Only: true

  Indicates whether the associated row is predefined.
• subcategories: array Subcategories
  Title: Subcategories

  Use the student management subcategories resource to view, create, modify, or delete subcategories. For example, an enrollment category can have various subcategories.

{
    "type":"object",
    "properties":{
        "ActiveFlag":{
            "title":"Active",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether a category is active or inactive.",
            "nullable":false,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "CategoryCode":{
            "title":"Category Code",
            "maxLength":30,
            "type":"string",
            "description":"The unique code for a category.",
            "nullable":false,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "CategoryDescription":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"The description of a category.",
            "nullable":false,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "CategoryId":{
            "title":"Category ID",
            "type":"integer",
            "description":"The unique identifier for a category.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "CategoryName":{
            "title":"Category Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of a category, such as Enrollment or Billing.",
            "nullable":false,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The person who created the category.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the category was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the category was updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The person who updated the category.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MappedEventCount":{
            "title":"Mapped Events",
            "type":"integer",
            "description":"The number of events mapped to a category.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "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
        },
        "SeededDataFlag":{
            "type":"boolean",
            "description":"Indicates whether the associated row is predefined.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "categoryDataGroups":{
            "title":"Category Data Groups",
            "type":"array",
            "description":"Use the category data groups resource to view, create, modify, or delete category data groups.",
            "items":{
                "$ref":"#/components/schemas/studentManagementCategories-categoryDataGroups-item-response"
            }
        },
        "categoryEvents":{
            "title":"Category Events",
            "type":"array",
            "description":"Use the category events resource to view, create, modify, or delete category events.",
            "items":{
                "$ref":"#/components/schemas/studentManagementCategories-categoryEvents-item-response"
            }
        },
        "categoryRuleAttributes":{
            "title":"Category Rule Attributes",
            "type":"array",
            "description":"Use the category rule attributes resource to view, create, modify, or delete category rule attributes.",
            "items":{
                "$ref":"#/components/schemas/studentManagementCategories-categoryRuleAttributes-item-response"
            },
            "x-cardinality":"1"
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "subcategories":{
            "title":"Subcategories",
            "type":"array",
            "description":"Use the student management subcategories resource to view, create, modify, or delete subcategories. For example, an enrollment category can have various subcategories.",
            "items":{
                "$ref":"#/components/schemas/studentManagementCategories-subcategories-item-response"
            }
        }
    }
}

Nested Schema : Category Data Groups

Type: array

Title: Category Data Groups

Use the category data groups resource to view, create, modify, or delete category data groups.

Show Source

• Array of: object studentManagementCategories-categoryDataGroups-item-response

{
    "title":"Category Data Groups",
    "type":"array",
    "description":"Use the category data groups resource to view, create, modify, or delete category data groups.",
    "items":{
        "$ref":"#/components/schemas/studentManagementCategories-categoryDataGroups-item-response"
    }
}

Nested Schema : Category Events

Type: array

Title: Category Events

Use the category events resource to view, create, modify, or delete category events.

Show Source

• Array of: object studentManagementCategories-categoryEvents-item-response

{
    "title":"Category Events",
    "type":"array",
    "description":"Use the category events resource to view, create, modify, or delete category events.",
    "items":{
        "$ref":"#/components/schemas/studentManagementCategories-categoryEvents-item-response"
    }
}

Nested Schema : Category Rule Attributes

Type: array

Title: Category Rule Attributes

Use the category rule attributes resource to view, create, modify, or delete category rule attributes.

Show Source

• Array of: object studentManagementCategories-categoryRuleAttributes-item-response

{
    "title":"Category Rule Attributes",
    "type":"array",
    "description":"Use the category rule attributes resource to view, create, modify, or delete category rule attributes.",
    "items":{
        "$ref":"#/components/schemas/studentManagementCategories-categoryRuleAttributes-item-response"
    },
    "x-cardinality":"1"
}

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

Type: array

Title: Subcategories

Use the student management subcategories resource to view, create, modify, or delete subcategories. For example, an enrollment category can have various subcategories.

Show Source

• Array of: object studentManagementCategories-subcategories-item-response

{
    "title":"Subcategories",
    "type":"array",
    "description":"Use the student management subcategories resource to view, create, modify, or delete subcategories. For example, an enrollment category can have various subcategories.",
    "items":{
        "$ref":"#/components/schemas/studentManagementCategories-subcategories-item-response"
    }
}

Nested Schema : studentManagementCategories-categoryDataGroups-item-response

Type: object

Show Source

• ArtifactGroupCode: string
  Title: Data Group Code

  Read Only: true

  Maximum Length: 50

  The data group unique code, such as ACADSTRUCTUREPROFILE.
• ArtifactGroupId: integer (int64)
  Title: Data Group ID

  The unique identifier for a data group.
• ArtifactGroupName: string
  Title: Data Group Name

  Maximum Length: 50

  The name of a data group.
• ArtifactGroupTypeCode: string
  Title: Data Group Type Code

  Read Only: true

  Maximum Length: 30

  The type of the data group, for example, a data profile or a data contract.
• ArtifactGroupTypeMeaning: string
  Title: Data Group Type

  Read Only: true

  Maximum Length: 80

  The meaning of the data group type code, for example, a data profile or a data contract.
• CategoryArtifactGroupId: integer (int64)
  Title: Category Data Group ID

  The unique identifier for the data group and category association.
• Description: string
  Title: Data Group Description

  Read Only: true

  Maximum Length: 240

  The description of a data group.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ProcessNames: string
  Title: Process Names

  Read Only: true

  The list of processes that are mapped to a contract.

{
    "type":"object",
    "properties":{
        "ArtifactGroupCode":{
            "title":"Data Group Code",
            "maxLength":50,
            "type":"string",
            "description":"The data group unique code, such as ACADSTRUCTUREPROFILE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ArtifactGroupId":{
            "title":"Data Group ID",
            "type":"integer",
            "description":"The unique identifier for a data group.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ArtifactGroupName":{
            "title":"Data Group Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of a data group.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ArtifactGroupTypeCode":{
            "title":"Data Group Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The type of the data group, for example, a data profile or a data contract.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ArtifactGroupTypeMeaning":{
            "title":"Data Group Type",
            "maxLength":80,
            "type":"string",
            "description":"The meaning of the data group type code, for example, a data profile or a data contract.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CategoryArtifactGroupId":{
            "title":"Category Data Group ID",
            "type":"integer",
            "description":"The unique identifier for the data group and category association.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Data Group Description",
            "maxLength":240,
            "type":"string",
            "description":"The description of a data group.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProcessNames":{
            "title":"Process Names",
            "type":"string",
            "description":"The list of processes that are mapped to a contract.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : 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 : studentManagementCategories-categoryEvents-item-response

Type: object

Show Source

• ActiveFlag: boolean
  Title: Active

  Read Only: true

  Maximum Length: 1

  Indicates whether an event is active or inactive.
• CategoryEventMapId: integer (int64)
  Title: Category Event Map ID

  Read Only: true

  The unique identifier for the category and event mapping.
• EventCode: string
  Title: Event Code

  Read Only: true

  Maximum Length: 30

  The unique code for an event.
• EventDescription: string
  Title: Event Description

  Read Only: true

  Maximum Length: 240

  The description of an event.
• EventId: integer (int64)
  Title: Event ID

  The unique identifier for an event that occurs in the application, for example, Enrollment Drop and Refund Posted.
• EventName: string
  Title: Event Name

  Maximum Length: 50

  The name of an event, such as Enrollment Drop.
• EventTimingRuleCode: string
  Read Only: true

  Maximum Length: 30

  The timing rule type code for a date based event. For example, the ORA_HEY_EVENT_TIMING_AFTER code indicates a communication can be sent after the event occurs. A list of accepted values is defined in the lookup type ORA_HEY_EVENT_TIMING_RULE_TYPE.
• EventTypeCode: string
  Title: Event Type

  Read Only: true

  Maximum Length: 30

  The type of an event, such as a transactional or date-based event. A list of accepted values is defined in the lookup type ORA_HEY_EVENT_TYPE.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• SeededDataFlag: boolean
  Read Only: true

  Indicates whether the associated row is predefined.

{
    "type":"object",
    "properties":{
        "ActiveFlag":{
            "title":"Active",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether an event is active or inactive.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CategoryEventMapId":{
            "title":"Category Event Map ID",
            "type":"integer",
            "description":"The unique identifier for the category and event mapping.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "EventCode":{
            "title":"Event Code",
            "maxLength":30,
            "type":"string",
            "description":"The unique code for an event.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EventDescription":{
            "title":"Event Description",
            "maxLength":240,
            "type":"string",
            "description":"The description of an event.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EventId":{
            "title":"Event ID",
            "type":"integer",
            "description":"The unique identifier for an event that occurs in the application, for example, Enrollment Drop and Refund Posted.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "EventName":{
            "title":"Event Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of an event, such as Enrollment Drop.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "EventTimingRuleCode":{
            "maxLength":30,
            "type":"string",
            "description":"The timing rule type code for a date based event. For example, the ORA_HEY_EVENT_TIMING_AFTER code indicates a communication can be sent after the event occurs. A list of accepted values is defined in the lookup type ORA_HEY_EVENT_TIMING_RULE_TYPE.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EventTypeCode":{
            "title":"Event Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of an event, such as a transactional or date-based event. A list of accepted values is defined in the lookup type ORA_HEY_EVENT_TYPE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SeededDataFlag":{
            "type":"boolean",
            "description":"Indicates whether the associated row is predefined.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : studentManagementCategories-categoryRuleAttributes-item-response

Type: object

Show Source

• AllowCallOtherRulesFlag: boolean
  Title: Allow Subcategories

  Maximum Length: 1

  Default Value: true

  Indicates whether rules of this category can call rules that belong to other categories. These other categories are known as subcategories of this category.
• AllowRuleChangesFlag: boolean
  Title: Allow Rule Changes

  Maximum Length: 1

  Default Value: true

  Indicates whether changes to rules are allowed for this category.
• CategoryRuleId: integer (int64)
  Title: Rule Category ID

  The unique identifier for a rule category.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "AllowCallOtherRulesFlag":{
            "title":"Allow Subcategories",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether rules of this category can call rules that belong to other categories. These other categories are known as subcategories of this category.",
            "nullable":false,
            "default":true,
            "x-queryable":true
        },
        "AllowRuleChangesFlag":{
            "title":"Allow Rule Changes",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether changes to rules are allowed for this category.",
            "nullable":false,
            "default":true,
            "x-queryable":true
        },
        "CategoryRuleId":{
            "title":"Rule Category ID",
            "type":"integer",
            "description":"The unique identifier for a rule category.",
            "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"
            }
        }
    }
}

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 : studentManagementCategories-subcategories-item-response

Type: object

Show Source

• CategoryAssociationId: integer (int64)
  Title: Category Association ID

  The unique identifier for the subcategory and category association.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• SubcategoryDescription: string
  Title: Description

  Read Only: true

  Maximum Length: 240

  The description of a subcategory.
• SubcategoryId: integer (int64)
  Title: Subcategory ID

  The unique identifier for a subcategory.
• SubcategoryName: string
  Title: Subcategory Name

  Maximum Length: 50

  The name of a subcategory.

{
    "type":"object",
    "properties":{
        "CategoryAssociationId":{
            "title":"Category Association ID",
            "type":"integer",
            "description":"The unique identifier for the subcategory and category association.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "SubcategoryDescription":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"The description of a subcategory.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "SubcategoryId":{
            "title":"Subcategory ID",
            "type":"integer",
            "description":"The unique identifier for a subcategory.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "SubcategoryName"
                ]
            },
            "x-queryable":true
        },
        "SubcategoryName":{
            "title":"Subcategory Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of a subcategory.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "PAYLOADHINT":"Show"
            },
            "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

categoryDataGroups

Operation: /fscmRestApi/resources/11.13.18.05/studentManagementCategories/{CategoryId}/child/categoryDataGroups

Parameters:

• CategoryId: $request.path.CategoryId

Use the category data groups resource to view, create, modify, or delete category data groups.

categoryEvents

Operation: /fscmRestApi/resources/11.13.18.05/studentManagementCategories/{CategoryId}/child/categoryEvents

Parameters:

• CategoryId: $request.path.CategoryId

Use the category events resource to view, create, modify, or delete category events.

categoryRuleAttributes

Operation: /fscmRestApi/resources/11.13.18.05/studentManagementCategories/{CategoryId}/child/categoryRuleAttributes

Parameters:

• CategoryId: $request.path.CategoryId

Use the category rule attributes resource to view, create, modify, or delete category rule attributes.

subcategories

Operation: /fscmRestApi/resources/11.13.18.05/studentManagementCategories/{CategoryId}/child/subcategories

Parameters:

• CategoryId: $request.path.CategoryId

Use the student management subcategories resource to view, create, modify, or delete subcategories. For example, an enrollment category can have various subcategories.

Back to Top