Test Reports

Get all apex test results for a repository

get

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

repositorystringRequired

Repository identifier (org/repo)

limitstringOptional

Maximum number of results

Example: 10

Responses

200

List of test results

No content

403

Forbidden - Requires role: member, owner, application

get

/sfp/api/testreports/apex-tests/results

HTTPcURLJavaScriptPython

GET /sfp/api/testreports/apex-tests/results?repository=text HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Store a new apex test result

post

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

environmentstringRequired

Environment name

repositoryIdentifierstringRequired

Repository identifier (org/repo)

timestampstringRequired

Timestamp in ISO 8601 format

durationnumberRequired

Total duration in seconds

testExecutionTimenumberRequired

Test execution time in seconds

commandTimenumberRequired

Command overhead time in seconds

Responses

201

Test result stored successfully

400

Invalid request body

403

Forbidden - Requires role: owner, application

post

/sfp/api/testreports/apex-tests/results

HTTPcURLJavaScriptPython

POST /sfp/api/testreports/apex-tests/results HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 845

{
  "environment": "text",
  "repositoryIdentifier": "text",
  "timestamp": "text",
  "duration": 1,
  "testExecutionTime": 1,
  "commandTime": 1,
  "summary": {
    "totalTests": 1,
    "passed": 1,
    "failed": 1,
    "skipped": 1,
    "passingRate": 1,
    "outcome": "Passed",
    "overallCoverage": 1,
    "coveredLines": 1,
    "totalLines": 1
  },
  "testCases": [
    {
      "id": "text",
      "name": "text",
      "className": "text",
      "methodName": "text",
      "time": 1,
      "status": "passed",
      "failureMessage": "text",
      "stackTrace": "text"
    }
  ],
  "metadata": {
    "testRunId": "text",
    "username": "text",
    "testLevel": "RunLocalTests",
    "scheduledRun": true,
    "windmillJobId": "text"
  },
  "coverage": {
    "overallCoverage": 1,
    "totalLines": 1,
    "coveredLines": 1,
    "classes": [
      {
        "name": "text",
        "id": "text",
        "coverage": 1,
        "totalLines": 1,
        "coveredLines": 1,
        "status": "pass"
      }
    ],
    "uncoveredClasses": [
      "text"
    ],
    "belowThreshold": [
      {
        "name": "text",
        "id": "text",
        "coverage": 1,
        "totalLines": 1,
        "coveredLines": 1,
        "status": "pass"
      }
    ]
  }
}

No content

Get latest apex test result for an environment

get

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

environmentNamestringRequired

Environment name

Query parameters

repositorystringRequired

Repository identifier (org/repo)

Responses

200

Latest test result for the environment

No content

403

Forbidden - Requires role: member, owner, application

404

No results found for environment

get

/sfp/api/testreports/apex-tests/results/{environmentName}

HTTPcURLJavaScriptPython

GET /sfp/api/testreports/apex-tests/results/{environmentName}?repository=text HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Get apex test result history for an environment

get

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

environmentNamestringRequired

Environment name

Query parameters

repositorystringRequired

Repository identifier (org/repo)

limitstringOptional

Maximum number of results

Example: 10

Responses

200

Test result history for the environment

No content

403

Forbidden - Requires role: member, owner, application

get

/sfp/api/testreports/apex-tests/results/{environmentName}/history

HTTPcURLJavaScriptPython

GET /sfp/api/testreports/apex-tests/results/{environmentName}/history?repository=text HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Get dashboard summary for all environments in a repository

get

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

repositorystringRequired

Repository identifier (org/repo)

Responses

200

Dashboard summary with all environments

No content

403

Forbidden - Requires role: member, owner, application

get

/sfp/api/testreports/apex-tests/dashboard/summary

HTTPcURLJavaScriptPython

GET /sfp/api/testreports/apex-tests/dashboard/summary?repository=text HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Get detailed dashboard for a single environment

get

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

environmentNamestringRequired

Environment name

Query parameters

repositorystringRequired

Repository identifier (org/repo)

Responses

200

Detailed environment dashboard

No content

403

Forbidden - Requires role: member, owner, application

404

No results found for environment

get

/sfp/api/testreports/apex-tests/dashboard/{environmentName}

HTTPcURLJavaScriptPython

GET /sfp/api/testreports/apex-tests/dashboard/{environmentName}?repository=text HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content