[{"label":"Latest (v1)","version":"latest"}]
cloud-partner-navigator

Get Registration

Description

Retrieves information about the current state of a specified Usage Meter agent registration and the associated commit contract in Commerce Portal.

Request

Request

URL

URL


get
https://{api_host}/api/v1/agent-registrations/{agentId}
Copy

Path Parameters

Path Parameters

string
agentId Required

the ID of the Usage Meter agent


Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK

Returns Registration of type application/json

the contract number associated with the agent and the site name if there is any, otherwise the latter is omitted.

{
	"contractNumber": "string",
	"siteName": "string"
}
string
contractNumber Required

the commit contract number as listed in Commerce Portal, against which a Usage Meter agent is registered


string
siteName Optional

the name of the commit contract site as set in Commerce Portal, against which the Usage Meter agent is registered


202 Accepted

the Usage Meter agent registration process is still in progress. An “Agent-Registration-Progress” header provides the current state of the registration.


204 No Content

the Usage Meter agent is not mapped to any contract (demo use case).

No error details were provided in the OpenAPI specification.

Code Samples

Code Samples

cURL Command

curl https://{api_host}/api/v1/agent-registrations/{agentId}


[{"label":"Latest (v1)","version":"latest"}]
cloud-partner-navigator
Feedback

Was this page helpful?