IBM MQ tracing API - PUT a queue

Updates the specified IBM IMS entry queue. If the queue with the specified ID doesn't exist, it creates a new IBM IMS entry queue.

PUT	Managed https://{your-domain}/e/{your-environment-id}/api/config/v1/service/ibmMQTracing/imsEntryQueue/{id} SaaS https://{your-environment-id}.live.dexp.ae/api/config/v1/service/ibmMQTracing/imsEntryQueue/{id}

Authentication

To execute this request, you need the Write configuration permission assigned to your API token. See the Authentication page to learn how to obtain and use it.

Parameters

Parameter	Type	Description	In	Required
id	string	The ID of the IBM IMS entry queue to update. If you set the ID in the body as well, it must match this ID.	path	required
body	IbmMQImsEntryQueue	JSON body of the request, containing updated parameters of the IBM IMS entry queue.	body	optional

Parameter

Type

Description

Required

string

The ID of the IBM IMS entry queue to update.

If you set the ID in the body as well, it must match this ID.

path

required

body

IbmMQImsEntryQueue

JSON body of the request, containing updated parameters of the IBM IMS entry queue.

body

optional

Request parameters JSON model

The IbmMQImsEntryQueue object

Ibm MQ queue which is an entrypoint to IMS.

Element	Type	Description	Required
id	string	The ID of the IMS entry queue.	optional
queueManagerName	string	The name of the queue manager.	required
queueName	string	The name of the queue.	required

This is a model of the request body, showing the possible elements. It has to be adjusted for usage in an actual request. See the Example expandable section for working sample request.

      
  {
  "queueManagerName": "MyQueueManagerName",
  "queueName": "MyQueueName"
}

Response codes

Code	Description
201	Success. The new IBM IMS entry queue has been created. The response body contains the ID and name of the created IBM IMS entry queue.
204	Success. The IBM IMS entry queue has been updated. Response doesn't have a body.
400	Failed. The input is invalid.

Response format

Response parameters JSON model

The EntityShortRepresentation object

The short representation of a DESK entity.

Element	Type	Description
id	string	The ID of the DESK entity.
name	string	The name of the DESK entity.
description	string	A short description of the DESK entity.

{}

Validate payload

We recommend that you validate the payload before submitting it with an actual request. A response code of 204 indicates a valid payload.

POST	Managed https://{your-domain}/e/{your-environment-id}/api/config/v1/service/ibmMQTracing/imsEntryQueue/{id}/validator SaaS https://{your-environment-id}.live.dexp.ae/api/config/v1/service/ibmMQTracing/imsEntryQueue/{id}/validator

Authentication

To execute this request, you need the Write configuration permission assigned to your API token. See the Authentication page to learn how to obtain and use it.

Response codes

Code	Description
204	Validated. The submitted configuration is valid. Response does not have a body.
400	Failed. The input is invalid.