Jump to

• Request
• Response

Update a transcript template

patch

/fscmRestApi/resources/11.13.18.05/transcriptTemplates/{TranscriptTemplateId}

Request

Path Parameters

• TranscriptTemplateId(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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• Description: string
  Maximum Length: 1000

  The description for a transcript template.
• EnabledFlag(required): boolean
  Maximum Length: 1

  Indicates whether a template is active and available for use. The default value is true.
• templateAssignments: array Template Assignments
  Title: Template Assignments

  The template assignment resource provides a list of assigned transcript templates that can be used with this transcript type.
• TemplateContent: string
  The content of a transcript template.This includes document text and formatting as well as the data tokens used to represent student transcript data.
• TranscriptTemplateCode(required): string
  Maximum Length: 50

  The user defined unique identifier for a transcript template.
• TranscriptTemplateName: string
  Maximum Length: 50

  The name for a transcript template.

{
    "required":[
        "EnabledFlag",
        "TranscriptTemplateCode"
    ],
    "type":"object",
    "properties":{
        "templateAssignments":{
            "title":"Template Assignments",
            "type":"array",
            "description":"The template assignment resource provides a list of assigned transcript templates that can be used with this transcript type.",
            "items":{
                "$ref":"#/components/schemas/transcriptTemplates-templateAssignments-item-patch-request"
            }
        },
        "Description":{
            "maxLength":"1000",
            "type":"string",
            "description":"The description for a transcript template.",
            "nullable":true
        },
        "TranscriptTemplateName":{
            "maxLength":"50",
            "type":"string",
            "description":"The name for a transcript template.",
            "nullable":true
        },
        "EnabledFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether a template is active and available for use. The default value is true.",
            "nullable":false
        },
        "TemplateContent":{
            "type":"string",
            "description":"The content of a transcript template.This includes document text and formatting as well as the data tokens used to represent student transcript data.",
            "nullable":true
        },
        "TranscriptTemplateCode":{
            "maxLength":"50",
            "type":"string",
            "description":"The user defined unique identifier for a transcript template.",
            "nullable":false
        }
    }
}

Nested Schema : Template Assignments

Type: array

Title: Template Assignments

The template assignment resource provides a list of assigned transcript templates that can be used with this transcript type.

Show Source

• Array of: object transcriptTemplates-templateAssignments-item-patch-request

{
    "title":"Template Assignments",
    "type":"array",
    "description":"The template assignment resource provides a list of assigned transcript templates that can be used with this transcript type.",
    "items":{
        "$ref":"#/components/schemas/transcriptTemplates-templateAssignments-item-patch-request"
    }
}

Nested Schema : transcriptTemplates-templateAssignments-item-patch-request

Type: object

Show Source

• AssignmentSequence: integer (int32)
  The sequence number assigned to the templates for a transcript type.

{
    "type":"object",
    "properties":{
        "AssignmentSequence":{
            "type":"integer",
            "description":"The sequence number assigned to the templates for a transcript type.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9"
            }
        }
    }
}

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

Type: object

Show Source

• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

  The date the row was created.
• Description: string
  Maximum Length: 1000

  The description for a transcript template.
• EnabledFlag: boolean
  Maximum Length: 1

  Indicates whether a template is active and available for use. The default value is true.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date the row was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  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.
• templateAssignments: array Template Assignments
  Title: Template Assignments

  The template assignment resource provides a list of assigned transcript templates that can be used with this transcript type.
• TemplateContent: string
  The content of a transcript template.This includes document text and formatting as well as the data tokens used to represent student transcript data.
• TranscriptTemplateCode: string
  Maximum Length: 50

  The user defined unique identifier for a transcript template.
• TranscriptTemplateId: integer (int64)
  Read Only: true

  The generated unique identifier for a transcript template.
• TranscriptTemplateName: string
  Maximum Length: 50

  The name for a transcript template.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date the row was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "maxLength":"1000",
            "type":"string",
            "description":"The description for a transcript template.",
            "nullable":true,
            "x-queryable":true
        },
        "TemplateContent":{
            "type":"string",
            "description":"The content of a transcript template.This includes document text and formatting as well as the data tokens used to represent student transcript data.",
            "nullable":true,
            "x-queryable":true
        },
        "templateAssignments":{
            "title":"Template Assignments",
            "type":"array",
            "description":"The template assignment resource provides a list of assigned transcript templates that can be used with this transcript type.",
            "items":{
                "$ref":"#/components/schemas/transcriptTemplates-templateAssignments-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "TranscriptTemplateName":{
            "maxLength":"50",
            "type":"string",
            "description":"The name for a transcript template.",
            "nullable":true,
            "x-queryable":true
        },
        "EnabledFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether a template is active and available for use. The default value is true.",
            "nullable":false,
            "x-queryable":true
        },
        "TranscriptTemplateId":{
            "type":"integer",
            "description":"The generated unique identifier for a transcript template.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date the row was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TranscriptTemplateCode":{
            "maxLength":"50",
            "type":"string",
            "description":"The user defined unique identifier for a transcript template.",
            "nullable":false,
            "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 : Template Assignments

Type: array

Title: Template Assignments

The template assignment resource provides a list of assigned transcript templates that can be used with this transcript type.

Show Source

• Array of: object transcriptTemplates-templateAssignments-item-response

{
    "title":"Template Assignments",
    "type":"array",
    "description":"The template assignment resource provides a list of assigned transcript templates that can be used with this transcript type.",
    "items":{
        "$ref":"#/components/schemas/transcriptTemplates-templateAssignments-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 : transcriptTemplates-templateAssignments-item-response

Type: object

Show Source

• 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
  Title: Enable

  Read Only: true

  Maximum Length: 1

  Indicates whether the transcript type assigned to a transcript template is active and available for use. The default value is false.
• 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.
• TranscriptAssignmentId: integer (int64)
  Read Only: true

  The generated unique identifier for the linkage between a transcript template and a transcript type or types.
• TranscriptTypeCode: string
  Title: Code

  Read Only: true

  Maximum Length: 30

  The user defined identifier for the transcript type that's assigned to a transcript template.
• TranscriptTypeDescription: string
  Read Only: true

  The description for the transcript type assigned to a transcript template.
• TranscriptTypeId: integer (int64)
  The unique identifier for the transcript type that's assigned to a transcript template.
• TranscriptTypeName: string
  Title: Name

  Read Only: true

  Maximum Length: 50

  The name of the transcript type assigned to a transcript template.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TranscriptTypeCode":{
            "title":"Code",
            "maxLength":"30",
            "type":"string",
            "description":"The user defined identifier for the transcript type that's assigned to a transcript template.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date the row was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TranscriptAssignmentId":{
            "type":"integer",
            "description":"The generated unique identifier for the linkage between a transcript template and a transcript type or types.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "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"
            }
        },
        "TranscriptTypeName":{
            "title":"Name",
            "maxLength":"50",
            "type":"string",
            "description":"The name of the transcript type assigned to a transcript template.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EnabledFlag":{
            "title":"Enable",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the transcript type assigned to a transcript template is active and available for use. The default value is false.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TranscriptTypeId":{
            "type":"integer",
            "description":"The unique identifier for the transcript type that's assigned to a transcript template.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "TranscriptTypeDescription":{
            "type":"string",
            "description":"The description for the transcript type assigned to a transcript template.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date the row was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AssignmentSequence":{
            "type":"integer",
            "description":"The sequence number assigned to the templates for a transcript type.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9"
            },
            "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

templateAssignments

Operation: /fscmRestApi/resources/11.13.18.05/transcriptTemplates/{TranscriptTemplateId}/child/templateAssignments

Parameters:

• TranscriptTemplateId: $request.path.TranscriptTemplateId

The template assignment resource provides a list of assigned transcript templates that can be used with this transcript type.

Back to Top