Oracle Commerce Cloud October 2017

getLintStatus

get

/ccadminx/v1/lintStatus/{id}

Get Lint Status. Returns the status of a given lint job from the extension server.

Request

Supported Media Types

application/json

Path Parameters

id: Type: string

Required: true

The id of the job to return the status of. Job Id is the date time the job was created in the format of yyyyMMddHHmm.

Query Parameters

extensionName: Type: string

Required: true

The name of the extension that the lint job was executed against.

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Body

Root Schema : getLintStatus_response

Properties

completed: Type: boolean

Flag indicating whether or not the job has completed or not.
completedPercentage: Type: integer

The progress of the job represented as a percentage.
endTime: Type: string

The time that the job completed.
intervalToPoll: Type: integer

The number of milliseconds to wait before polling the status of the job again.
links: Type: array links

An array of links for all lint jobs.
message: Type: string

Human readable message about the current processing status.
progress: Type: string

The current progress of the job.
requestStatus: Type: integer

The status of the request the requested the job execution.
startTime: Type: string

The time that the job was started.

Nested Schema : links

Type: array

An array of links for all lint jobs.

Items

Type: object items

Nested Schema : items

Type: object

Properties

href: Type: string

Link to the resource.
rel: Type: string

The relationship the link has to the resource.

Example application/json


{
    "completedPercentage":100,
    "intervalToPoll":250,
    "progress":"succeeded",
    "startTime":"2016-12-20T09:25:11.559Z",
    "links":[
        {
            "rel":"self",
            "href":"/ccadminx/custom/v1/lintStatus/201612200925?extensionName=externalShippingCalculator"
        },
        {
            "rel":"related",
            "href":"/ccadminx/custom/v1/lintJobs/201612200925?extensionName=externalShippingCalculator"
        }
    ],
    "completed":true,
    "endTime":"2016-12-20T09:25:11.788Z",
    "message":"Job completed successfully.",
    "requestStatus":202
}

Default Response

The error response

Body

Root Schema : errorModel

Type: object

Properties

devMessage: Type: string

An optional non-localized message containing technical information for developers
errorCode: Type: string

The numerical code identifying the error
errors: Type: array errors

An optional list of errors if multiple errors were encountered
message: Type: string

The localized message describing the error
moreInfo: Type: string

An optional non-localized message with more information
o:errorPath: Type: string

An optional machine readable description of where the error occurred
status: Type: string

The HTTP status code
type: Type: string

The URI to the HTTP state code definition

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Items

Type: object items

Nested Schema : items

Type: object

Properties

devMessage: Type: string

An optional non-localized message containing technical information for developers
errorCode: Type: string

The numerical code identifying the error
message: Type: string

The localized message describing the error
moreInfo: Type: string

An optional non-localized message with more information
o:errorPath: Type: string

An optional machine readable description of where the error occurred
status: Type: string

The HTTP status code

Examples

Sample Response Payload returned by endpoint:

{
  "completedPercentage": 100,
  "intervalToPoll": 250,
  "progress": "succeeded",
  "startTime": "2016-12-20T09:25:11.559Z",
  "links": [
    {
      "rel": "self",
      "href": "/ccadminx/custom/v1/lintStatus/201612200925?extensionName=externalShippingCalculator"
    },
    {
      "rel": "related",
      "href": "/ccadminx/custom/v1/lintJobs/201612200925?extensionName=externalShippingCalculator"
    }
  ],
  "completed": true,
  "endTime": "2016-12-20T09:25:11.788Z",
  "message": "Job completed successfully.",
  "requestStatus": 202
}