Get a curriculum tag

get

/fscmRestApi/resources/11.13.18.05/curriculumTags/{CurriculumTagNameId}

Request

Path Parameters
Query Parameters
  • This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2

    Format: <attr1>=<val1>,<attr2>=<value2>
  • When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
  • This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.

    Format: ?fields=Attribute1,Attribute2

    Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
  • This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>

    Example:
    self,canonical
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
  • 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".
  • 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.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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 : curriculumTags-item-response
Type: object
Show Source
  • Title: Name
    Read Only: true
    Maximum Length: 50
    The name of a curriculum tag.
  • Title: Tag Code
    Read Only: true
    Maximum Length: 30
    A code for a curriculum tag.
  • Title: Curriculum Tag Name ID
    Read Only: true
    A generated primary key column for a curriculum tag.
  • Curriculum Tag Values
    Title: Curriculum Tag Values
    The curriculum tag values resource is a child of the curriculum tags resource and provides a list of tag values for a curriculum tag.
  • Links
  • Title: Use Display Order
    Read Only: true
    Maximum Length: 1
    Enables the use of a display sequence number for the values associated with a curriculum tag. If yes, the values associated with a curriculum tag should be the sequence number. If no, the values are sorted in alphabetic order by the curriculum tag value name.
Nested Schema : Curriculum Tag Values
Type: array
Title: Curriculum Tag Values
The curriculum tag values resource is a child of the curriculum tags resource and provides a list of tag values for a curriculum tag.
Show Source
Nested Schema : curriculumTags-curriculumTagValues-item-response
Type: object
Show Source
Nested Schema : Images
Type: array
Title: Images
The images resource is a child of the curriculum tag values resource and provides a list of all image attachments for a curriculum tag value.
Show Source
Nested Schema : Tagged Courses
Type: array
Title: Tagged Courses
The tagged courses resource is a child of the curriculum tag values resource and provides a list of courses that are associated with a curriculum tag value.
Show Source
Nested Schema : Tagged Programs
Type: array
Title: Tagged Programs
The tagged programs resource is a child of the curriculum tag values resource and provides a list of programs that are associated with a curriculum tag value.
Show Source
Nested Schema : curriculumTags-curriculumTagValues-images-item-response
Type: object
Show Source
Nested Schema : curriculumTags-curriculumTagValues-taggedCourses-item-response
Type: object
Show Source
Nested Schema : Course Storefronts
Type: array
Title: Course Storefronts
The offering storefronts resource is a child of the programs resource and provides a list of offering storefronts associated with a course.
Show Source
Nested Schema : curriculumTags-curriculumTagValues-taggedCourses-courseStorefronts-item-response
Type: object
Show Source
Nested Schema : curriculumTags-curriculumTagValues-taggedPrograms-item-response
Type: object
Show Source
Nested Schema : Program Storefronts
Type: array
Title: Program Storefronts
The offering storefronts resource is a child of the programs resource and provides a list of offering storefronts associated with a program.
Show Source
Nested Schema : curriculumTags-curriculumTagValues-taggedPrograms-programStorefronts-item-response
Type: object
Show Source
Back to Top