Microsoft Azure Reviews API

swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Reviews API
schemes:
- https
tags:
- name: Reviews
paths:
  /contentmoderator/review/v1.0/teams/{teamName}/reviews/{reviewId}:
    get:
      tags:
      - Reviews
      operationId: microsoftAzureReviewsGetreview
      description: Returns review details for the passed review ID.
      parameters:
      - name: teamName
        in: path
        description: Your team name.
        required: true
        type: string
      - name: reviewId
        in: path
        description: ID of the review.
        required: true
        type: string
      responses:
        '200':
          description: OK.
          schema:
            $ref: '#/definitions/Review'
        default:
          description: Error response.
          schema:
            $ref: '#/definitions/APIError'
      x-ms-examples:
        Get Review request:
          $ref: ../v1.0/examples/GetReviewResource.JSON
      produces:
      - application/json
      summary: Microsoft Azure Get Contentmoderator Review 0 Teams Teamname Reviews Reviewid
  /contentmoderator/review/v1.0/teams/{teamName}/jobs/{JobId}:
    get:
      tags:
      - Reviews
      operationId: microsoftAzureReviewsGetjobdetails
      description: Get the job details for a job ID.
      parameters:
      - name: teamName
        in: path
        description: Your team name.
        required: true
        type: string
      - name: JobId
        in: path
        description: ID of the job.
        required: true
        type: string
      responses:
        '200':
          description: OK.
          schema:
            $ref: '#/definitions/Job'
        default:
          description: Error response.
          schema:
            $ref: '#/definitions/APIError'
      x-ms-examples:
        Get Job Details request:
          $ref: ../v1.0/examples/GetJobDetailsResource.JSON
      produces:
      - application/json
      summary: Microsoft Azure Get Contentmoderator Review 0 Teams Teamname Jobs Jobid
  /contentmoderator/review/v1.0/teams/{teamName}/reviews:
    post:
      tags:
      - Reviews
      operationId: microsoftAzureReviewsCreatereviews
      description: 'The created reviews appear for reviewers on your team. As reviewers finish reviewing, results of the reviews are posted (that is, HTTP POST) on the specified CallBackEndpoint value.<br><br>CallBack Schemas <br>Review Completion CallBack Sample<br><br>{<br>  "ReviewId": "",<br>  "ModifiedOn": "2016-10-11T22:36:32.9934851Z",<br>  "ModifiedBy": "",<br>  "CallBackType": "Review",<br>  "ContentId": "",<br>  "Metadata": {<br>    "adultscore": "0.xxx",<br>    "a": "False",<br>    "racyscore": "0.xxx",<br>    "r": "True"<br>  },<br>  "ReviewerResultTags": {<br>    "a": "False",<br>    "r": "True"<br>  }<br>}<br><br>.'
      parameters:
      - name: UrlContentType
        description: Content type.
        required: true
        type: string
        in: header
      - $ref: '#/parameters/teamName'
      - $ref: '#/parameters/subTeam'
      - name: createReviewBody
        description: Body of the API for creating reviews.
        in: body
        required: true
        schema:
          type: array
          description: Schema of the body.
          items:
            required:
            - Content
            - ContentId
            - Type
            type: object
            description: Schema items of the body.
            properties:
              Type:
                description: Type of the content.
                enum:
                - Image
                - Text
                type: string
              Content:
                description: Content to review.
                type: string
              ContentId:
                description: Content identifier.
                type: string
              CallbackEndpoint:
                description: Callback endpoint.
                type: string
              Metadata:
                description: Metadata details.
                type: array
                items:
                  required:
                  - Key
                  - Value
                  type: object
                  properties:
                    Key:
                      description: Your key parameter.
                      type: string
                    Value:
                      description: Your value parameter.
                      type: string
      consumes:
      - application/json
      responses:
        '200':
          description: OK.
          schema:
            $ref: '#/definitions/ReviewList'
        default:
          description: Error response.
          schema:
            $ref: '#/definitions/APIError'
      x-ms-examples:
        Create Review request:
          $ref: ../v1.0/examples/CreateReviewResource.JSON
      produces:
      - application/json
      summary: Microsoft Azure Post Contentmoderator Review 0 Teams Teamname Reviews
  /contentmoderator/review/v1.0/teams/{teamName}/jobs:
    post:
      tags:
      - Reviews
      operationId: microsoftAzureReviewsCreatejob
      description: 'A job ID will be returned for the content posted on this endpoint. <br><br>After the content is evaluated against the provided workflow, the review will be created or ignored based on the workflow expression.<br><br>CallBack Schemas <br><br><br>Job Completion CallBack Sample<br><br>{<br>  "JobId": ",<br>  "ReviewId": "",<br>  "WorkFlowId": "default",<br>  "Status": "",<br>  "ContentType": "Image",<br>  "ContentId": "",<br>  "CallBackType": "Job",<br>  "Metadata": {<br>    "adultscore": "0.xxx",<br>    "a": "False",<br>    "racyscore": "0.xxx",<br>    "r": "True"<br>  }<br>}<br><br><br><br>Review Completion CallBack Sample<br><br>{<br>  "ReviewId": "",<br>  "ModifiedOn": "2016-10-11T22:36:32.9934851Z",<br>  "ModifiedBy": "",<br>  "CallBackType": "Review",<br>  "ContentId": "",<br>  "Metadata": {<br>    "adultscore": "0.xxx",<br>    "a": "False",<br>    "racyscore": "0.xxx",<br>    "r": "True"<br>  },<br>  "ReviewerResultTags": {<br>    "a": "False",<br>    "r": "True"<br>  }<br>}<br><br>.'
      parameters:
      - $ref: '#/parameters/teamName'
      - $ref: '#/parameters/ContentType'
      - $ref: '#/parameters/ContentId'
      - $ref: '#/parameters/WorkflowName'
      - $ref: '#/parameters/CallBackEndpoint'
      - name: Content-Type
        description: Content type.
        required: true
        x-ms-client-name: jobContentType
        type: string
        in: header
        enum:
        - application/json
        - image/jpeg
      - name: Content
        description: Content to evaluate.
        in: body
        required: true
        schema:
          required:
          - ContentValue
          type: object
          properties:
            ContentValue:
              description: Content to evaluate for a job.
              type: string
        x-examples:
          application/json: "{\n  \"ContentValue\": \"<Replace with you Image Url>\"\n}"
      consumes:
      - application/json
      - image/jpeg
      responses:
        '200':
          description: OK.
          schema:
            $ref: '#/definitions/JobId'
        default:
          description: Error response.
          schema:
            $ref: '#/definitions/APIError'
      x-ms-examples:
        Create Job request:
          $ref: ../v1.0/examples/CreateJobResource.JSON
      produces:
      - application/json
      - text/json
      summary: Microsoft Azure Post Contentmoderator Review 0 Teams Teamname Jobs
  /contentmoderator/review/v1.0/teams/{teamName}/reviews/{reviewId}/frames:
    post:
      tags:
      - Reviews
      operationId: microsoftAzureReviewsAddvideoframe
      description: 'The created reviews appear for reviewers on your team. As reviewers finish reviewing, results of the reviews are posted (that is, HTTP POST) on the specified CallBackEndpoint value.<br><br>CallBack Schemas <br>Review Completion CallBack Sample<br><br>{<br>  "ReviewId": "",<br>  "ModifiedOn": "2016-10-11T22:36:32.9934851Z",<br>  "ModifiedBy": "",<br>  "CallBackType": "Review",<br>  "ContentId": "",<br>  "Metadata": {<br>    "adultscore": "0.xxx",<br>    "a": "False",<br>    "racyscore": "0.xxx",<br>    "r": "True"<br>  },<br>  "ReviewerResultTags": {<br>    "a": "False",<br>    "r": "True"<br>  }<br>}<br><br>.'
      parameters:
      - $ref: '#/parameters/teamName'
      - name: reviewId
        description: ID of the review.
        in: path
        required: true
        type: string
      - name: timescale
        description: Timescale of the video that you're adding frames to.
        in: query
        required: false
        type: integer
      consumes:
      - application/json
      - application/x-www-form-urlencoded
      responses:
        '200':
          description: OK.
        default:
          description: Error response.
          schema:
            $ref: '#/definitions/APIError'
      produces:
      - application/json
      summary: Microsoft Azure Post Contentmoderator Review 0 Teams Teamname Reviews Reviewid Frames
    get:
      tags:
      - Reviews
      operationId: microsoftAzureReviewsGetvideoframes
      description: 'The created reviews appear for reviewers on your team. As reviewers finish reviewing, results of the reviews are posted (that is, HTTP POST) on the specified CallBackEndpoint value.<br><br>CallBack Schemas <br>Review Completion CallBack Sample<br><br>{<br>  "ReviewId": "",<br>  "ModifiedOn": "2016-10-11T22:36:32.9934851Z",<br>  "ModifiedBy": "",<br>  "CallBackType": "Review",<br>  "ContentId": "",<br>  "Metadata": {<br>    "adultscore": "0.xxx",<br>    "a": "False",<br>    "racyscore": "0.xxx",<br>    "r": "True"<br>  },<br>  "ReviewerResultTags": {<br>    "a": "False",<br>    "r": "True"<br>  }<br>}<br><br>.'
      parameters:
      - $ref: '#/parameters/teamName'
      - $ref: '#/parameters/reviewId'
      - name: startSeed
        in: query
        description: Time stamp of the frame from where you want to start fetching the frames.
        type: integer
      - name: noOfRecords
        in: query
        description: Number of frames to fetch.
        type: integer
      - name: filter
        in: query
        description: Get frames filtered by tags.
        type: string
      consumes:
      - application/json
      responses:
        '200':
          description: OK.
          schema:
            $ref: '#/definitions/Frames'
        default:
          description: Error response.
          schema:
            $ref: '#/definitions/APIError'
      x-ms-examples:
        Get Frames Request:
          $ref: ./examples/GetFramesResource.JSON
      produces:
      - application/json
      summary: Microsoft Azure Get Contentmoderator Review 0 Teams Teamname Reviews Reviewid Frames
  /contentmoderator/review/v1.0/teams/{teamName}/reviews/{reviewId}/publish:
    post:
      tags:
      - Reviews
      operationId: microsoftAzureReviewsPublishvideoreview
      description: Publish a video review.
      parameters:
      - $ref: '#/parameters/teamName'
      - $ref: '#/parameters/reviewId'
      consumes:
      - application/json
      responses:
        '204':
          description: No content.
        default:
          description: Error response.
          schema:
            $ref: '#/definitions/APIError'
      x-ms-examples:
        publish video request:
          $ref: ../v1.0/examples/PublishVideoReviewResource.JSON
      produces:
      - application/json
      summary: Microsoft Azure Post Contentmoderator Review 0 Teams Teamname Reviews Reviewid Publish
  /contentmoderator/review/v1.0/teams/{teamName}/reviews/{reviewId}/transcriptmoderationresult:
    put:
      tags:
      - Reviews
      operationId: microsoftAzureReviewsAddvideotranscriptmoderationresult
      description: This API adds a transcript screen text result file for a video review. The transcript screen text result file is a result of the Screen Text API. To generate a transcript screen text result file, you must screen a transcript file for profanity by using the Screen Text API.
      parameters:
      - name: Content-Type
        description: Content type.
        x-ms-client-name: ContentType
        required: true
        type: string
        in: header
      - $ref: '#/parameters/teamName'
      - $ref: '#/parameters/reviewId'
      - $ref: '#/parameters/transcriptModerationBody'
      consumes:
      - application/json
      responses:
        '204':
          description: No content.
        default:
          description: Error response.
          schema:
            $ref: '#/definitions/APIError'
      x-ms-examples:
        Transcript moderation result request:
          $ref: ../v1.0/examples/TranscriptModerationResult.JSON
      produces:
      - application/json
      summary: Microsoft Azure Put Contentmoderator Review 0 Teams Teamname Reviews Reviewid Transcriptmoderationresult
  /contentmoderator/review/v1.0/teams/{teamName}/reviews/{reviewId}/transcript:
    put:
      tags:
      - Reviews
      operationId: microsoftAzureReviewsAddvideotranscript
      description: This API adds a transcript file (text version of all the words spoken in a video) to a video review. The file should be in a valid WebVTT format.
      parameters:
      - $ref: '#/parameters/teamName'
      - $ref: '#/parameters/reviewId'
      - name: Content-Type
        description: Content type.
        required: true
        x-ms-client-name: ContentType
        type: string
        in: header
        enum:
        - text/plain
      - $ref: '#/parameters/transcriptFile'
      consumes:
      - text/plain
      responses:
        '204':
          description: No content.
        default:
          description: Error response.
          schema:
            $ref: '#/definitions/APIError'
      x-ms-examples:
        Add transcript request:
          $ref: ../v1.0/examples/AddVideoTranscriptResource.JSON
      produces:
      - application/json
      summary: Microsoft Azure Put Contentmoderator Review 0 Teams Teamname Reviews Reviewid Transcript
definitions:
  JobId:
    properties:
      JobId:
        description: ID of the created job.
        type: string
  APIError:
    type: object
    description: Error information that the API returns.
    properties:
      Error:
        $ref: '#/definitions/Error'
  Frame:
    description: Video frame property details.
    properties:
      Timestamp:
        description: Time stamp of the frame.
        type: string
      FrameImage:
        description: Frame image.
        type: string
      Metadata:
        description: Array of key/value pairs.
        type: array
        items:
          $ref: '#/definitions/KeyValuePair'
      ReviewerResultTags:
        description: Reviewer result tags.
        type: array
        items:
          $ref: '#/definitions/Tag'
  Frames:
    description: Response for a request to get frames.
    properties:
      ReviewId:
        description: ID of the review.
        type: string
      VideoFrames:
        type: array
        items:
          $ref: '#/definitions/Frame'
  Job:
    description: Job object.
    properties:
      Id:
        description: Job ID.
        type: string
      TeamName:
        description: Team name associated with the job.
        type: string
      Status:
        description: Status string.
        type: string
      WorkflowId:
        description: ID of the workflow.
        type: string
      Type:
        description: Type of the content.
        type: string
      CallBackEndpoint:
        description: Callback endpoint.
        type: string
      ReviewId:
        description: Review ID if one is created.
        type: string
      ResultMetaData:
        description: Array of key/value pairs.
        type: array
        items:
          $ref: '#/definitions/KeyValuePair'
      JobExecutionReport:
        description: Array of key/value pair objects in the job execution report.
        type: array
        items:
          $ref: '#/definitions/JobExecutionReportDetails'
  KeyValuePair:
    description: Key/value pair object properties.
    properties:
      Key:
        description: Key parameter.
        type: string
      Value:
        description: Value parameter.
        type: string
  JobExecutionReportDetails:
    description: Values in the job execution report.
    properties:
      Ts:
        description: Time details.
        type: string
      Msg:
        description: Message details.
        type: string
  ReviewList:
    description: List of review IDs.
    type: array
    items:
      type: string
  Error:
    type: object
    description: Error body.
    properties:
      Code:
        type: string
      Message:
        type: string
  Tag:
    description: Tag details.
    properties:
      Key:
        description: Key parameter.
        type: string
      Value:
        description: Value parameter.
        type: string
  Review:
    description: Review object.
    properties:
      ReviewId:
        description: ID of the review.
        type: string
      SubTeam:
        description: Name of the subteam.
        type: string
      Status:
        description: Status string (<Pending, Complete>).
        type: string
      ReviewerResultTags:
        description: Array of key/value pairs with reviewer-set tags.
        type: array
        items:
          $ref: '#/definitions/KeyValuePair'
      CreatedBy:
        description: Reviewer name.
        type: string
      Metadata:
        description: Array of key/value pairs.
        type: array
        items:
          $ref: '#/definitions/KeyValuePair'
      Type:
        description: Type of content.
        type: string
      Content:
        description: Content value.
        type: string
      ContentId:
        description: ID of the content.
        type: string
      CallbackEndpoint:
        description: Callback endpoint.
        type: string
parameters:
  reviewId:
    name: reviewId
    description: ID of the review.
    in: path
    required: true
    type: string
    x-ms-parameter-location: method
  WorkflowName:
    name: WorkflowName
    in: query
    description: Workflow name that you want to invoke.
    required: true
    type: string
    x-ms-parameter-location: method
  ContentId:
    name: ContentId
    in: query
    description: ID or name to identify the submitted content.
    required: true
    type: string
    x-ms-parameter-location: method
  CallBackEndpoint:
    name: CallBackEndpoint
    in: query
    description: Callback endpoint for posting the result of creating a job.
    type: string
    x-ms-parameter-location: method
  ContentType:
    name: ContentType
    in: query
    description: Image, text or video.
    required: true
    type: string
    enum:
    - Image
    - Text
    - Video
    x-ms-parameter-location: method
  subTeam:
    name: subTeam
    description: Subteam that you want to assign the created review to.
    in: query
    required: false
    type: string
    x-ms-parameter-location: method
  teamName:
    name: teamName
    description: Your team name.
    in: path
    required: true
    type: string
    x-ms-parameter-location: method
  transcriptFile:
    name: VTT file
    in: body
    required: true
    schema:
      type: object
      format: file
    description: Transcript file of the video.
    x-ms-parameter-location: method
  transcriptModerationBody:
    name: transcriptModerationBody
    description: Body of the API for adding video transcript moderation results.
    in: body
    required: true
    schema:
      type: array
      description: Schema of the body.
      items:
        required:
        - Timestamp
        - Terms
        type: object
        description: Schema items of the body.
        properties:
          Timestamp:
            description: Time stamp of the image.
            type: string
          Terms:
            description: Metadata details.
            type: array
            items:
              required:
              - Index
              - Term
              type: object
              properties:
                Index:
                  description: Index of the word.
                  type: integer
                Term:
                  description: Detected word.
                  type: string
    x-ms-parameter-location: method
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'