SEsecurityscorecard
Apps

Update a job

Changed on
put/apps/{appId}/jobs/{jobId}

Request

  • Base URL
    https://api.securityscorecard.io
  • URL
    https://api.securityscorecard.io/apps/{appId}/jobs/{jobId}
  • Auth
    API key in header Authorization

Path parameters

appIdstring uuid required

application id

jobIdstring uuid required

job id

Request body

statusstring required

job status

logstring required

execution info

errorstring required

error info

Response

Update Job status

idstring uuid required

unique identifier for the object

created_bystring required

created by

started_atstring date-time required

created date

completed_atstring date-time required

completed job timestamp

statusstring required

job status

logstring required

execution info

errorstring required

error info

Example response

{
  "started_at": "2020-01-01T00:00:00.000Z",
  "completed_at": "2020-01-01T00:00:00.000Z"
}

Changes

  • b465b4846039Revision changes
    • breaking

      added the pattern ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ to the path request parameter appId

    • breaking

      added the pattern ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ to the path request parameter jobId

    • info

      the request property default value was removed

    • info

      the request property default value was removed

    • info

      media type application/json; charset=utf-8 was changed to application/json for the response status

    • info

      the response's property pattern ^\d{4}-\d{2}-\d{2}[T ]\d{2}:\d{2}:\d{2}\.{0,1}[0-9]*Z$ was added for the status

    • info

      the response's property pattern ^[\da-z-]{16,}$ was added for the status

    • info

      the response's property pattern ^\d{4}-\d{2}-\d{2}[T ]\d{2}:\d{2}:\d{2}\.{0,1}[0-9]*Z$ was added for the status