Skip to content
This repository was archived by the owner on Jan 12, 2021. It is now read-only.

TeamsApi.md

Latest commit

 

History

History
256 lines (177 loc) · 8.62 KB

TeamsApi.md

File metadata and controls

256 lines (177 loc) · 8.62 KB

TeamsApi

All URIs are relative to http://localhost/

Method HTTP request Description
create POST api/v2/teams.json_api Create a(n) Team
delete DELETE api/v2/teams/{id}.json_api Delete a(n) Team
list PUT api/v2/teams.json_api Get a list of Teams
show GET api/v2/teams/{id}.json_api Show a single Team
update PATCH api/v2/teams/{id}.json_api Update a(n) Team

create

Team create(name, subOrganizationId, include, reportInterval)

Create a(n) Team

Example

// Import classes:
//import io.evident.EspSdk.ApiException;
//import io.evident.api.TeamsApi;


TeamsApi apiInstance = new TeamsApi();
String name = "name_example"; // String | Name of the team
Integer subOrganizationId = 56; // Integer | The ID of the sub organization to attach this team to
String include = "include_example"; // String | Related objects that can be included in the response:  custom_signatures, external_accounts, organization, sub_organization See Including Objects for more information.
Integer reportInterval = 56; // Integer | The interval period in hours for Evident.io to run reports
try {
    Team result = apiInstance.create(name, subOrganizationId, include, reportInterval);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TeamsApi#create");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
name String Name of the team
subOrganizationId Integer The ID of the sub organization to attach this team to
include String Related objects that can be included in the response: custom_signatures, external_accounts, organization, sub_organization See Including Objects for more information. [optional]
reportInterval Integer The interval period in hours for Evident.io to run reports [optional]

Return type

Team

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/vnd.api+json
  • Accept: application/vnd.api+json

delete

Meta delete(id)

Delete a(n) Team

Example

// Import classes:
//import io.evident.EspSdk.ApiException;
//import io.evident.api.TeamsApi;


TeamsApi apiInstance = new TeamsApi();
Integer id = 56; // Integer | Team ID
try {
    Meta result = apiInstance.delete(id);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TeamsApi#delete");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
id Integer Team ID

Return type

Meta

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/vnd.api+json
  • Accept: application/vnd.api+json

list

PaginatedCollection list(include, filter, page)

Get a list of Teams

Example

// Import classes:
//import io.evident.EspSdk.ApiException;
//import io.evident.api.TeamsApi;


TeamsApi apiInstance = new TeamsApi();
String include = "include_example"; // String | Related objects that can be included in the response:  custom_signatures, external_accounts, organization, sub_organization See Including Objects for more information.
Map<String, String> filter = new HashMap(); // Map<String, String> | Filter Params for Searching.  Equality Searchable Attributes: [id, name] Matching Searchable Attribute: [name]  Sortable Attributes: [name, updated_at, created_at, id] Searchable Associations: [organization, sub_organization, custom_signatures, integrations] See Searching Lists for more information. See the filter parameter of the association's list action to see what attributes are searchable on each association. See Conditions on Relationships in Searching Lists for more information.
String page = "{:number=>1,+:size=>20}"; // String | Page Number and Page Size.  Number is the page number of the collection to return, size is the number of items to return per page.
try {
    PaginatedCollection result = apiInstance.list(include, filter, page);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TeamsApi#list");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
include String Related objects that can be included in the response: custom_signatures, external_accounts, organization, sub_organization See Including Objects for more information. [optional]
filter Map<String, String> Filter Params for Searching. Equality Searchable Attributes: [id, name] Matching Searchable Attribute: [name] Sortable Attributes: [name, updated_at, created_at, id] Searchable Associations: [organization, sub_organization, custom_signatures, integrations] See Searching Lists for more information. See the filter parameter of the association's list action to see what attributes are searchable on each association. See Conditions on Relationships in Searching Lists for more information. [optional]
page String Page Number and Page Size. Number is the page number of the collection to return, size is the number of items to return per page. [optional] [default to {:number=>1,+:size=>20}]

Return type

PaginatedCollection

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/vnd.api+json
  • Accept: application/vnd.api+json

show

Team show(id, include)

Show a single Team

Example

// Import classes:
//import io.evident.EspSdk.ApiException;
//import io.evident.api.TeamsApi;


TeamsApi apiInstance = new TeamsApi();
Integer id = 56; // Integer | Team ID
String include = "include_example"; // String | Related objects that can be included in the response:  custom_signatures, external_accounts, organization, sub_organization See Including Objects for more information.
try {
    Team result = apiInstance.show(id, include);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TeamsApi#show");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
id Integer Team ID
include String Related objects that can be included in the response: custom_signatures, external_accounts, organization, sub_organization See Including Objects for more information. [optional]

Return type

Team

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/vnd.api+json
  • Accept: application/vnd.api+json

update

Team update(id, include, name, reportInterval)

Update a(n) Team

Example

// Import classes:
//import io.evident.EspSdk.ApiException;
//import io.evident.api.TeamsApi;


TeamsApi apiInstance = new TeamsApi();
Integer id = 56; // Integer | Team ID
String include = "include_example"; // String | Related objects that can be included in the response:  custom_signatures, external_accounts, organization, sub_organization See Including Objects for more information.
String name = "name_example"; // String | Name of the team
Integer reportInterval = 56; // Integer | The interval period in hours for Evident.io to run reports
try {
    Team result = apiInstance.update(id, include, name, reportInterval);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TeamsApi#update");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
id Integer Team ID
include String Related objects that can be included in the response: custom_signatures, external_accounts, organization, sub_organization See Including Objects for more information. [optional]
name String Name of the team [optional]
reportInterval Integer The interval period in hours for Evident.io to run reports [optional]

Return type

Team

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/vnd.api+json
  • Accept: application/vnd.api+json