Querying an Endpoint

Function

This API is used to query an endpoint.

Calling Method

For details, see Calling APIs.

URI

GET /v1/serviceconnection/endpoints/{uuid}

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
uuid	Yes	String	Definition: Endpoint UUID. Constraints: N/A Value range: N/A Default value: N/A

Request Parameters

None

Response Parameters

Status code: 200

**Table 2** Response body parameters
Parameter	Type	Description
result	result object	Definition: Returned result. Value range: N/A
status	String	Definition: Returned status. Value range: N/A
error	String	Definition: Returned error information. Value range: N/A

**Table 3** result
Parameter	Type	Description
authorization	authorization object	Definition: Authentication information. Value range: N/A
uuid	String	Definition: Unique ID. Value range: N/A
url	String	Definition: URL for downloading the code repository. Value range: N/A
name	String	Definition: Name. Value range: N/A
project_uuid	String	Definition: Project ID. Value range: N/A
region_name	String	Definition: Region name. Value range: N/A
data	Object	Definition: Data details. Value range: N/A
module_id	String	Definition: Template ID. Value range: N/A
created_by	created_by object	Definition: Creator information. Value range: N/A

**Table 4** authorization
Parameter	Type	Description
parameters	parameters object	Definition: Parameter. Value range: N/A
scheme	String	Definition: Plan. Value range: N/A

**Table 5** parameters
Parameter	Type	Description
username	String	Definition: Username. Value range: N/A
code	String	Definition: Code content. Value range: N/A
state	String	Definition: Status. Value range: N/A
redirectURI	String	Definition: Redirection URI. Value range: N/A
password	String	Definition: Password. Value range: N/A

**Table 6** created_by
Parameter	Type	Description
username	String	Definition: Creator name. Value range: N/A
user_id	String	Definition: Creator ID. Value range: N/A

Status code: 201

Created

Example Requests

None

Example Responses

Status code: 200

{
  "result" : {
    "authorization" : {
      "parameters" : {
        "username" : "user1",
        "code" : null,
        "state" : null,
        "redirectURI" : null,
        "password" : "password"
      },
      "scheme" : "endpoint-auth-scheme-basic"
    },
    "uuid" : "d09e73b6c61e439fbe2ec93e0b29185b",
    "url" : "https://example.com/maven.git",
    "name" : "ddddd",
    "project_uuid" : "93b9fc6ffc6a4edc9ab049c1f0dbec4b",
    "region_name" : "region",
    "data" : { },
    "module_id" : "devcloud2018.codesource-authenticate-generic.oauth02",
    "created_by" : {
      "username" : "user1",
      "user_id" : "05d8ca972f114765a8984795a8aa4d41"
    }
  },
  "status" : "success",
  "error" : null
}