Perforce · Example Payload

Perforce Createreview Example

Perforce Createreview Example is an example object payload from Perforce, with 6 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

operationIdmethodpathsummaryrequestExamplesresponseExamples

Example Payload

Raw ↑ 
{
  "operationId": "createReview",
  "method": "POST",
  "path": "/reviews/",
  "summary": "Perforce Create a Review",
  "requestExamples": [
    {
      "contentType": "application/x-www-form-urlencoded",
      "name": "CreatereviewRequestExample",
      "example": {
        "change": 10,
        "description": "A sample description.",
        "reviewers": [
          "example_value"
        ],
        "requiredReviewers": [
          "example_value"
        ],
        "reviewerGroups": [
          {
            "name": "Example Title",
            "required": true
          }
        ]
      }
    }
  ],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "name": "Createreview200Example",
      "example": {
        "review": {
          "id": "abc123",
          "author": "example_value",
          "changes": [
            10
          ],
          "commits": [
            10
          ],
          "commitStatus": [
            {}
          ],
          "created": 10,
          "deployDetails": [
            {}
          ],
          "deployStatus": "example_value",
          "description": "A sample description.",
          "groups": [
            {}
          ],
          "participants": "example_value",
          "pending": true,
          "projects": "example_value",
          "roles": "example_value",
          "state": "needsReview",
          "stateLabel": "example_value",
          "testDetails": [
            {}
          ],
          "testStatus": "example_value",
          "type": "example_value",
          "updated": 10,
          "updateDate": "2026-01-15T10:30:00Z",
          "versions": [
            {
              "difference": 10,
              "stream": "example_value",
              "change": 10,
              "user": "example_value",
              "time": 10,
              "pending": true,
              "archiveChange": 10
            }
          ]
        }
      }
    }
  ]
}