Gets documentation parts.
get/restapis/{restapi_id}/documentation/parts
Path parameters
restapi_idstring required
The string identifier of the associated RestApi.
Query parameters
type'API' | 'AUTHORIZER' | 'MODEL' | 'RESOURCE' | 'METHOD' | 'PATH_PARAMETER' | 'QUERY_PARAMETER' | 'REQUEST_HEADER' | 'REQUEST_BODY' | 'RESPONSE' | 'RESPONSE_HEADER' | 'RESPONSE_BODY'
The type of API entities of the to-be-retrieved documentation parts.
namestring
The name of API entities of the to-be-retrieved documentation parts.
pathstring
The path of API entities of the to-be-retrieved documentation parts.
positionstring
The current pagination position in the paged result set.
limitinteger
The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
locationStatus'DOCUMENTED' | 'UNDOCUMENTED'
The status of the API documentation parts to retrieve. Valid values are <code>DOCUMENTED</code> for retrieving DocumentationPart resources with content and <code>UNDOCUMENTED</code> for DocumentationPart resources without content.
Response
Success