All URIs are relative to https://api.phrase.com/v2
| Method | HTTP request | Description |
|---|---|---|
| GlossariesList | Get /accounts/{account_id}/glossaries | List term bases |
| GlossaryCreate | Post /accounts/{account_id}/glossaries | Create a term base |
| GlossaryDelete | Delete /accounts/{account_id}/glossaries/{id} | Delete a term base |
| GlossaryShow | Get /accounts/{account_id}/glossaries/{id} | Get a single term base |
| GlossaryUpdate | Patch /accounts/{account_id}/glossaries/{id} | Update a term base |
[]Glossary GlossariesList(ctx, accountId, optional)
List term bases
List all term bases (previously: glossaries) the current user has access to.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| accountId | string | Account ID | |
| optional | *GlossariesListOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a GlossariesListOpts struct
| Name | Type | Description | Notes |
|---|
xPhraseAppOTP | optional.String| Two-Factor-Authentication token (optional) | page | optional.Int32| Page number | perPage | optional.Int32| Limit on the number of objects to be returned, between 1 and 100. 25 by default |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Glossary GlossaryCreate(ctx, accountId, glossaryCreateParameters, optional)
Create a term base
Create a new term base (previously: glossary).
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| accountId | string | Account ID | |
| glossaryCreateParameters | GlossaryCreateParameters | ||
| optional | *GlossaryCreateOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a GlossaryCreateOpts struct
| Name | Type | Description | Notes |
|---|
xPhraseAppOTP | optional.String| Two-Factor-Authentication token (optional) |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GlossaryDelete(ctx, accountId, id, optional)
Delete a term base
Delete an existing term base (previously: glossary).
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| accountId | string | Account ID | |
| id | string | ID | |
| optional | *GlossaryDeleteOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a GlossaryDeleteOpts struct
| Name | Type | Description | Notes |
|---|
xPhraseAppOTP | optional.String| Two-Factor-Authentication token (optional) |
(empty response body)
- Content-Type: Not defined
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Glossary GlossaryShow(ctx, accountId, id, optional)
Get a single term base
Get details on a single term base (previously: glossary).
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| accountId | string | Account ID | |
| id | string | ID | |
| optional | *GlossaryShowOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a GlossaryShowOpts struct
| Name | Type | Description | Notes |
|---|
xPhraseAppOTP | optional.String| Two-Factor-Authentication token (optional) |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Glossary GlossaryUpdate(ctx, accountId, id, glossaryUpdateParameters, optional)
Update a term base
Update an existing term base (previously: glossary).
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| accountId | string | Account ID | |
| id | string | ID | |
| glossaryUpdateParameters | GlossaryUpdateParameters | ||
| optional | *GlossaryUpdateOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a GlossaryUpdateOpts struct
| Name | Type | Description | Notes |
|---|
xPhraseAppOTP | optional.String| Two-Factor-Authentication token (optional) |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]