Create a parameter
post
/fscmRestApi/resources/11.13.18.05/courseLists/{courseListsUniqID}/child/parameters
Request
Path Parameters
-
courseListsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Course Lists resource and used to uniquely identify an instance of Course Lists. The client should not generate the hash key value. Instead, the client should query on the Course Lists collection resource in order to navigate to a specific instance of Course Lists to get the hash key.
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
-
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
-
MaximumCoursesQuantity: integer
(int32)
Title:
Maximum Number of Courses
Default Value:0
The maximum number of courses or course lists that must be completed to satisfy a curriculum item requirement. -
MaximumUnitsQuantity: integer
(int32)
Title:
Maximum Units
Default Value:0
The maximum number of units of credit that can be completed or used to satisfy a curriculum item requirement. -
MinimumCoursesQuantity: integer
(int32)
Title:
Minimum Number of Courses
Default Value:0
The minimum number of courses that must be completed to satisfy a curriculum item requirement. -
MinimumUnitsQuantity: integer
(int32)
Title:
Minimum Units
Default Value:0
The minimum number of units of credit that must be completed to satisfy a curriculum item requirement. -
ParameterId: integer
(int64)
Title:
Curriculum Parameter ID
The unique identifier for a parameter associated with a curriculum item such as program. -
ParameterSequenceNumber: integer
(int32)
Title:
Parameter Sequence Number
The sequence number for a set of parameters defined for program requirements. -
RequirementCategoryId: integer
(int64)
Title:
Requirement Category ID
The unique identifier for the requirement category.
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 : courseLists-parameters-item-response
Type:
Show Source
object
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the parameter row. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the parameter row was created. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The user who last updated the parameter row. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The date and time when the parameter row was last updated. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MaximumCoursesQuantity: integer
(int32)
Title:
Maximum Number of Courses
Default Value:0
The maximum number of courses or course lists that must be completed to satisfy a curriculum item requirement. -
MaximumUnitsQuantity: integer
(int32)
Title:
Maximum Units
Default Value:0
The maximum number of units of credit that can be completed or used to satisfy a curriculum item requirement. -
MinimumCoursesQuantity: integer
(int32)
Title:
Minimum Number of Courses
Default Value:0
The minimum number of courses that must be completed to satisfy a curriculum item requirement. -
MinimumUnitsQuantity: integer
(int32)
Title:
Minimum Units
Default Value:0
The minimum number of units of credit that must be completed to satisfy a curriculum item requirement. -
ParameterId: integer
(int64)
Title:
Curriculum Parameter ID
The unique identifier for a parameter associated with a curriculum item such as program. -
ParameterSequenceNumber: integer
(int32)
Title:
Parameter Sequence Number
The sequence number for a set of parameters defined for program requirements. -
RequirementCategoryCode: string
Title:
Requirement Category Code
Read Only:true
Maximum Length:30
The user defined code for a requirement category, used for categorizing program requirements in the Curriculum Registry. -
RequirementCategoryId: integer
(int64)
Title:
Requirement Category ID
The unique identifier for the requirement category. -
RequirementCategoryName: string
Title:
Name
Read Only:true
Maximum Length:50
The type of requirement that this program element fulfills, such as required or elective.
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.