Create multiple transcript template assignments
post
/fscmRestApi/resources/11.13.18.05/transcriptTypes/{transcriptTypesUniqID}/child/templateAssignments
Request
Path Parameters
-
transcriptTypesUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Transcript Types resource and used to uniquely identify an instance of Transcript Types. The client should not generate the hash key value. Instead, the client should query on the Transcript Types collection resource in order to navigate to a specific instance of Transcript Types 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
-
AssignmentSequence: integer
(int32)
The sequence number assigned to the templates for a transcript type.
-
TemplateCode: string
Maximum Length:
50
The user defined unique identifier for a transcript template. -
TranscriptTemplateId: integer
(int64)
The generated unique identifier for a transcript template.
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 : transcriptTypes-templateAssignments-item-response
Type:
Show Source
object
-
AssignmentSequence: integer
(int32)
The sequence number assigned to the templates for a transcript type.
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the row. -
CreationDate: string
(date-time)
Read Only:
true
The date the row was created. -
EnabledFlag: boolean
Read Only:
true
Maximum Length:1
Indicates whether a template is active and available for use. The default value is true. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date the row was last updated. -
LastUpdatedBy: string
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. -
TemplateCode: string
Maximum Length:
50
The user defined unique identifier for a transcript template. -
TemplateContent: string
Read Only:
true
The content of a transcript template. This includes document text and formatting as well as the data tokens used to represent student transcript data. -
TemplateDescription: string
Read Only:
true
Maximum Length:1000
The description for a transcript template. -
TemplateName: string
Read Only:
true
Maximum Length:50
The name for a transcript template. -
TranscriptAssignmentId: integer
(int64)
Read Only:
true
The generated unique identifier for the linkage between a transcript template and a transcript type or types. -
TranscriptTemplateId: integer
(int64)
The generated unique identifier for a transcript template.
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
- transcriptTemplateCodeLOV
-
The list of values for transcript template.