Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

GetDocumentationParts

Gets documentation parts.

Request Syntax


GET /restapis/restapi_id/documentation/parts?limit=limit&locationStatus=locationStatus&name=nameQuery&path=path&position=position&type=type HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

limit

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

locationStatus

The status of the API documentation parts to retrieve. Valid values are DOCUMENTED for retrieving DocumentationPart resources with content and UNDOCUMENTED for DocumentationPart resources without content.

Valid Values: DOCUMENTED | UNDOCUMENTED

nameQuery

The name of API entities of the to-be-retrieved documentation parts.

path

The path of API entities of the to-be-retrieved documentation parts.

position

The current pagination position in the paged result set.

restapi_id

The string identifier of the associated RestApi.

Required: Yes

type

The type of API entities of the to-be-retrieved documentation parts.

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "item": [ 
      { 
         "id": "string",
         "location": { 
            "method": "string",
            "name": "string",
            "path": "string",
            "statusCode": "string",
            "type": "string"
         },
         "properties": "string"
      }
   ],
   "position": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

item

The current page of elements from this collection.

Type: Array of DocumentationPart objects

position

The current pagination position in the paged result set.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

BadRequestException

The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.

HTTP Status Code: 400

NotFoundException

The requested resource is not found. Make sure that the request URI is correct.

HTTP Status Code: 404

TooManyRequestsException

The request has reached its throttling limit. Retry after the specified time period.

HTTP Status Code: 429

UnauthorizedException

The request is denied because the caller has insufficient permissions.

HTTP Status Code: 401