public class DocumentIndividualApi extends Object
| Constructor and Description |
|---|
DocumentIndividualApi() |
DocumentIndividualApi(ApiClient apiClient) |
| Modifier and Type | Method and Description |
|---|---|
void |
apisApiIdDocumentsDocumentIdContentGet(String apiId,
String documentId,
String xWSO2Tenant,
String accept,
String ifNoneMatch,
String ifModifiedSince)
Get the content of an API document
This operation can be used to retrive the content of an API's document.
|
com.squareup.okhttp.Call |
apisApiIdDocumentsDocumentIdContentGetAsync(String apiId,
String documentId,
String xWSO2Tenant,
String accept,
String ifNoneMatch,
String ifModifiedSince,
ApiCallback<Void> callback)
Get the content of an API document (asynchronously)
This operation can be used to retrive the content of an API's document.
|
ApiResponse<Void> |
apisApiIdDocumentsDocumentIdContentGetWithHttpInfo(String apiId,
String documentId,
String xWSO2Tenant,
String accept,
String ifNoneMatch,
String ifModifiedSince)
Get the content of an API document
This operation can be used to retrive the content of an API's document.
|
Document |
apisApiIdDocumentsDocumentIdGet(String apiId,
String documentId,
String xWSO2Tenant,
String accept,
String ifNoneMatch,
String ifModifiedSince)
Get a document of an API
This operation can be used to retrieve a particular document's metadata associated with an API.
|
com.squareup.okhttp.Call |
apisApiIdDocumentsDocumentIdGetAsync(String apiId,
String documentId,
String xWSO2Tenant,
String accept,
String ifNoneMatch,
String ifModifiedSince,
ApiCallback<Document> callback)
Get a document of an API (asynchronously)
This operation can be used to retrieve a particular document's metadata associated with an API.
|
ApiResponse<Document> |
apisApiIdDocumentsDocumentIdGetWithHttpInfo(String apiId,
String documentId,
String xWSO2Tenant,
String accept,
String ifNoneMatch,
String ifModifiedSince)
Get a document of an API
This operation can be used to retrieve a particular document's metadata associated with an API.
|
ApiClient |
getApiClient() |
void |
setApiClient(ApiClient apiClient) |
public DocumentIndividualApi()
public DocumentIndividualApi(ApiClient apiClient)
public ApiClient getApiClient()
public void setApiClient(ApiClient apiClient)
public void apisApiIdDocumentsDocumentIdContentGet(String apiId, String documentId, String xWSO2Tenant, String accept, String ifNoneMatch, String ifModifiedSince) throws ApiException
apiId - **API ID** consisting of the **UUID** of the API. Using the **UUID** in the API call is recommended. The combination of the provider of the API, name of the API and the version is also accepted as a valid API ID. Should be formatted as **provider-name-version**. (required)documentId - Document Identifier (required)xWSO2Tenant - For cross-tenant invocations, this is used to specify the tenant domain, where the resource need to be retirieved from. (optional)accept - Media types acceptable for the response. Default is application/json. (optional, default to application/json)ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resource. (optional)ifModifiedSince - Validator for conditional requests; based on Last Modified header of the formerly retrieved variant of the resource (Will be supported in future). (optional)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response bodypublic ApiResponse<Void> apisApiIdDocumentsDocumentIdContentGetWithHttpInfo(String apiId, String documentId, String xWSO2Tenant, String accept, String ifNoneMatch, String ifModifiedSince) throws ApiException
apiId - **API ID** consisting of the **UUID** of the API. Using the **UUID** in the API call is recommended. The combination of the provider of the API, name of the API and the version is also accepted as a valid API ID. Should be formatted as **provider-name-version**. (required)documentId - Document Identifier (required)xWSO2Tenant - For cross-tenant invocations, this is used to specify the tenant domain, where the resource need to be retirieved from. (optional)accept - Media types acceptable for the response. Default is application/json. (optional, default to application/json)ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resource. (optional)ifModifiedSince - Validator for conditional requests; based on Last Modified header of the formerly retrieved variant of the resource (Will be supported in future). (optional)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response bodypublic com.squareup.okhttp.Call apisApiIdDocumentsDocumentIdContentGetAsync(String apiId, String documentId, String xWSO2Tenant, String accept, String ifNoneMatch, String ifModifiedSince, ApiCallback<Void> callback) throws ApiException
apiId - **API ID** consisting of the **UUID** of the API. Using the **UUID** in the API call is recommended. The combination of the provider of the API, name of the API and the version is also accepted as a valid API ID. Should be formatted as **provider-name-version**. (required)documentId - Document Identifier (required)xWSO2Tenant - For cross-tenant invocations, this is used to specify the tenant domain, where the resource need to be retirieved from. (optional)accept - Media types acceptable for the response. Default is application/json. (optional, default to application/json)ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resource. (optional)ifModifiedSince - Validator for conditional requests; based on Last Modified header of the formerly retrieved variant of the resource (Will be supported in future). (optional)callback - The callback to be executed when the API call finishesApiException - If fail to process the API call, e.g. serializing the request body objectpublic Document apisApiIdDocumentsDocumentIdGet(String apiId, String documentId, String xWSO2Tenant, String accept, String ifNoneMatch, String ifModifiedSince) throws ApiException
apiId - **API ID** consisting of the **UUID** of the API. Using the **UUID** in the API call is recommended. The combination of the provider of the API, name of the API and the version is also accepted as a valid API ID. Should be formatted as **provider-name-version**. (required)documentId - Document Identifier (required)xWSO2Tenant - For cross-tenant invocations, this is used to specify the tenant domain, where the resource need to be retirieved from. (optional)accept - Media types acceptable for the response. Default is application/json. (optional, default to application/json)ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resource. (optional)ifModifiedSince - Validator for conditional requests; based on Last Modified header of the formerly retrieved variant of the resource (Will be supported in future). (optional)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response bodypublic ApiResponse<Document> apisApiIdDocumentsDocumentIdGetWithHttpInfo(String apiId, String documentId, String xWSO2Tenant, String accept, String ifNoneMatch, String ifModifiedSince) throws ApiException
apiId - **API ID** consisting of the **UUID** of the API. Using the **UUID** in the API call is recommended. The combination of the provider of the API, name of the API and the version is also accepted as a valid API ID. Should be formatted as **provider-name-version**. (required)documentId - Document Identifier (required)xWSO2Tenant - For cross-tenant invocations, this is used to specify the tenant domain, where the resource need to be retirieved from. (optional)accept - Media types acceptable for the response. Default is application/json. (optional, default to application/json)ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resource. (optional)ifModifiedSince - Validator for conditional requests; based on Last Modified header of the formerly retrieved variant of the resource (Will be supported in future). (optional)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response bodypublic com.squareup.okhttp.Call apisApiIdDocumentsDocumentIdGetAsync(String apiId, String documentId, String xWSO2Tenant, String accept, String ifNoneMatch, String ifModifiedSince, ApiCallback<Document> callback) throws ApiException
apiId - **API ID** consisting of the **UUID** of the API. Using the **UUID** in the API call is recommended. The combination of the provider of the API, name of the API and the version is also accepted as a valid API ID. Should be formatted as **provider-name-version**. (required)documentId - Document Identifier (required)xWSO2Tenant - For cross-tenant invocations, this is used to specify the tenant domain, where the resource need to be retirieved from. (optional)accept - Media types acceptable for the response. Default is application/json. (optional, default to application/json)ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resource. (optional)ifModifiedSince - Validator for conditional requests; based on Last Modified header of the formerly retrieved variant of the resource (Will be supported in future). (optional)callback - The callback to be executed when the API call finishesApiException - If fail to process the API call, e.g. serializing the request body objectCopyright © 2018 WSO2 Inc. All rights reserved.