Perforce · Example Payload

Perforce Getproject Example

Perforce Getproject 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": "getProject",
  "method": "GET",
  "path": "/projects/{id}",
  "summary": "Perforce Get Project Details",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "name": "Getproject200Example",
      "example": {
        "project": {
          "id": "abc123",
          "name": "Example Title",
          "description": "A sample description.",
          "members": [
            "example_value"
          ],
          "owners": [
            "example_value"
          ],
          "subgroups": [
            "example_value"
          ],
          "branches": [
            {
              "id": "abc123",
              "name": "Example Title",
              "paths": {},
              "moderators": {}
            }
          ],
          "deleted": true,
          "deploy": "example_value",
          "emailFlags": "user@example.com",
          "jobview": "example_value",
          "minimumUpVotes": 10,
          "private": true,
          "retainDefaultReviewers": true,
          "tests": "example_value",
          "workflow": "example_value",
          "defaults": "example_value",
          "readme": "example_value"
        }
      }
    }
  ]
}