Excerpt

hidden	false

Request the status of an instrument that was submitted for creation.

Style
.wiki-content .columnLayout .cell.aside {width:500px;}

Panel

borderColor	lightgray

URL	`/instruments/request-status/{id}`
HTTP Method	`GET`
Version	1.1.11

Panel

borderColor	lightgray
title	Content

Table of Contents

maxLevel	2

Request

Parameters

Parameter Name Location Type Multi-ple Values Usage Description

CME-Application-Name

Application Name

Header

String

No

Status

subtle	true
colour	Green
title	REQUIRED

CME-Application-Vendor

Application Vendor

Header

String

No

Status

subtle	true
colour	Green
title	REQUIRED

CME-Application-Version

Application Version

Header

String

No

Status

subtle	true
colour	Green
title	REQUIRED

CME-Request-ID

Request ID

Header

String

No

Status

subtle	true
colour	Green
title	REQUIRED

CME-Transact-Time

Transaction Time

Header

DateTime

No

Format: yyyy-mm-ddThh:mm:ss.dZ

Status

subtle	true
colour	Green
title	REQUIRED

id

ID

Path

String

No

Status

subtle	true
colour	Green
title	REQUIRED

Response - 303

Headers

Parameter Name Type Values Usage Description

Location

Location

URI

Status

subtle	true
colour	Green
title	ALWAYS

Standard HTTP Header field for sending a URL

Response - 204

Response - 400

Body

Anchor
Response400ErrorResponseMessage
Response400ErrorResponseMessage
Error Response Message - `ErrorResponseMessage`

Field	Name	Type	Values	Usage	Description
`errors[]`	Errors

Anchor
Response400ErrorResponseMessage.errors[]
Response400ErrorResponseMessage.errors[]
Error - `ErrorResponseMessage.errors[]`

Field Name Type Values Usage Description

code

Error Code

String

1
100
101
102
103
1003
2048
2051
7024
7027
7029

Status

subtle	true
colour	Green
title	ALWAYS

instance

Error Instance

String

Status

subtle	true
colour	Grey
title	OPTIONAL

message

Error Message

String

Status

subtle	true
colour	Green
title	ALWAYS

referenceIndex

Error Reference Index

Integer

Status

subtle	true
colour	Green
title	ALWAYS

Response - 401

Response - 404

Response - 500

Body

Anchor
Response500ErrorResponseMessage
Response500ErrorResponseMessage
Error Response Message - `ErrorResponseMessage`

Field	Name	Type	Values	Usage	Description
`errors[]`	Errors

Anchor
Response500ErrorResponseMessage.errors[]
Response500ErrorResponseMessage.errors[]
Error - `ErrorResponseMessage.errors[]`

Field Name Type Values Usage Description

code

Error Code

String

1
100
101
102
103
1003
2048
2051
7024
7027
7029

Status

subtle	true
colour	Green
title	ALWAYS

instance

Error Instance

String

Status

subtle	true
colour	Grey
title	OPTIONAL

message

Error Message

String

Status

subtle	true
colour	Green
title	ALWAYS

referenceIndex

Error Reference Index

Integer

Status

subtle	true
colour	Green
title	ALWAYS

Versions Compared

Old Version 1

New Version Current

Key

Request

Parameters

Response - 303

Headers

Response - 204

Response - 400

Body

Anchor
Response400ErrorResponseMessage
Response400ErrorResponseMessage
Error Response Message - `ErrorResponseMessage`

Anchor
Response400ErrorResponseMessage.errors[]
Response400ErrorResponseMessage.errors[]
Error - `ErrorResponseMessage.errors[]`

Response - 401

Response - 404

Response - 500

Body

Anchor
Response500ErrorResponseMessage
Response500ErrorResponseMessage
Error Response Message - `ErrorResponseMessage`

Anchor
Response500ErrorResponseMessage.errors[]
Response500ErrorResponseMessage.errors[]
Error - `ErrorResponseMessage.errors[]`

Page Comparison

Versions Compared

Old Version 1

New Version Current

Key

Request

Parameters

Response - 303

Headers

Response - 204

Response - 400

Body

AnchorResponse400ErrorResponseMessageResponse400ErrorResponseMessageError Response Message - ErrorResponseMessage

AnchorResponse400ErrorResponseMessage.errors[]Response400ErrorResponseMessage.errors[]Error - ErrorResponseMessage.errors[]

Response - 401

Response - 404

Response - 500

Body

AnchorResponse500ErrorResponseMessageResponse500ErrorResponseMessageError Response Message - ErrorResponseMessage

AnchorResponse500ErrorResponseMessage.errors[]Response500ErrorResponseMessage.errors[]Error - ErrorResponseMessage.errors[]

Anchor
Response400ErrorResponseMessage
Response400ErrorResponseMessage
Error Response Message - `ErrorResponseMessage`

Anchor
Response400ErrorResponseMessage.errors[]
Response400ErrorResponseMessage.errors[]
Error - `ErrorResponseMessage.errors[]`

Anchor
Response500ErrorResponseMessage
Response500ErrorResponseMessage
Error Response Message - `ErrorResponseMessage`

Anchor
Response500ErrorResponseMessage.errors[]
Response500ErrorResponseMessage.errors[]
Error - `ErrorResponseMessage.errors[]`