Skip to content

Latest commit

 

History

History
165 lines (122 loc) · 6.3 KB

EntryApi.md

File metadata and controls

165 lines (122 loc) · 6.3 KB
Raw

EntryApi

All URIs are relative to http://localhost

Method HTTP request Description
apiEntriesGet GET /api/entries
apiEntriesNamesGet GET /api/entries/names

apiEntriesGet

EntryForApiContractPartialFindResult apiEntriesGet(query, tagName, tagId, childTags, entryTypes, status, start, maxResults, getTotalCount, sort, nameMatchMode, fields, lang)

Example

// Import classes:
import mikufan.cx.vocadbapiclient.client.ApiClient;
import mikufan.cx.vocadbapiclient.client.ApiException;
import mikufan.cx.vocadbapiclient.client.Configuration;
import mikufan.cx.vocadbapiclient.client.models.*;
import mikufan.cx.vocadbapiclient.api.EntryApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("http://localhost");

        EntryApi apiInstance = new EntryApi(defaultClient);
        String query = ""; // String | 
        List<String> tagName = Arrays.asList(); // List<String> | 
        List<Integer> tagId = Arrays.asList(); // List<Integer> | 
        Boolean childTags = false; // Boolean | 
        EntryTypes entryTypes = EntryTypes.fromValue("Nothing"); // EntryTypes | 
        EntryStatus status = EntryStatus.fromValue("Draft"); // EntryStatus | 
        Integer start = 0; // Integer | 
        Integer maxResults = 10; // Integer | 
        Boolean getTotalCount = false; // Boolean | 
        EntrySortRule sort = EntrySortRule.fromValue("None"); // EntrySortRule | 
        NameMatchMode nameMatchMode = NameMatchMode.fromValue("Auto"); // NameMatchMode | 
        EntryOptionalFields fields = EntryOptionalFields.fromValue("None"); // EntryOptionalFields | 
        ContentLanguagePreference lang = ContentLanguagePreference.fromValue("Default"); // ContentLanguagePreference | 
        try {
            EntryForApiContractPartialFindResult result = apiInstance.apiEntriesGet(query, tagName, tagId, childTags, entryTypes, status, start, maxResults, getTotalCount, sort, nameMatchMode, fields, lang);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntryApi#apiEntriesGet");
            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
query String [optional] [default to ]
tagName List<String> [optional]
tagId List<Integer> [optional]
childTags Boolean [optional] [default to false]
entryTypes EntryTypes [optional] [enum: Nothing, Album, Artist, DiscussionTopic, PV, ReleaseEvent, ReleaseEventSeries, Song, SongList, Tag, User, Venue]
status EntryStatus [optional] [enum: Draft, Finished, Approved, Locked]
start Integer [optional] [default to 0]
maxResults Integer [optional] [default to 10]
getTotalCount Boolean [optional] [default to false]
sort EntrySortRule [optional] [enum: None, Name, AdditionDate, ActivityDate]
nameMatchMode NameMatchMode [optional] [enum: Auto, Partial, StartsWith, Exact, Words]
fields EntryOptionalFields [optional] [enum: None, AdditionalNames, Description, MainPicture, Names, PVs, Tags, WebLinks]
lang ContentLanguagePreference [optional] [enum: Default, Japanese, Romaji, English]

Return type

EntryForApiContractPartialFindResult

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: text/plain, application/json, text/json

HTTP response details

Status code Description Response headers
200 Success -

apiEntriesNamesGet

List<String> apiEntriesNamesGet(query, nameMatchMode, maxResults)

Example

// Import classes:
import mikufan.cx.vocadbapiclient.client.ApiClient;
import mikufan.cx.vocadbapiclient.client.ApiException;
import mikufan.cx.vocadbapiclient.client.Configuration;
import mikufan.cx.vocadbapiclient.client.models.*;
import mikufan.cx.vocadbapiclient.api.EntryApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("http://localhost");

        EntryApi apiInstance = new EntryApi(defaultClient);
        String query = ""; // String | 
        NameMatchMode nameMatchMode = NameMatchMode.fromValue("Auto"); // NameMatchMode | 
        Integer maxResults = 10; // Integer | 
        try {
            List<String> result = apiInstance.apiEntriesNamesGet(query, nameMatchMode, maxResults);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntryApi#apiEntriesNamesGet");
            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
query String [optional] [default to ]
nameMatchMode NameMatchMode [optional] [enum: Auto, Partial, StartsWith, Exact, Words]
maxResults Integer [optional] [default to 10]

Return type

List<String>

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: text/plain, application/json, text/json

HTTP response details

Status code Description Response headers
200 Success -