openapi-directory/api/iqualify.com.json

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

{"openapi":"3.0.0","servers":[{"url":"https://api.iqualify.com/v1"}],"info":{"contact":{"x-twitter":"hello_iqualify"},"description":"The iQualify API offers management responses for building\nlearning experiences using your iQualify instance data.\n\nOnce you’ve registered with iQualify, you can request an API access token by\nnavigating to the API access section of the \"Account Settings\" area.\n\nFind out how to [Request your API access token](https://www.iqualify.com/help/connecting-iqualify-to-other-systems/api/how-to-access-and-manage-your-api-token)\non our Knowledge base.\n\nAll endpoints are only accessible via https and are located at\napi.iqualify.com. For instance: you can find your current offerings by\naccessing the following URL:\n\n    https://api.iqualify.com/v1/offerings/current\n\n","title":"iQualify Management API","version":"v1","x-apisguru-categories":["education"],"x-logo":{"url":"https://twitter.com/hello_iqualify/profile_image?size=original"},"x-origin":[{"format":"openapi","url":"https://api.iqualify.com/v1/management.json","version":"3.0"}],"x-providerName":"iqualify.com"},"security":[{"Authorization":[]}],"tags":[],"paths":{"/":{"get":{"description":"Responds with all supported endpoints URLs for v2 version.","responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Supported endpoints"}},"summary":"List supported endpoints URLs","tags":["API info"]}},"/course-mappings":{"get":{"description":"Returns all course mappings for course offerings.","responses":{"200":{"content":{"application/json":{"schema":{"additionalProperties":{"type":"string"},"title":"course mappings","type":"object"}}},"description":"Course Mappings"},"401":{"$ref":"#/components/responses/NotAuthorizedError"},"403":{"$ref":"#/components/responses/AccessDeniedError"}},"summary":"Find course mappings","tags":["Course mappings"]}},"/course-mappings/externalcourse/{externalCourseId}":{"get":{"description":"Responds with course mapping details by externalCourseId.","parameters":[{"$ref":"#/components/parameters/externalCourseId"}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"type":"string"},"type":"array"}}},"description":"Course Mapping"},"401":{"$ref":"#/components/responses/NotAuthorizedError"},"403":{"$ref":"#/components/responses/AccessDeniedError"},"404":{"$ref":"#/components/responses/ObjectNotFoundError"}},"summary":"Find course mappings by externalCourseId","tags":["Course mappings"]}},"/course-mappings/{offeringId}":{"get":{"description":"Responds with course mapping details by offeringId.","parameters":[{"$ref":"#/components/parameters/offeringId"}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"type":"string"},"type":"array"}}},"description":"Course Mapping"},"401":{"$ref":"#/components/responses/NotAuthorizedError"},"403":{"$ref":"#/components/responses/AccessDeniedError"},"404":{"$ref":"#/components/responses/ObjectNotFoundError"}},"summary":"Find course mappings by offeringId","tags":["Course mappings"]}},"/course-mappings/{offeringId}/{externalCourseId}":{"delete":{"description":"Removes the course mapping between the offering and the externalCourseId.","parameters":[{"$ref":"#/components/parameters/offeringId"},{"$ref":"#/components/parameters/externalCourseId"}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"type":"string"},"type":"array"}}},"description":"Course Mapping"},"401":{"$ref":"#/components/responses/NotAuthorizedError"},"403":{"$ref":"#/components/responses/AccessDeniedError"},"404":{"$ref":"#/components/responses/ObjectNotFoundError"}},"summary":"Remove course mapping","tags":["Course mappings"]},"put":{"description":"Creates a mapping between the offering and the externalCourseId.","parameters":[{"$ref":"#/components/parameters/offeringId"},{"$ref":"#/components/parameters/externalCourseId"}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"type":"string"},"type":"array"}}},"description":"Course Mapping"},"401":{"$ref":"#/components/responses/NotAuthorizedError"},"403":{"$ref":"#/components/responses/AccessDeniedError"},"404":{"$ref":"#/components/responses/ObjectNotFoundError"}},"summary":"Add course mapping","tags":["Course mappings"]}},"/courses":{"get":{"description":"Responds with all courses (draft and published.)","responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/CourseResponse"},"title":"Courses","type":"array"}}},"description":"All courses (draft and published) in the organisation."},"401":{"$ref":"#/components/responses/NotAuthorizedError"},"403":{"$ref":"#/components/responses/AccessDeniedError"}},"summary":"Find courses","tags":["Courses"]}},"/courses/{contentId}":{"get":{"description":"Responds with a course matching the contentId.","parameters":[{"description":"The content Id","in":"path","name":"contentId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CourseMetaResponse"}}},"description":"Course detail"},"401":{"$ref":"#/components/responses/NotAuthorizedError"},"403":{"$ref":"#/components/responses/AccessDeniedError"},"404":{"$ref":"#/components/responses/ObjectNotFoundError"}},"summary":"Find course by contentId","tags":["Courses"]}},"/courses/{contentId}/activations":{"get":{"description":"Responds with all activations for the contentId provided.","parameters":[{"description":"The content Id","in":"path","name":"contentId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActivationResponse"}}},"description":"Activation list."},"401":{"$ref":"#/components/responses/NotAuthorizedError"},"403":{"$ref":"#/components/responses/AccessDeniedError"},"404":{"$ref":"#/components/responses/ObjectNotFoundError"}},"summary":"Find activations for a contentId","tags":["Courses"]}},"/courses/{contentId}/metadata/category":{"put":{"description":"Add or update course category in the metadata of a course.","parameters":[{"description":"The content Id","in":"path","name":"contentId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"category":{"type":"string"}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CourseMetaResponse"}}},"description":"Course detail"},"400":{"content":{"application/json":{"examples":{"SchemaAdditionalPropertiesError":{"$ref":"#/components/examples/SchemaAdditionalPropertiesError"},"SchemaRequiredError":{"$ref":"#/components/examples/SchemaRequiredError"},"SchemaTypeError":{"$ref":"#/components/examples/SchemaTypeError"}},"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Bad Request"},"401":{"$ref":"#/components/responses/NotAuthorizedError"},"403":{"$ref":"#/components/responses/AccessDeniedError"},"404":{"$ref":"#/components/responses/ObjectNotFoundError"}},"summary":"Update course category","tags":["Course metadata"]}},"/courses/{contentId}/metadata/level":{"put":{"description":"Add or update the course level in the metadata of a course.","parameters":[{"description":"The content Id","in":"path","name":"contentId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"level":{"type":"string"}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CourseMetaResponse"}}},"description":"Course detail"},"400":{"content":{"application/json":{"examples":{"SchemaAdditionalPropertiesError":{"$ref":"#/components/examples/SchemaAdditionalPropertiesError"},"SchemaRequiredError":{"$ref":"#/components/examples/SchemaRequiredError"},"SchemaTypeError":{"$ref":"#/components/examples/SchemaTypeError"}},"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Bad Request"},"401":{"$ref":"#/components/responses/NotAuthorizedError"},"403":{"$ref":"#/components/responses/AccessDeniedError"},"404":{"$ref":"#/components/responses/ObjectNotFoundError"}},"summary":"Update course level","tags":["Course metadata"]}},"/courses/{contentId}/metadata/tags":{"put":{"description":"Add or update course tags in the metadata of a course.","parameters":[{"description":"The content Id","in":"path","name":"contentId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"tags":{"items":{"type":"string"},"type":"array"}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CourseMetaResponse"}}},"description":"Course detail"},"400":{"content":{"application/json":{"examples":{"SchemaAdditionalPropertiesError":{"$ref":"#/components/examples/SchemaAdditionalPropertiesError"},"SchemaRequiredError":{"$ref":"#/components/examples/SchemaRequiredError"},"SchemaTypeError":{"$ref":"#/components/examples/SchemaTypeError"}},"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Bad Request"},"401":{"$ref":"#/components/responses/NotAuthorizedError"},"403":{"$ref":"#/components/responses/AccessDeniedError"},"404":{"$ref":"#/components/responses/ObjectNotFoundError"}},"summary":"Update course tags","tags":["Course metadata"]}},"/courses/{contentId}/metadata/topic":{"put":{"description":"Add or update the course topic in the metadata of a course.","parameters":[{"description":"The content Id","in":"path","name":"contentId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"topic":{"type":"string"}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CourseMetaResponse"}}},"description":"Course detail"},"400":{"content":{"application/json":{"examples":{"SchemaAdditionalPropertiesError":{"$ref":"#/components/examples/SchemaAdditionalPropertiesError"},"SchemaRequiredError":{"$ref":"#/components/examples/SchemaRequiredError"},"SchemaTypeError":{"$ref":"#/components/examples/SchemaTypeError"}},"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Bad Request"},"401":{"$ref":"#/components/responses/NotAuthorizedError"},"403":{"$ref":"#/components/responses/AccessDeniedError"},"404":{"$ref":"#/components/responses/ObjectNotFoundError"}},"summary":"Update course topic","tags":["Course metadata"]}},"/courses/{contentId}/permissions":{"get":{"description":"Responds with users who have access to a specific course by contentId.","parameters":[{"description":"The content Id","in":"path","name":"contentId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserPermission"}}},"description":"List of users who have access to the content ID provided."},"401":{"$ref":"#/components/responses/NotAuthorizedError"},"403":{"$ref":"#/components/responses/AccessDeniedError"},"404":{"$ref":"#/components/responses/ObjectNotFoundError"}},"summary":"Find users who have access to the contentId provided","tags":["Courses"]}},"/courses/{rootContentId}/permissions/{userEmail}":{"post":{"description":"Provide a user with access to a specific course by rootContentId.","parameters":[{"description":"The content Id","in":"path","name":"rootContentId","required":true,"schema":{"type":"string"}},{"description":"The user email","in":"path","name":"userEmail","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"isBuilder":{"default":true,"type":"boolean"},"isReviewer":{"default":false,"type":"boolean"}},"title":"permission to be granted to the user.","type":"object"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"contentId":{"type":"string"}},"type":"object"}}},"description":"user successfully added to the course with the specified permission."},"400":{"content":{"application/json":{"examples":{"MultipleObjectsError":{"$ref":"#/components/examples/MultipleObjectsError"},"ObjectIsNotError":{"$ref":"#/components/examples/ObjectIsNotError"},"SchemaRequiredError":{"$ref":"#/components/examples/SchemaRequiredError"},"SchemaTypeError":{"$ref":"#/components/examples/SchemaTypeError"}},"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Bad Request"},"401":{"$ref":"#/components/responses/NotAuthorizedError"},"403":{"$ref":"#/components/responses/AccessDeniedError"},"404":{"$ref":"#/components/responses/ObjectNotFoundError"}},"summary":"Update course access","tags":["Courses"]}},"/offerings":{"get":{"description":"Responds with all offerings for your organisation.","responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/OfferingMetadataResponse"},"title":"Offerings","type":"array"}}},"description":"all offerings (current, past and future ones)"},"401":{"$ref":"#/components/responses/NotAuthorizedError"},"403":{"$ref":"#/components/responses/AccessDeniedError"}},"summary":"Find current, past and future offerings","tags":["Offerings"]},"post":{"description":"Creates a new offering.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OfferingRequired"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OfferingMetadataResponse"}}},"description":"offering created"},"400":{"content":{"application/json":{"examples":{"IncompatibleParametersError":{"$ref":"#/components/examples/IncompatibleParametersError"},"InvalidContentError":{"$ref":"#/components/examples/InvalidContentError"},"MissingInfoError":{"$ref":"#/components/examples/MissingInfoError"},"OfferingIncompatibleDatesError":{"$ref":"#/components/examples/OfferingIncompatibleDatesError"},"SchemaFormatError":{"$ref":"#/components/examples/SchemaFormatError"},"SchemaRequiredError":{"$ref":"#/components/examples/SchemaRequiredError"},"SchemaTypeError":{"$ref":"#/components/examples/SchemaTypeError"}},"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Bad Request"},"401":{"$ref":"#/components/responses/NotAuthorizedError"},"403":{"$ref":"#/components/responses/AccessDeniedError"},"404":{"$ref":"#/components/responses/ObjectNotFoundError"}},"summary":"Create offering","tags":["Offerings"]}},"/offerings/current":{"get":{"description":"Responds with active offerings for your organisation.","responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/OfferingMetadataResponse"},"title":"Offerings","type":"array"}}},"description":"current offerings"},"401":{"$ref":"#/components/responses/NotAuthorizedError"},"403":{"$ref":"#/components/responses/AccessDeniedError"}},"summary":"Find active offerings","tags":["Offerings"]}},"/offerings/future":{"get":{"description":"Responds with scheduled offerings for your organisation. Scheduled offerings have a start date after today's date (inclusive).","responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/OfferingMetadataResponse"},"title":"Offerings","type":"array"}}},"description":"future offerings"},"401":{"$ref":"#/components/responses/NotAuthorizedError"},"403":{"$ref":"#/components/responses/AccessDeniedError"}},"summary":"Find scheduled offerings","tags":["Offerings"]}},"/offerings/info/{textPattern}":{"get":{"description":"Find offerings where info field matches the specified text pattern.","parameters":[{"description":"Text pattern to search for (minimum of 3 characters length).","in":"path","name":"textPattern","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/PortfolioActivations"},"title":"Offerings","type":"array"}}},"description":"Offerings"},"400":{"content":{"application/json":{"examples":{"TextPatternError":{"$ref":"#/components/examples/TextPatternError"}},"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Bad Request"},"401":{"$ref":"#/components/responses/NotAuthorizedError"},"403":{"$ref":"#/components/responses/AccessDeniedError"},"404":{"$ref":"#/components/responses/ObjectNotFoundError"}},"summary":"Find offerings where info field matches the specified textPattern","tags":["Offerings"]}},"/offerings/past":{"get":{"description":"Responds with past offerings for your organisation.","responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/OfferingMetadataResponse"},"title":"Offerings","type":"array"}}},"description":"past offerings"},"401":{"$ref":"#/components/responses/NotAuthorizedError"},"403":{"$ref":"#/components/responses/AccessDeniedError"}},"summary":"Find past offerings","tags":["Offerings"]}},"/offerings/summary":{"get":{"description":"Responds with a summary of all offerings for your organisation.","parameters":[{"description":"Returns only the first n results.","in":"query","name":"$top","schema":{"default":"50","type":"string"}},{"description":"Sorts the results.","in":"query","name":"$orderby","schema":{"type":"string"}},{"allowReserved":true,"description":"Filters the results, based on a Boolean condition.","in":"query","name":"$filter","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/PortfolioActivations"},"title":"Offerings","type":"array"}}},"description":"all offerings."},"400":{"content":{"application/json":{"examples":{"ApiValidationError":{"$ref":"#/components/examples/ApiValidationError"},"SchemaQueryError":{"$ref":"#/components/examples/SchemaQueryError"}},"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Bad Request"},"401":{"$ref":"#/components/responses/NotAuthorizedError"},"403":{"$ref":"#/components/responses/AccessDeniedError"}},"summary":"Offerings summary","tags":["Offerings"]}},"/offerings/{offeringId}":{"get":{"description":"Responds with an offering matching the offeringId.","parameters":[{"$ref":"#/components/parameters/offeringId"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OfferingMetadataResponse"}}},"description":"offering"},"401":{"$ref":"#/components/responses/NotAuthorizedError"},"403":{"$ref":"#/components/responses/AccessDeniedError"},"404":{"$ref":"#/components/responses/ObjectNotFoundError"}},"summary":"Find offering by ID","tags":["Offerings"]},"patch":{"description":"Updates the offering.","parameters":[{"$ref":"#/components/parameters/offeringId"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Offering"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OfferingMetadataResponse"}}},"description":"offering updated"},"400":{"content":{"application/json":{"examples":{"IncompatibleParametersError":{"$ref":"#/components/examples/IncompatibleParametersError"},"MissingInfoError":{"$ref":"#/components/examples/MissingInfoError"},"ObjectExistsError":{"$ref":"#/components/examples/ObjectExistsError"},"OfferingIncompatibleDatesError":{"$ref":"#/components/examples/OfferingIncompatibleDatesError"},"SchemaFormatError":{"$ref":"#/components/examples/SchemaFormatError"},"SchemaTypeError":{"$ref":"#/components/examples/SchemaTypeError"}},"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Bad Request"},"401":{"$ref":"#/components/responses/NotAuthorizedError"},"403":{"$ref":"#/components/responses/AccessDeniedError"},"404":{"$ref":"#/components/responses/ObjectNotFoundError"}},"summary":"Update offering","tags":["Offerings"]}},"/offerings/{offeringId}/activities/openresponse":{"get":{"description":"Responds with the activities in a specific offering.","parameters":[{"$ref":"#/components/parameters/offeringId"}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/OfferingActivitiesResponse"},"title":"Activities","type":"array"}}},"description":"offering's learners"},"401":{"$ref":"#/components/responses/NotAuthorizedError"},"403":{"$ref":"#/components/responses/AccessDeniedError"},"404":{"$ref":"#/components/responses/ObjectNotFoundError"}},"summary":"Find offering's activities","tags":["Assessment management"]}},"/offerings/{offeringId}/analytics/activities/responses":{"get":{"description":"Responds with all learner activity attempts for open response activities in an offering matching the offeringId.","parameters":[{"$ref":"#/components/parameters/offeringId"}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/ActivityAttemptOpenResponse"},"title":"OfferingActivityAttemptOpenResponses","type":"array"}}},"description":"Offering activity attempt open responses"},"401":{"$ref":"#/components/responses/NotAuthorizedError"},"403":{"$ref":"#/components/responses/AccessDeniedError"},"404":{"$ref":"#/components/responses/ObjectNotFoundError"}},"summary":"Find open response activity attempts","tags":["Assessment data"]}},"/offerings/{offeringId}/analytics/channels/{channelId}/comments":{"get":{"description":"Responds with a list of comments made in any posts in a specified channel, within an offering.","parameters":[{"$ref":"#/components/parameters/offeringId"},{"$ref":"#/components/parameters/channelId"}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Comment"},"title":"Comments","type":"array"}}},"description":"Successful response"},"401":{"$ref":"#/components/responses/NotAuthorizedError"},"403":{"$ref":"#/components/responses/AccessDeniedError"},"404":{"$ref":"#/components/responses/ObjectNotFoundError"}},"summary":"Find comments","tags":["Channels"]}},"/offerings/{offeringId}/analytics/channels/{channelId}/posts":{"get":{"description":"Responds with a list of posts made in a specified channel, within an offering.","parameters":[{"$ref":"#/components/parameters/offeringId"},{"$ref":"#/components/parameters/channelId"}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/httpPost"},"title":"Posts","type":"array"}}},"description":"Successful response"},"401":{"$ref":"#/components/responses/NotAuthorizedError"},"403":{"$ref":"#/components/responses/AccessDeniedError"},"404":{"$ref":"#/components/responses/ObjectNotFoundError"}},"summary":"Find posts","tags":["Channels"]}},"/offerings/{offeringId}/analytics/channels/{channelId}/replies":{"get":{"description":"Responds with a list of replies to comments in any posts in a specified channel, within an offering.","parameters":[{"$ref":"#/components/parameters/offeringId"},{"$ref":"#/components/parameters/channelId"}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Comment"},"title":"Comments","type":"array"}}},"description":"Successful response"},"401":{"$ref":"#/components/responses/NotAuthorizedError"},"403":{"$ref":"#/components/responses/AccessDeniedError"},"404":{"$ref":"#/components/responses/ObjectNotFoundError"}},"summary":"Find replies","tags":["Channels"]}},"/offerings/{offeringId}/analytics/learners-progress":{"get":{"description":"Responds with all learner progress in the offering.","parameters":[{"$ref":"#/components/parameters/offeringId"}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/LearnerProgressResponse"},"title":"LearnersProgress","type":"array"}}},"description":"Learners progress"},"401":{"$ref":"#/components/responses/NotAuthorizedError"},"403":{"$ref":"#/components/responses/AccessDeniedError"},"404":{"$ref":"#/components/responses/ObjectNotFoundError"}},"summary":"Find learner progress in a specified offering","tags":["Learner activity"]}},"/offerings/{offeringId}/analytics/marks/assignments":{"get":{"description":"Responds with all learner assessment marks in an offering matching the offeringId.","parameters":[{"$ref":"#/components/parameters/offeringId"}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/AssignmentMarkResponse"},"title":"AssignmentsMarks","type":"array"}}},"description":"Assignments marks"},"401":{"$ref":"#/components/responses/NotAuthorizedError"},"403":{"$ref":"#/components/responses/AccessDeniedError"},"404":{"$ref":"#/components/responses/ObjectNotFoundError"}},"summary":"Find assessment marks","tags":["Assessment data"]}},"/offerings/{offeringId}/analytics/marks/quizzes":{"get":{"description":"Responds with all learner quiz marks in an offering matching the offeringId.","parameters":[{"$ref":"#/components/parameters/offeringId"}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/QuizMarkResponse"},"title":"QuizzesMarks","type":"array"}}},"description":"Quizzes marks"},"401":{"$ref":"#/components/responses/NotAuthorizedError"},"403":{"$ref":"#/components/responses/AccessDeniedError"},"404":{"$ref":"#/components/responses/ObjectNotFoundError"}},"summary":"Find quiz marks","tags":["Assessment data"]}},"/offerings/{offeringId}/analytics/pulses":{"get":{"description":"Responds with the IDs of all pulses that learners have responded to in a specified offering.","parameters":[{"$ref":"#/components/parameters/offeringId"}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"type":"string"},"type":"array"}}},"description":"Pulses' ids"},"401":{"$ref":"#/components/responses/NotAuthorizedError"},"403":{"$ref":"#/components/responses/AccessDeniedError"},"404":{"$ref":"#/components/responses/ObjectNotFoundError"}},"summary":"Find all pulse IDs in the specified offering","tags":["Pulses"]}},"/offerings/{offeringId}/analytics/pulses/responses":{"get":{"description":"Responds with pulse's responses in an offering matching the offeringId.","parameters":[{"$ref":"#/components/parameters/offeringId"},{"description":"Filter pulse responses by type.","in":"query","name":"pulseType","schema":{"enum":["submit_text","MCQ","spatial_triangular","spatial_planar","spatial_linear"],"type":"string"}},{"allowReserved":true,"description":"Filter pulse responses by responseTime. Lower then (`lt`), lower then or equal (`lte`), greater then (`gt`) and greater then or equal (`gte`) operators are available. Example of filtering by time range __gte__2017-03-14T07:30:00Z__","in":"query","name":"responseTime","schema":{"oneOf":[{"minLength":1,"type":"string"},{"items":{"type":"string"},"type":"array"}]}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/PulseResponse"},"title":"Pulses","type":"array"}}},"description":"All pulses' responses"},"401":{"$ref":"#/components/responses/NotAuthorizedError"},"403":{"$ref":"#/components/responses/AccessDeniedError"},"404":{"$ref":"#/components/responses/ObjectNotFoundError"}},"summary":"Find pulses by offeringId","tags":["Pulses"]}},"/offerings/{offeringId}/analytics/pulses/{pulseId}/responses":{"get":{"description":"Responds with pulse's responses, matching the pulseId, in an offering matching the offeringId.","parameters":[{"$ref":"#/components/parameters/offeringId"},{"description":"pulse's base id","in":"path","name":"pulseId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/PulseResponse"},"title":"Pulses","type":"array"}}},"description":"Pulse data matching pulseId"},"401":{"$ref":"#/components/responses/NotAuthorizedError"},"403":{"$ref":"#/components/responses/AccessDeniedError"},"404":{"$ref":"#/components/responses/ObjectNotFoundError"}},"summary":"Find pulses by offeringId and pulseId","tags":["Pulses"]}},"/offerings/{offeringId}/analytics/social-notes":{"get":{"description":"Responds with all shared social notes in a specified offering.","parameters":[{"$ref":"#/components/parameters/offeringId"}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/SocialNotesResponse"},"title":"OfferingSocialNotes","type":"array"}}},"description":"Offering social notes"},"401":{"$ref":"#/components/responses/NotAuthorizedError"},"403":{"$ref":"#/components/responses/AccessDeniedError"},"404":{"$ref":"#/components/responses/ObjectNotFoundError"}},"summary":"Find shared social notes in an offering","tags":["Learner activity"]}},"/offerings/{offeringId}/analytics/submissions/assignments":{"get":{"description":"Responds with all learner assessment submissions and marks, if any, in an offering matching the offeringId.","parameters":[{"$ref":"#/components/parameters/offeringId"}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/AssignmentMarkResponse"},"title":"AssignmentsSubmissions","type":"array"}}},"description":"Assignments submissions"},"401":{"$ref":"#/components/responses/NotAuthorizedError"},"403":{"$ref":"#/components/responses/AccessDeniedError"},"404":{"$ref":"#/components/responses/ObjectNotFoundError"}},"summary":"Find submissions to assessments, including marks if any","tags":["Assessment data"]}},"/offerings/{offeringId}/analytics/submissions/open-response/{assessmentId}":{"get":{"description":"Responds with all learner assessment submissions and marks, if any, in a specified open response assessment.","parameters":[{"$ref":"#/components/parameters/offeringId"},{"$ref":"#/components/parameters/assessmentId"}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/SubmissionMarkResponse"},"title":"SubmissionMarkResponse","type":"array"}}},"description":"Responds with assignment submissions for the specified assignment."},"401":{"$ref":"#/components/responses/NotAuthorizedError"},"403":{"$ref":"#/components/responses/AccessDeniedError"},"404":{"$ref":"#/components/responses/ObjectNotFoundError"}},"summary":"Find submissions to a specified open response assessment, including marks if any","tags":["Assessment data"]}},"/offerings/{offeringId}/analytics/submissions/{userEmail}/assignments/{assessmentId}":{"get":{"description":"Responds with the learner's assessment submission and any marks for the submission.","parameters":[{"$ref":"#/components/parameters/offeringId"},{"$ref":"#/components/parameters/userEmail"},{"$ref":"#/components/parameters/assessmentId"}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/SubmissionMarkResponse"},"title":"SubmissionMarkResponse","type":"array"}}},"description":"Responds with the learner's assessment submission and any marks for the submission."},"401":{"$ref":"#/components/responses/NotAuthorizedError"},"403":{"$ref":"#/components/responses/AccessDeniedError"},"404":{"$ref":"#/components/responses/ObjectNotFoundError"}},"summary":"Find a learner's submission to a specified assessment, including marks if any","tags":["Assessment data"]}},"/offerings/{offeringId}/analytics/unit-reactions":{"get":{"description":"Responds with user reactions to units in a specified offering.","parameters":[{"$ref":"#/components/parameters/offeringId"}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/UnitReactionsAnalyticsResponse"},"title":"UnitReactiosAnalytics","type":"array"}}},"description":"Unit Reactions"},"401":{"$ref":"#/components/responses/NotAuthorizedError"},"403":{"$ref":"#/components/responses/AccessDeniedError"},"404":{"$ref":"#/components/responses/ObjectNotFoundError"}},"summary":"Find unit reactions","tags":["Learner activity"]}},"/offerings/{offeringId}/assessments":{"get":{"description":"Responds with all assessments in an offering matching the offeringId.","parameters":[{"$ref":"#/components/parameters/offeringId"}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/AssessmentResponse"},"title":"Assessments","type":"array"}}},"description":"offering's assessments"},"401":{"$ref":"#/components/responses/NotAuthorizedError"},"403":{"$ref":"#/components/responses/AccessDeniedError"},"404":{"$ref":"#/components/responses/ObjectNotFoundError"}},"summary":"Find offering's assessments","tags":["Assessment management"]}},"/offerings/{offeringId}/assessments/{assessmentId}":{"patch":{"description":"Updates the assessment details for a specified assessment in an offering.","parameters":[{"$ref":"#/components/parameters/offeringId"},{"description":"assessment's id","in":"path","name":"assessmentId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Assessment"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssessmentResponse"}}},"description":"assessment successfully updated"},"400":{"content":{"application/json":{"examples":{"SchemaFormatError":{"$ref":"#/components/examples/SchemaFormatError"},"SchemaMinLengthError":{"$ref":"#/components/examples/SchemaMinLengthError"}},"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Bad Request"},"401":{"$ref":"#/components/responses/NotAuthorizedError"},"403":{"$ref":"#/components/responses/AccessDeniedError"},"404":{"$ref":"#/components/responses/ObjectNotFoundError"}},"summary":"Update assessment details","tags":["Assessment management"]}},"/offerings/{offeringId}/assessments/{assessmentId}/documents":{},"/offerings/{offeringId}/assessments/{assessmentId}/documents/{documentId}":{"delete":{"description":"Removes the assessment document file for a specified assessment in an offering.","parameters":[{"$ref":"#/components/parameters/offeringId"},{"description":"assessment's id","in":"path","name":"assessmentId","required":true,"schema":{"type":"string"}},{"description":"documents's id","in":"path","name":"documentId","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"assessment document successfully removed"},"401":{"$ref":"#/components/responses/NotAuthorizedError"},"403":{"$ref":"#/components/responses/AccessDeniedError"},"404":{"$ref":"#/components/responses/ObjectNotFoundError"}},"summary":"Remove assessment document","tags":["Assessment management"]}},"/offerings/{offeringId}/assessments/{assessmentId}/{userEmail}":{"patch":{"description":"Updates the due dates for a learner's quiz attempt specified by the assessmentId.","parameters":[{"$ref":"#/components/parameters/offeringId"},{"description":"assessment's id","in":"path","name":"assessmentId","required":true,"schema":{"type":"string"}},{"description":"user's email","in":"path","name":"userEmail","required":true,"schema":{"format":"email","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"dueDate":{"format":"date-time","type":"string"}},"type":"object"}}},"required":true},"responses":{"204":{"description":"Successfully updated assessment due date."},"400":{"content":{"application/json":{"examples":{"InvalidParameterError":{"$ref":"#/components/examples/InvalidParameterError"},"ObjectInvalidPropertyError":{"$ref":"#/components/examples/ObjectInvalidPropertyError"},"SchemaFormatError":{"$ref":"#/components/examples/SchemaFormatError"}},"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Bad Request"},"401":{"$ref":"#/components/responses/NotAuthorizedError"},"403":{"$ref":"#/components/responses/AccessDeniedError"},"404":{"$ref":"#/components/responses/ObjectNotFoundError"}},"summary":"Update the due dates for a learner's quiz attempt","tags":["Assessment management"]}},"/offerings/{offeringId}/badges":{"get":{"description":"Responds with the badge for an offering matching the offeringId.","parameters":[{"$ref":"#/components/parameters/offeringId"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Badge"}}},"description":"badges"},"401":{"$ref":"#/components/responses/NotAuthorizedError"},"403":{"$ref":"#/components/responses/AccessDeniedError"},"404":{"$ref":"#/components/responses/ObjectNotFoundError"}},"summary":"Find offering badges","tags":["Badges"]}},"/offerings/{offeringId}/channels":{"get":{"description":"Responds with a list of channels in an offering.","parameters":[{"$ref":"#/components/parameters/offeringId"}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/ChannelResponse"},"title":"List of channels in a offering","type":"array"}}},"description":"Succesful response"},"401":{"$ref":"#/components/responses/NotAuthorizedError"},"403":{"$ref":"#/components/responses/AccessDeniedError"},"404":{"$ref":"#/components/responses/ObjectNotFoundError"}},"summary":"Find channels","tags":["Channels"]},"post":{"description":"Adds new channel to the specified offering.","parameters":[{"$ref":"#/components/parameters/offeringId"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChannelRequired"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChannelResponse"}}},"description":"channel successfully added"},"400":{"content":{"application/json":{"examples":{"SchemaMinLengthError":{"$ref":"#/components/examples/SchemaMinLengthError"},"SchemaRequiredError":{"$ref":"#/components/examples/SchemaRequiredError"},"SchemaTypeError":{"$ref":"#/components/examples/SchemaTypeError"}},"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Bad Request"},"401":{"$ref":"#/components/responses/NotAuthorizedError"},"403":{"$ref":"#/components/responses/AccessDeniedError"},"404":{"$ref":"#/components/responses/ObjectNotFoundError"}},"summary":"Add channel","tags":["Channels"]}},"/offerings/{offeringId}/channels/{channelId}":{"patch":{"description":"Updates a channel in an offering.","parameters":[{"$ref":"#/components/parameters/offeringId"},{"$ref":"#/components/parameters/channelId"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Channel"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChannelResponse"}}},"description":"channel successfully updated"},"400":{"content":{"application/json":{"examples":{"SchemaMinLengthError":{"$ref":"#/components/examples/SchemaMinLengthError"},"SchemaRequiredError":{"$ref":"#/components/examples/SchemaRequiredError"},"SchemaTypeError":{"$ref":"#/components/examples/SchemaTypeError"}},"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Bad Request"},"401":{"$ref":"#/components/responses/NotAuthorizedError"},"403":{"$ref":"#/components/responses/AccessDeniedError"},"404":{"$ref":"#/components/responses/ObjectNotFoundError"}},"summary":"Update channel","tags":["Channels"]}},"/offerings/{offeringId}/channels/{channelId}/learners":{"delete":{"description":"Removes a learner from the specified group channel.","parameters":[{"$ref":"#/components/parameters/offeringId"},{"$ref":"#/components/parameters/channelId"}],"requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"email":{"type":"string"}},"type":"object"}}},"required":true},"responses":{"204":{"description":"Learner successfully removed from the channel."},"400":{"content":{"application/json":{"examples":{"InvalidGroupChannelError":{"$ref":"#/components/examples/InvalidGroupChannelError"},"UserNotInOfferingError":{"$ref":"#/components/examples/UserNotInOfferingError"}},"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Bad Request"},"401":{"$ref":"#/components/responses/NotAuthorizedError"},"403":{"$ref":"#/components/responses/AccessDeniedError"},"404":{"$ref":"#/components/responses/ObjectNotFoundError"}},"summary":"Remove learners from a group channel","tags":["Channels"]},"get":{"description":"Finds all learners in a specified group channel.","parameters":[{"$ref":"#/components/parameters/offeringId"},{"$ref":"#/components/parameters/channelId"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChannelResponse"}}},"description":"channel data"},"400":{"content":{"application/json":{"examples":{"InvalidGroupChannelError":{"$ref":"#/components/examples/InvalidGroupChannelError"}},"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Bad Request"},"401":{"$ref":"#/components/responses/NotAuthorizedError"},"403":{"$ref":"#/components/responses/AccessDeniedError"},"404":{"$ref":"#/components/responses/ObjectNotFoundError"}},"summary":"Find learners in a group channel","tags":["Channels"]},"post":{"description":"Adds a learner to a specified group channel.","parameters":[{"$ref":"#/components/parameters/offeringId"},{"$ref":"#/components/parameters/channelId"}],"requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"email":{"type":"string"}},"type":"object"}}},"required":true},"responses":{"204":{"description":"Learner successfully added to the channel."},"400":{"content":{"application/json":{"examples":{"InvalidGroupChannelError":{"$ref":"#/components/examples/InvalidGroupChannelError"},"ObjectExistsError":{"$ref":"#/components/examples/ObjectExistsError"},"SchemaMinLengthError":{"$ref":"#/components/examples/SchemaMinLengthError"},"SchemaRequiredError":{"$ref":"#/components/examples/SchemaRequiredError"},"SchemaTypeError":{"$ref":"#/components/examples/SchemaTypeError"},"UserNotInOfferingError":{"$ref":"#/components/examples/UserNotInOfferingError"}},"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Bad Request"},"401":{"$ref":"#/components/responses/NotAuthorizedError"},"403":{"$ref":"#/components/responses/AccessDeniedError"},"404":{"$ref":"#/components/responses/ObjectNotFoundError"}},"summary":"Add learners to a group channel","tags":["Channels"]}},"/offerings/{offeringId}/cover-image":{},"/offerings/{offeringId}/groups":{"get":{"description":"Responds with a list of assessment groups in an offering.","parameters":[{"$ref":"#/components/parameters/offeringId"}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/AssessmentGroupResponse"},"title":"List of assessment groups in an offering","type":"array"}}},"description":"Succesful response"},"401":{"$ref":"#/components/responses/NotAuthorizedError"},"403":{"$ref":"#/components/responses/AccessDeniedError"},"404":{"$ref":"#/components/responses/ObjectNotFoundError"}},"summary":"Find assessment groups","tags":["Assessment groups"]},"post":{"description":"Creates a new assessment group in an offering.","parameters":[{"$ref":"#/components/parameters/offeringId"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssessmentGroupRequired"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssessmentGroupResponse"}}},"description":"assessment group successfully added"},"400":{"content":{"application/json":{"examples":{"SchemaMinLengthError":{"$ref":"#/components/examples/SchemaMinLengthError"},"SchemaRequiredError":{"$ref":"#/components/examples/SchemaRequiredError"}},"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Bad Request"},"401":{"$ref":"#/components/responses/NotAuthorizedError"},"403":{"$ref":"#/components/responses/AccessDeniedError"},"404":{"$ref":"#/components/responses/ObjectNotFoundError"}},"summary":"Add an assessment group","tags":["Assessment groups"]}},"/offerings/{offeringId}/groups/{groupId}/learners":{"get":{"description":"Responds with a list of learners in a specified assessment group.","parameters":[{"$ref":"#/components/parameters/offeringId"},{"$ref":"#/components/parameters/groupId"}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/UserResponse"},"title":"List of learners","type":"array"}}},"description":"Succesful response"},"400":{"content":{"application/json":{"examples":{"SchemaMinLengthError":{"$ref":"#/components/examples/SchemaMinLengthError"},"SchemaRequiredError":{"$ref":"#/components/examples/SchemaRequiredError"}},"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Bad Request"},"401":{"$ref":"#/components/responses/NotAuthorizedError"},"403":{"$ref":"#/components/responses/AccessDeniedError"},"404":{"$ref":"#/components/responses/ObjectNotFoundError"}},"summary":"Find learners in an assessment group","tags":["Assessment groups"]},"post":{"description":"Adds a learner into the specified assessment group.","parameters":[{"$ref":"#/components/parameters/offeringId"},{"$ref":"#/components/parameters/groupId"}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"email":{"type":"string"}},"type":"object"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserResponse"}}},"description":"Succesful response"},"400":{"content":{"application/json":{"examples":{"ApiValidationError":{"$ref":"#/components/examples/ApiValidationError"}},"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Bad Request"},"401":{"$ref":"#/components/responses/NotAuthorizedError"},"403":{"$ref":"#/components/responses/AccessDeniedError"},"404":{"$ref":"#/components/responses/ObjectNotFoundError"}},"summary":"Add a learner to an assessment group","tags":["Assessment groups"]}},"/offerings/{offeringId}/groups/{groupId}/learners/{userEmail}":{"delete":{"description":"Removes a learner from the specified assessment group.","parameters":[{"$ref":"#/components/parameters/offeringId"},{"$ref":"#/components/parameters/groupId"},{"$ref":"#/components/parameters/userEmail"}],"responses":{"204":{"description":"user successfully removed from the assessment group"},"400":{"content":{"application/json":{"examples":{"ApiValidationError":{"$ref":"#/components/examples/ApiValidationError"}},"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Bad Request"},"401":{"$ref":"#/components/responses/NotAuthorizedError"},"403":{"$ref":"#/components/responses/AccessDeniedError"},"404":{"$ref":"#/components/responses/ObjectNotFoundError"}},"summary":"Remove a learner from an assessment group","tags":["Assessment groups"]}},"/offerings/{offeringId}/learners/pending-submission":{"get":{"description":"Responds with learners who have one or more assessments due x days before the due date, with each assessment that is due, where x = the number of days specified in the request. The default is 3 days.","parameters":[{"$ref":"#/components/parameters/offeringId"},{"description":"days to assessment due date. Default is 3 days","in":"query","name":"days","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/AssessmentPendingSubmission"},"title":"Assessments","type":"array"}}},"description":"offering's learners"},"400":{"content":{"application/json":{"examples":{"SchemaTypeError":{"$ref":"#/components/examples/SchemaTypeError"}},"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Bad Request"},"401":{"$ref":"#/components/responses/NotAuthorizedError"},"403":{"$ref":"#/components/responses/AccessDeniedError"},"404":{"$ref":"#/components/responses/ObjectNotFoundError"}},"summary":"Find learners with assessments pending x days before due date within the specified offeringId","tags":["Assessment management"]}},"/offerings/{offeringId}/metadata/category":{"put":{"description":"Updates the offering category metadata.","parameters":[{"$ref":"#/components/parameters/offeringId"}],"requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"category":{"type":"string"}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OfferingMetadataResponse"}}},"description":"offering updated"},"400":{"content":{"application/json":{"examples":{"SchemaTypeError":{"$ref":"#/components/examples/SchemaTypeError"}},"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Bad Request"},"401":{"$ref":"#/components/responses/NotAuthorizedError"},"403":{"$ref":"#/components/responses/AccessDeniedError"},"404":{"$ref":"#/components/responses/ObjectNotFoundError"}},"summary":"Update offering category metadata","tags":["Offering metadata"]}},"/offerings/{offeringId}/metadata/level":{"put":{"description":"Updates the offering level metadata.","parameters":[{"$ref":"#/components/parameters/offeringId"}],"requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"level":{"type":"string"}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OfferingMetadataResponse"}}},"description":"offering updated"},"400":{"content":{"application/json":{"examples":{"SchemaTypeError":{"$ref":"#/components/examples/SchemaTypeError"}},"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Bad Request"},"401":{"$ref":"#/components/responses/NotAuthorizedError"},"403":{"$ref":"#/components/responses/AccessDeniedError"},"404":{"$ref":"#/components/responses/ObjectNotFoundError"}},"summary":"Update offering level metadata","tags":["Offering metadata"]}},"/offerings/{offeringId}/metadata/tags":{"put":{"description":"Updates the offering tags metadata.","parameters":[{"$ref":"#/components/parameters/offeringId"}],"requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"tags":{"items":{"type":"string"},"type":"array"}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OfferingMetadataResponse"}}},"description":"offering updated"},"400":{"con