Get connector methods

To call a Connector Method directly, you need to obtain either the Method’s MethodUniqueIdentifier or the Method's numeric Id.

You can use one of the GET /v1.0/connectors/{...}/methods Cyclr API endpoints to retrieve a list of Methods and their identifiers for a particular Connector or Connector Release.

Cyclr API Endpoints

There are 3 endpoints you can use to retrieve a list of Methods for a Connector:

GET /v1.0/connectors/{name}/methods
Retrieves Methods for the latest Release of a Connector by looking it up by Name.
GET /v1.0/connectors/{name}/{version}/methods
Retrieves Methods for the latest Release of a Connector by looking it up by Name and Version.
GET /v1.0/connectors/{id}/methods
Retrieves Methods for a specific Release of a Connector.

For more information about these endpoints, see the Interactive API reference page.

All 3 endpoints return the same Response structure.

Example Response

JSON

[
	{
		"Id": 116,
		"Name": "Update Ticket",
		"Description": "Updates a ticket.",
		"EndPoint": "https://api.example/updateTicket",
		"MethodUniqueIdentifier": "8f8df8ef-3007-11e7-a033-06abe76375dd",
		"Parameters": [...],
		"RequestFields": [...],
		"ResponseFields": [...]
	},
	{
		"Id": 117,
		"Name": "Delete Ticket",
		"Description": "Deletes a ticket.",
		"EndPoint": "https://api.example/deleteTicket",
		"MethodUniqueIdentifier": "56d8a7ef-3457-af37-a3fd-0645386a75bd",
		"Parameters": [...],
		"RequestFields": [...],
		"ResponseFields": [...]
	}
]

Response Explanation

Parameter	Description
`Id`	The numeric Id of each Method. Points to the Method at a specific Release of the Connector.
`Name`	The Names of each Method.
`Description`	The text Description of each Method.
`EndPoint`	The endpoint each Method uses in the third-party’s API.
`MethodUniqueIdentifier`	Each Method’s Unique Identifier. Always points to the Method at whatever is the latest Release of the Connector.
`Parameters`	An array of Parameters each Method uses, such as QueryString name/value pairs as well as Cyclr Merge Fields.
`RequestFields`	An array of Request Fields each Method uses when building the Request Body to use in a call.
`ResponseFields`	An array of Response Fields each Method uses when exposing data in the Response.