Skip to content

ImplementationsApi.md

Latest commit

 

History

History
323 lines (255 loc) · 12.1 KB

ImplementationsApi.md

File metadata and controls

323 lines (255 loc) · 12.1 KB
Raw

ImplementationsApi

All URIs are relative to https://api.rankvectors.com

Method HTTP request Description
getImplementation GET /api/projects/{projectId}/implementations/{implementationId} Get implementation details
implementLinks POST /api/projects/{projectId}/implementations Implement link suggestions
listImplementations GET /api/projects/{projectId}/implementations List implementations
rollbackImplementation POST /api/projects/{projectId}/implementations/{implementationId}/rollback Rollback implementation

getImplementation

GetImplementation200Response getImplementation(projectId, implementationId)

Get implementation details

Get detailed information about a specific implementation

Example

// Import classes:
import com.rankvectors.ApiClient;
import com.rankvectors.ApiException;
import com.rankvectors.Configuration;
import com.rankvectors.auth.*;
import com.rankvectors.models.*;
import com.rankvectors.api.ImplementationsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.rankvectors.com");
    
    // Configure API key authorization: ApiKeyAuth
    ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
    ApiKeyAuth.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //ApiKeyAuth.setApiKeyPrefix("Token");

    ImplementationsApi apiInstance = new ImplementationsApi(defaultClient);
    String projectId = "proj-123"; // String | Unique identifier for the project
    String implementationId = "impl-123"; // String | Unique identifier for the implementation
    try {
      GetImplementation200Response result = apiInstance.getImplementation(projectId, implementationId);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ImplementationsApi#getImplementation");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
projectId String Unique identifier for the project
implementationId String Unique identifier for the implementation

Return type

GetImplementation200Response

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Implementation details -
401 Unauthorized - missing or invalid API key -
403 Forbidden - access denied to resource -
404 Not found - resource doesn't exist -
500 Internal server error -

implementLinks

ImplementationResponse implementLinks(projectId, implementationRequest)

Implement link suggestions

Implement one or more link suggestions

Example

// Import classes:
import com.rankvectors.ApiClient;
import com.rankvectors.ApiException;
import com.rankvectors.Configuration;
import com.rankvectors.auth.*;
import com.rankvectors.models.*;
import com.rankvectors.api.ImplementationsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.rankvectors.com");
    
    // Configure API key authorization: ApiKeyAuth
    ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
    ApiKeyAuth.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //ApiKeyAuth.setApiKeyPrefix("Token");

    ImplementationsApi apiInstance = new ImplementationsApi(defaultClient);
    String projectId = "proj-123"; // String | Unique identifier for the project
    ImplementationRequest implementationRequest = new ImplementationRequest(); // ImplementationRequest | 
    try {
      ImplementationResponse result = apiInstance.implementLinks(projectId, implementationRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ImplementationsApi#implementLinks");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
projectId String Unique identifier for the project
implementationRequest ImplementationRequest

Return type

ImplementationResponse

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Implementation results -
400 Bad request - invalid parameters -
401 Unauthorized - missing or invalid API key -
402 Payment required - insufficient credits -
403 Forbidden - access denied to resource -
404 Not found - resource doesn't exist -
500 Internal server error -

listImplementations

ListImplementations200Response listImplementations(projectId, status, platform, limit, offset)

List implementations

Get implementation history for a project

Example

// Import classes:
import com.rankvectors.ApiClient;
import com.rankvectors.ApiException;
import com.rankvectors.Configuration;
import com.rankvectors.auth.*;
import com.rankvectors.models.*;
import com.rankvectors.api.ImplementationsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.rankvectors.com");
    
    // Configure API key authorization: ApiKeyAuth
    ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
    ApiKeyAuth.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //ApiKeyAuth.setApiKeyPrefix("Token");

    ImplementationsApi apiInstance = new ImplementationsApi(defaultClient);
    String projectId = "proj-123"; // String | Unique identifier for the project
    String status = "pending"; // String | Filter by implementation status
    String platform = "custom"; // String | Filter by platform
    Integer limit = 50; // Integer | Results per page
    Integer offset = 0; // Integer | Pagination offset
    try {
      ListImplementations200Response result = apiInstance.listImplementations(projectId, status, platform, limit, offset);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ImplementationsApi#listImplementations");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
projectId String Unique identifier for the project
status String Filter by implementation status [optional] [enum: pending, in_progress, success, failed, rolled_back]
platform String Filter by platform [optional] [enum: custom]
limit Integer Results per page [optional] [default to 50]
offset Integer Pagination offset [optional] [default to 0]

Return type

ListImplementations200Response

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Implementation history -
401 Unauthorized - missing or invalid API key -
403 Forbidden - access denied to resource -
404 Not found - resource doesn't exist -
500 Internal server error -

rollbackImplementation

RollbackImplementation200Response rollbackImplementation(projectId, implementationId, rollbackImplementationRequest)

Rollback implementation

Undo a link implementation and restore original content

Example

// Import classes:
import com.rankvectors.ApiClient;
import com.rankvectors.ApiException;
import com.rankvectors.Configuration;
import com.rankvectors.auth.*;
import com.rankvectors.models.*;
import com.rankvectors.api.ImplementationsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.rankvectors.com");
    
    // Configure API key authorization: ApiKeyAuth
    ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
    ApiKeyAuth.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //ApiKeyAuth.setApiKeyPrefix("Token");

    ImplementationsApi apiInstance = new ImplementationsApi(defaultClient);
    String projectId = "proj-123"; // String | Unique identifier for the project
    String implementationId = "impl-123"; // String | Unique identifier for the implementation
    RollbackImplementationRequest rollbackImplementationRequest = new RollbackImplementationRequest(); // RollbackImplementationRequest | 
    try {
      RollbackImplementation200Response result = apiInstance.rollbackImplementation(projectId, implementationId, rollbackImplementationRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ImplementationsApi#rollbackImplementation");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
projectId String Unique identifier for the project
implementationId String Unique identifier for the implementation
rollbackImplementationRequest RollbackImplementationRequest

Return type

RollbackImplementation200Response

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Rollback successful -
400 Bad request - invalid parameters -
401 Unauthorized - missing or invalid API key -
403 Forbidden - access denied to resource -
404 Not found - resource doesn't exist -
500 Internal server error -