Skip to main content

Get details of an ORT run of a repository

GET 
http://localhost:8080/api/v1/repositories/:repositoryId/runs/:ortRunIndex

Get details of an ORT run of a repository

Request​

Path Parameters

    repositoryId int64required

    The repository's ID.

    ortRunIndex int64required

    The index of an ORT run.

Responses​

Success

Response Headers
    Schema
      createdAtString (string)required
      environmentConfigPathString (null,string)nullable
      finishedAtString (null,string)nullable
      idint64required
      indexint64required
      issues object[]required
    • Array [
      • affectedPathString (null,string)nullable
      identifier object
      oneOf
      messageString (string)required
      severitySeverity (string)required

      Possible values: [HINT, WARNING, ERROR]

      sourceString (string)required
      timestampString (string)required
      workerString (null,string)nullable
    • ]
      • jobConfigContextString (null,string)nullable
      jobConfigs objectrequired
      advisor object
      oneOf
      analyzer object
      allowDynamicVersionsBoolean (boolean)
      disabledPackageManagersString (string)[]nullable
      enabledPackageManagersString (string)[]nullable
      environmentConfig object
      oneOf
      keepAliveWorkerBoolean (boolean)
      packageCurationProviders object[]
    • Array [
      • enabledBoolean (boolean)
      idString (string)
      options object
      property name*String (string)
      secrets object
      property name*String (string)
      typeString (string)required
    • ]
      • packageManagerOptions Map_String-PackageManagerConfiguration (null,object)
      property name* PackageManagerConfiguration
      mustRunAfterString (string)[]nullable
      options Map_String-String (null,object)
      property name*String (string)
      repositoryConfigPathString (null,string)nullable
      skipExcludedBoolean (null,boolean)nullable
      submoduleFetchStrategy object
      oneOf
      evaluator object
      oneOf
      notifier object
      oneOf
      parameters Map_String-String (null,object)
      property name*String (string)
      reporter object
      oneOf
      scanner object
      oneOf
      jobs objectrequired
      advisor object
      oneOf
      analyzer object
      oneOf
      evaluator object
      oneOf
      notifier object
      oneOf
      reporter object
      oneOf
      scanner object
      oneOf
      labels objectrequired
      property name*String (string)
      organizationIdint64required
      pathString (null,string)nullable
      productIdint64required
      repositoryIdint64required
      resolvedJobConfigContextString (null,string)nullable
      resolvedJobConfigs object
      oneOf
      resolvedRevisionString (null,string)nullable
      revisionString (string)required
      statusOrtRunStatus (string)required

      Possible values: [CREATED, ACTIVE, FINISHED, FAILED, FINISHED_WITH_ISSUES]

      traceIdString (null,string)nullable
      userDisplayName object
      oneOf

    Authorization: oauth2

    name: tokentype: oauth2flows: {
  "authorizationCode": {
    "authorizationUrl": "http://localhost:8081/realms/master/protocol/openid-connect/auth",
    "tokenUrl": "http://localhost:8081/realms/master/protocol/openid-connect/token",
    "scopes": {}
  }
}
    var client = new HttpClient();
    var request = new HttpRequestMessage(HttpMethod.Get, "http://localhost:8080/api/v1/repositories/:repositoryId/runs/:ortRunIndex");
    request.Headers.Add("Accept", "application/json");
    request.Headers.Add("Authorization", "Bearer <token>");
    var response = await client.SendAsync(request);
    response.EnsureSuccessStatusCode();
    Console.WriteLine(await response.Content.ReadAsStringAsync());
    Request Collapse all
    Base URL
    http://localhost:8080
    Auth
    Parameters
    — pathrequired
    — pathrequired
    ResponseClear

    Click the Send API Request button above and see the response here!