Update Job Priority Status

Updated 3 weeks ago ​by nussi

Overview

In order to update priority status of a queued job, you can consume the endpoint presented in this article. In order to consume it, you must:

  • Be authenticated user

For information on how you can authenticate, see: Authentication

As soon as you do authentication and receive a valid token, it needs to be passed on the call for receiving a single queued job information.

  • Have valid ID of an existing queued job

Endpoint

Example for such endpoint for TT server is:

https://tt.api.sellercloud.com/rest/api/QueuedJobs/Priority

For your server endpoint will be:

​https://{your_server_id}.api.sellercloud.com/rest/api/QueuedJobs/{id}

Request

  • Method Type: HttpPut
  • Authorization: Use Bearer Token + token received from token authentication
  • Header info: Content-Type: application/json
  • Parameters: ID of the existing queued job

Parameter

Data Type

Description

Is Required

id

integer

ID of existing queued job

Yes

priority

enum

public enum Priority

{

BelowNormal = 0

Normal = 1

High = 2

Critical = 3

}

Yes

Example Request

{
"ID": 101,
"Priority": 2
}

Response

  • If user is authenticated and provides a valid ID of a queued job and priority code, then response will be Status Code 200 => OK
  • If user is not authenticated, then response will be Status Code 401 => Not Valid Token
  • On server response => Status Code 500 => Internal Server Error


How did we do?