Jump to

• Request
• Response

Get all curriculum tags

get

/fscmRestApi/resources/11.13.18.05/curriculumTags

Request

Query Parameters

• expand: string
  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).
• fields: string
  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
• finder: string
  Used as a predefined finder to search the collection.
  
  Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables
  
  

  • AreaOfStudyTagFinder Finds all the area of study curriculum tags.
    Finder Variables
  • PrimaryKey Finds all curriculum tags that match the primary key criteria specified.
    Finder Variables
    • CurriculumTagNameId; integer; Unique identifier for the curriculum tag.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• links: string
  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
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • CurriculumTagName; string; The name of a curriculum tag.
  • CurriculumTagNameCode; string; A code for a curriculum tag.
  • CurriculumTagNameId; integer; A generated primary key column for a curriculum tag.
  • UseDisplayOrderFlag; boolean; 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.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

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.

There's no request body for this operation.

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 : curriculumTags

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/curriculumTags-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"BusinessObject",
        "group":"HED"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object curriculumTags-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/curriculumTags-item-response"
    }
}

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

Type: object

Show Source

• CurriculumTagName: string
  Title: Name

  Read Only: true

  Maximum Length: 50

  The name of a curriculum tag.
• CurriculumTagNameCode: string
  Title: Tag Code

  Read Only: true

  Maximum Length: 30

  A code for a curriculum tag.
• CurriculumTagNameId: integer (int64)
  Title: Curriculum Tag Name ID

  Read Only: true

  A generated primary key column for a curriculum tag.
• curriculumTagValues: array 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: array Links
  Title: Links

  The link relations associated with the resource instance.
• UseDisplayOrderFlag: boolean
  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.

{
    "type":"object",
    "properties":{
        "CurriculumTagNameCode":{
            "title":"Tag Code",
            "maxLength":"30",
            "type":"string",
            "description":"A code for a curriculum tag.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CurriculumTagName":{
            "title":"Name",
            "maxLength":"50",
            "type":"string",
            "description":"The name of a curriculum tag.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UseDisplayOrderFlag":{
            "title":"Use Display Order",
            "maxLength":"1",
            "type":"boolean",
            "description":"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.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CurriculumTagNameId":{
            "title":"Curriculum Tag Name ID",
            "type":"integer",
            "description":"A generated primary key column for a curriculum tag.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "curriculumTagValues":{
            "title":"Curriculum Tag Values",
            "type":"array",
            "description":"The curriculum tag values resource is a child of the curriculum tags resource and provides a list of tag values for a curriculum tag.",
            "items":{
                "$ref":"#/components/schemas/curriculumTags-curriculumTagValues-item-response"
            }
        }
    }
}

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

• Array of: object curriculumTags-curriculumTagValues-item-response

{
    "title":"Curriculum Tag Values",
    "type":"array",
    "description":"The curriculum tag values resource is a child of the curriculum tags resource and provides a list of tag values for a curriculum tag.",
    "items":{
        "$ref":"#/components/schemas/curriculumTags-curriculumTagValues-item-response"
    }
}

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 : curriculumTags-curriculumTagValues-item-response

Type: object

Show Source

• CurriculumTagValue: string
  Title: Tag Value

  Read Only: true

  Maximum Length: 50

  The name of a curriculum tag value.
• CurriculumTagValueCode: string
  Title: Tag Value Code

  Read Only: true

  Maximum Length: 30

  A code for a curriculum tag value.
• CurriculumTagValueId: integer (int64)
  Title: Curriculum Tag Value ID

  Read Only: true

  A generated primary key column for a curriculum tag value.
• images: array Images
  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.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• taggedCourses: array Tagged Courses
  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.
• taggedPrograms: array Tagged Programs
  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.
• ValueSortNumber: integer (int32)
  Title: Display Order

  Read Only: true

  A numeric value that indicates the sort order of a curriculum tag value.

{
    "type":"object",
    "properties":{
        "images":{
            "title":"Images",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/curriculumTags-curriculumTagValues-images-item-response"
            }
        },
        "CurriculumTagValueId":{
            "title":"Curriculum Tag Value ID",
            "type":"integer",
            "description":"A generated primary key column for a curriculum tag value.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CurriculumTagValueCode":{
            "title":"Tag Value Code",
            "maxLength":"30",
            "type":"string",
            "description":"A code for a curriculum tag value.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "taggedCourses":{
            "title":"Tagged Courses",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/curriculumTags-curriculumTagValues-taggedCourses-item-response"
            }
        },
        "CurriculumTagValue":{
            "title":"Tag Value",
            "maxLength":"50",
            "type":"string",
            "description":"The name of a curriculum tag value.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ValueSortNumber":{
            "title":"Display Order",
            "type":"integer",
            "description":"A numeric value that indicates the sort order of a curriculum tag value.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "taggedPrograms":{
            "title":"Tagged Programs",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/curriculumTags-curriculumTagValues-taggedPrograms-item-response"
            }
        }
    }
}

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

• Array of: object curriculumTags-curriculumTagValues-images-item-response

{
    "title":"Images",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/curriculumTags-curriculumTagValues-images-item-response"
    }
}

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 : 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

• Array of: object curriculumTags-curriculumTagValues-taggedCourses-item-response

{
    "title":"Tagged Courses",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/curriculumTags-curriculumTagValues-taggedCourses-item-response"
    }
}

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

• Array of: object curriculumTags-curriculumTagValues-taggedPrograms-item-response

{
    "title":"Tagged Programs",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/curriculumTags-curriculumTagValues-taggedPrograms-item-response"
    }
}

Nested Schema : curriculumTags-curriculumTagValues-images-item-response

Type: object

Show Source

• ImageContent: string (byte)
  Title: Attachment Content

  Read Only: true

  The content of a curriculum tag value attachment such as an image file.
• ImageContextCode: string
  Title: Context

  Read Only: true

  Maximum Length: 30

  The context for a curriculum tag value attachment indicating usage such as Mobile.
• ImageId: integer (int64)
  Title: Attachment ID

  Read Only: true

  The identifier for an attachment file attached to a curriculum tag value.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• TagValueAttachmentId: integer (int64)
  Title: Tag Value Attachment ID

  Read Only: true

  The identifier for a curriculum tag value attachment.

{
    "type":"object",
    "properties":{
        "ImageId":{
            "title":"Attachment ID",
            "type":"integer",
            "description":"The identifier for an attachment file attached to a curriculum tag value.",
            "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"
            }
        },
        "TagValueAttachmentId":{
            "title":"Tag Value Attachment ID",
            "type":"integer",
            "description":"The identifier for a curriculum tag value attachment.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ImageContent":{
            "title":"Attachment Content",
            "type":"string",
            "description":"The content of a curriculum tag value attachment such as an image file.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ImageContextCode":{
            "title":"Context",
            "maxLength":"30",
            "type":"string",
            "description":"The context for a curriculum tag value attachment indicating usage such as Mobile.",
            "nullable":false,
            "readOnly":true,
            "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 : 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 : curriculumTags-curriculumTagValues-taggedCourses-item-response

Type: object

Show Source

• AcademicOrgId: integer (int64)
  Title: Academic Organization ID

  Read Only: true

  The identifier for an offering academic organization.
• courseStorefronts: array Offering Storefronts
  Title: Offering Storefronts

  The offering storefronts resource is a child of the course resource and provides a list of offering storefronts associated with a course.
• CurriculumId: integer (int64)
  Title: Curriculum ID

  Read Only: true

  A unique identifier for a course.
• CurriculumOrgId: integer (int64)
  Read Only: true

  The identifier of the academic organization that owns the course.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CurriculumId":{
            "title":"Curriculum ID",
            "type":"integer",
            "description":"A unique identifier for a course.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            },
            "x-queryable":true
        },
        "courseStorefronts":{
            "title":"Offering Storefronts",
            "type":"array",
            "description":"The offering storefronts resource is a child of the course resource and provides a list of offering storefronts associated with a course.",
            "items":{
                "$ref":"#/components/schemas/curriculumTags-curriculumTagValues-taggedCourses-courseStorefronts-item-response"
            }
        },
        "AcademicOrgId":{
            "title":"Academic Organization ID",
            "type":"integer",
            "description":"The identifier for an offering academic organization.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CurriculumOrgId":{
            "type":"integer",
            "description":"The identifier of the academic organization that owns the course.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Offering Storefronts

Type: array

Title: Offering Storefronts

The offering storefronts resource is a child of the course resource and provides a list of offering storefronts associated with a course.

Show Source

• Array of: object curriculumTags-curriculumTagValues-taggedCourses-courseStorefronts-item-response

{
    "title":"Offering Storefronts",
    "type":"array",
    "description":"The offering storefronts resource is a child of the course resource and provides a list of offering storefronts associated with a course.",
    "items":{
        "$ref":"#/components/schemas/curriculumTags-curriculumTagValues-taggedCourses-courseStorefronts-item-response"
    }
}

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 : curriculumTags-curriculumTagValues-taggedCourses-courseStorefronts-item-response

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• StorefrontId: integer (int64)
  Title: Storefront ID

  Read Only: true

  The unique identifier for the offering storefront.
• StorefrontName: string
  Title: Storefront Name

  Read Only: true

  The name of the offering storefront.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "StorefrontId":{
            "title":"Storefront ID",
            "type":"integer",
            "description":"The unique identifier for the offering storefront.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice",
                "precision":"18",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "StorefrontName":{
            "title":"Storefront Name",
            "type":"string",
            "description":"The name of the offering storefront.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show",
                "dependencies":[
                    "StorefrontId"
                ]
            },
            "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 : curriculumTags-curriculumTagValues-taggedPrograms-item-response

Type: object

Show Source

• AcademicOrgId: integer (int64)
  Title: Academic Organization ID

  Read Only: true

  The identifier for an offering academic organization.
• CurriculumId: integer (int64)
  Title: Curriculum ID

  Read Only: true

  A unique identifier for a program.
• CurriculumOrgId: integer (int64)
  Read Only: true

  The identifier of the academic organization that owns the program.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• programStorefronts: array Offering Storefronts
  Title: Offering Storefronts

  The offering storefronts resource is a child of the course resource and provides a list of offering storefronts associated with a course.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CurriculumId":{
            "title":"Curriculum ID",
            "type":"integer",
            "description":"A unique identifier for a program.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            },
            "x-queryable":true
        },
        "AcademicOrgId":{
            "title":"Academic Organization ID",
            "type":"integer",
            "description":"The identifier for an offering academic organization.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CurriculumOrgId":{
            "type":"integer",
            "description":"The identifier of the academic organization that owns the program.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "programStorefronts":{
            "title":"Offering Storefronts",
            "type":"array",
            "description":"The offering storefronts resource is a child of the course resource and provides a list of offering storefronts associated with a course.",
            "items":{
                "$ref":"#/components/schemas/curriculumTags-curriculumTagValues-taggedPrograms-programStorefronts-item-response"
            }
        }
    }
}

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 : Offering Storefronts

Type: array

Title: Offering Storefronts

The offering storefronts resource is a child of the course resource and provides a list of offering storefronts associated with a course.

Show Source

• Array of: object curriculumTags-curriculumTagValues-taggedPrograms-programStorefronts-item-response

{
    "title":"Offering Storefronts",
    "type":"array",
    "description":"The offering storefronts resource is a child of the course resource and provides a list of offering storefronts associated with a course.",
    "items":{
        "$ref":"#/components/schemas/curriculumTags-curriculumTagValues-taggedPrograms-programStorefronts-item-response"
    }
}

Nested Schema : curriculumTags-curriculumTagValues-taggedPrograms-programStorefronts-item-response

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• StorefrontId: integer (int64)
  Title: Storefront ID

  Read Only: true

  The unique identifier for the offering storefront.
• StorefrontName: string
  Title: Storefront Name

  Read Only: true

  The name of the offering storefront.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "StorefrontId":{
            "title":"Storefront ID",
            "type":"integer",
            "description":"The unique identifier for the offering storefront.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice",
                "precision":"18",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "StorefrontName":{
            "title":"Storefront Name",
            "type":"string",
            "description":"The name of the offering storefront.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show",
                "dependencies":[
                    "StorefrontId"
                ]
            },
            "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"
    }
}

Back to Top