Create a category data group
post
/fscmRestApi/resources/11.13.18.05/studentManagementCategories/{CategoryId}/child/categoryDataGroups
Request
Path Parameters
-
CategoryId(required): integer(int64)
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
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
Root Schema : schema
Type:
Show Source
object
-
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.
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.
Root Schema : studentManagementCategories-categoryDataGroups-item-response
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Links
- ArtifactGroupVO1
-
Parameters:
- finder:
TypeKeywordFinder%3BActive%3Dtrue
The list of values for the data groups. - finder: