Job Router Operations - Get In Queue Position

  • Riferimento
Servizio:
Communication
Versione API:
2023-11-01

Ottiene i dettagli della posizione di un processo.

GET {endpoint}/routing/jobs/{jobId}/position?api-version=2023-11-01

Parametri dell'URI

Nome In Necessario Tipo Descrizione
endpoint
 path True

string

URI della risorsa di comunicazione
jobId
 path True

string

ID del processo.
api-version
 query True

string

Versione dell'API da usare per questa operazione.

Risposte

Nome Tipo Descrizione
200 OK

RouterJobPositionDetails

La richiesta ha avuto esito positivo.
Other Status Codes

Azure.Core.Foundations.ErrorResponse

Risposta di errore imprevista.

Intestazioni

x-ms-error-code: string

Esempio

Gets a job's position details

Esempio di richiesta

GET https://contoso.westus.communications.azure.com/routing/jobs/8780b28c-7079-4de1-9143-4d369289e958/position?api-version=2023-11-01

Risposta di esempio

Codice di stato:
200 
{
  "jobId": "383541b3-5637-4af6-8aac-3391da8a578a",
  "position": 1,
  "queueId": "MainQueue",
  "queueLength": 3,
  "estimatedWaitTimeMinutes": 4
}

Definizioni

Nome Descrizione
Azure.Core.Foundations.Error

Oggetto error.
Azure.Core.Foundations.ErrorResponse

Risposta contenente i dettagli dell'errore.
Azure.Core.Foundations.InnerError

Oggetto contenente informazioni più specifiche sull'errore. In base alle linee guida dell'API Microsoft One - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
RouterJobPositionDetails

Posizione e tempo di attesa stimato per un processo.

Azure.Core.Foundations.Error

Oggetto error.

Nome Tipo Descrizione
code

string

Uno dei set definiti dal server di codici di errore.
details

Azure.Core.Foundations.Error[]

Matrice di dettagli sugli errori specifici che hanno causato questo errore segnalato.
innererror

Azure.Core.Foundations.InnerError

Oggetto contenente informazioni più specifiche dell'oggetto corrente sull'errore.
message

string

Rappresentazione leggibile dell'errore.
target

string

Destinazione dell'errore.

Azure.Core.Foundations.ErrorResponse

Risposta contenente i dettagli dell'errore.

Nome Tipo Descrizione
error

Azure.Core.Foundations.Error

Oggetto error.

Azure.Core.Foundations.InnerError

Oggetto contenente informazioni più specifiche sull'errore. In base alle linee guida dell'API Microsoft One - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Nome Tipo Descrizione
code

string

Uno dei set definiti dal server di codici di errore.
innererror

Azure.Core.Foundations.InnerError

Errore interno.

RouterJobPositionDetails

Posizione e tempo di attesa stimato per un processo.

Nome Tipo Descrizione
estimatedWaitTimeMinutes

number

Tempo di attesa stimato del processo arrotondato al minuto più vicino.
jobId

string

ID del processo di cui si tratta.
position

integer

Posizione del processo in questione all'interno di tale coda.
queueId

string

ID della coda in cui viene accodato il processo.
queueLength

integer

Lunghezza della coda: numero totale di processi accodati.