Text

API

getApi

Top-level resources and operations in this API

Return links to the top-level resources and operations in this API.


/

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///text/"
import { APIApi } from "@apiture/text-client-sdk";

const aPIApi = new APIApi(configuration);

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
aPIApi.setApiKey(apiKey);


var api = new Text.APIApi.getApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
aPIApi.getApi(callback);

Scopes

Parameters

Responses


getApiDoc

Return API definition document

Return the OpenAPI document that describes this API.


/apiDoc

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///text/apiDoc"
import { APIApi } from "@apiture/text-client-sdk";

const aPIApi = new APIApi(configuration);

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
aPIApi.setApiKey(apiKey);


var api = new Text.APIApi.getApiDoc()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
aPIApi.getApiDoc(callback);

Scopes

Parameters

Responses


Text

getResolvedText

Return all text groups and text strings for the specified (or default) language and the specified (or default) client format. The strings are _resolved_ by replacing string references (references have the form `{{key}}`) to other text strings with their corresponding values. This operation is the primary operation that clients use to load the text strings to present to one end user, based on that user's preferred language and their device format.


/resolved

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///text/resolved?format=&languages=&groups=&since=&resolve=&subgroups="
import { TextApi } from "@apiture/text-client-sdk";

const textApi = new TextApi(configuration);

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
textApi.setApiKey(apiKey);


var api = new Text.TextApi.getResolvedText()
var opts = {
  'format': format_example, // {String} Return text strings that match the named or default format (form factor). If no text for the requested format exists for a `textStringId`, the default text for that `textStringId` is returned.
  'languages': , // {array[String]} Return text strings that match the search priority of the given language tag(s). The array is ordered by highest to lowest preference. For example, for `?languages=es-MX,en-GB`, the response will include text strings based on the following search priority: `es-MX` ⇒ `es` ⇒ `en-GB` ⇒ `en` ⇒ `` (_default_) 
Items are [RFC 3066](https://tools.ietf.org/html/rfc3066) language identifiers. If used, `Accept-Language` header is ignored. Language codes are case insensitive. 'acceptLanguage': acceptLanguage_example, // {String} An [HTTP `Accept-Language`](https://tools.ietf.org/html/rfc7231#section-5.3.5) request header which specifies one or more languages with weights. The response will include one string for each combination of group name and string name. This is ignored if `?languages=` query parameter is used. `Accept-Language` is processed in a similar way as the `language` query parameter. 'groups': , // {array[String]} Subset the response to only text in the group or groups named in this parameter. Each item in the comma-separated list is a one-, two-, or three-level group name. Group names are case sensitive. The default is `?groups=common`. Example: `&groups=common,help,features.x,feature.y` 'since': 2013-10-20T19:20:30+01:00, // {Date} Return only text strings whose `updatedAt` time-stamp are newer than the `since` date-time. If omitted, return all text strings The value is an [RFC 3339](https://tools.ietf.org/html/rfc3339) time stamp in `YYYY-MM-DDThh:mm:ss.sssZ` format. 'resolve': true, // {Boolean} If `?resolve=false`, this operation does not resolve embedded `{{key}}` text string references. 'subgroups': true, // {Boolean} If `true`, the response includes all subgroups of each group named in `groups`. This example may return the groups `common` and `common.fi`, `common.print`, and `web.responsive` but not the groups `commonTrust` or `helpless`. 'ifNoneMatch': ifNoneMatch_example // {String} The entity tag that was returned in the `ETag` response. If the resource's current entity tag matches, the `GET` will return 304 (Not Modified) and no response body, else the resource representation will be returned. }; var callback = function(error, data, response) { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }; textApi.getResolvedText(opts, callback);

Scopes

Parameters

Header parameters
Name Description
Accept-Language
String
An [HTTP `Accept-Language`](https://tools.ietf.org/html/rfc7231#section-5.3.5) request header which specifies one or more languages with weights. The response will include one string for each combination of group name and string name. This is ignored if `?languages=` query parameter is used. `Accept-Language` is processed in a similar way as the `language` query parameter.
If-None-Match
String
The entity tag that was returned in the `ETag` response. If the resource's current entity tag matches, the `GET` will return 304 (Not Modified) and no response body, else the resource representation will be returned.
Query parameters
Name Description
format
String
Return text strings that match the named or default format (form factor). If no text for the requested format exists for a `textStringId`, the default text for that `textStringId` is returned.
languages
array[String] (language)
Return text strings that match the search priority of the given language tag(s). The array is ordered by highest to lowest preference. For example, for `?languages=es-MX,en-GB`, the response will include text strings based on the following search priority: `es-MX` &rArr; `es` &rArr; `en-GB` &rArr; `en` &rArr; `` (_default_) <br> Items are [RFC 3066](https://tools.ietf.org/html/rfc3066) language identifiers. If used, `Accept-Language` header is ignored. Language codes are case insensitive.
groups
array[String]
Subset the response to only text in the group or groups named in this parameter. Each item in the comma-separated list is a one-, two-, or three-level group name. Group names are case sensitive. The default is `?groups=common`. Example: `&groups=common,help,features.x,feature.y`
since
Date (date-time)
Return only text strings whose `updatedAt` time-stamp are newer than the `since` date-time. If omitted, return all text strings The value is an [RFC 3339](https://tools.ietf.org/html/rfc3339) time stamp in `YYYY-MM-DDThh:mm:ss.sssZ` format.
resolve
Boolean
If `?resolve=false`, this operation does not resolve embedded `{{key}}` text string references.
subgroups
Boolean
If `true`, the response includes all subgroups of each group named in `groups`. This example may return the groups `common` and `common.fi`, `common.print`, and `web.responsive` but not the groups `commonTrust` or `helpless`.

Responses

Name Type Format Description
ETag String The `ETag` response header specifies an entity tag which may be provided in an `If-Match` request header for *`PUT`* or *`PATCH`* operations which update this text format resource.

Name Type Format Description
RetryMinusAfter String Indicates a suggested delay in seconds after which the client should retry the operation, until the response code is 200. Example: `Retry-After: 10`


TextFormat

getFormat

Fetch a representation of this text format

Return a [HAL](http://developer.apiture.com/docs/concepts/hal) representation of this text format resource.


/formats/{formatId}

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///text/formats/{formatId}"
import { TextFormatApi } from "@apiture/text-client-sdk";

const textFormatApi = new TextFormatApi(configuration);

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
textFormatApi.setApiKey(apiKey);


var api = new Text.TextFormatApi.getFormat()
var formatId = formatId_example; // {String} The unique identifier (`name`) of this text format.
var opts = {
  'ifNoneMatch': ifNoneMatch_example // {String} The entity tag that was returned in the `ETag` response. If the resource's current entity tag matches, the `GET` will return 304 (Not Modified) and no response body, else the resource representation will be returned.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
textFormatApi.getFormat(formatId, opts, callback);

Scopes

Parameters

Path parameters
Name Description
formatId*
String
The unique identifier (`name`) of this text format.
Required
Header parameters
Name Description
If-None-Match
String
The entity tag that was returned in the `ETag` response. If the resource's current entity tag matches, the `GET` will return 304 (Not Modified) and no response body, else the resource representation will be returned.

Responses

Name Type Format Description
ETag String The `ETag` response header specifies an entity tag which may be provided in an `If-Match` request header for *`PUT`* or *`PATCH`* operations which update this text format resource.


getFormats

Return a collection of text formats

Return a collection of text formats. The Text service has default formats named `small` and `large`.


/formats

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///text/formats"
import { TextFormatApi } from "@apiture/text-client-sdk";

const textFormatApi = new TextFormatApi(configuration);

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
textFormatApi.setApiKey(apiKey);


var api = new Text.TextFormatApi.getFormats()
var opts = {
  'ifNoneMatch': ifNoneMatch_example // {String} The entity tag that was returned in the `ETag` response. If the resource's current entity tag matches, the `GET` will return 304 (Not Modified) and no response body, else the resource representation will be returned.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
textFormatApi.getFormats(opts, callback);

Scopes

Parameters

Header parameters
Name Description
If-None-Match
String
The entity tag that was returned in the `ETag` response. If the resource's current entity tag matches, the `GET` will return 304 (Not Modified) and no response body, else the resource representation will be returned.

Responses

Name Type Format Description
ETag String The `ETag` response header specifies an entity tag which may be provided in an `If-Match` request header for *`PUT`* or *`PATCH`* operations which update this text format resource.


setFormat

Update or create a text format

Perform a complete replacement of this text format.


/formats/{formatId}

Usage and SDK Samples

curl -X PUT -H "API-Key: [[apiKey]]" "http:///text/formats/{formatId}"
import { TextFormatApi } from "@apiture/text-client-sdk";

const textFormatApi = new TextFormatApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
textFormatApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
textFormatApi.setApiKey(apiKey);


var api = new Text.TextFormatApi.setFormat()
var formatId = formatId_example; // {String} The unique identifier (`name`) of this text format.
var format = ; // {Format} 
var opts = {
  'ifMatch': ifMatch_example // {String} The entity tag that was returned in the `ETag` response. If passed, this must match the current entity tag of the resource.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
textFormatApi.setFormat(formatId, format, opts, callback);

Scopes

data/read Read access to text
admin/write Write (update) access to text
admin/delete Delete access to text
data/full Full access to text

Parameters

Path parameters
Name Description
formatId*
String
The unique identifier (`name`) of this text format.
Required
Header parameters
Name Description
If-Match
String
The entity tag that was returned in the `ETag` response. If passed, this must match the current entity tag of the resource.
Body parameters
Name Description
format *

Responses

Name Type Format Description
ETag String The `ETag` response header specifies an entity tag which may be provided in an `If-Match` request header for *`PUT`* or *`PATCH`* operations which update this text format resource.

Name Type Format Description
ETag String The `ETag` response header specifies an entity tag which may be provided in an `If-Match` request header for *`PUT`* or *`PATCH`* operations which update this text format resource.
Location String uri The URI of the new string resource. If the URI begins with / it is relative to the API root context. Else, it is a full URI starting with *`scheme`*`://host`


TextGroup

deleteGroup

Delete this text group resource

Delete this text group resource and any resources that are owned by it.


/groups/{groupId}

Usage and SDK Samples

curl -X DELETE -H "API-Key: [[apiKey]]" "http:///text/groups/{groupId}"
import { TextGroupApi } from "@apiture/text-client-sdk";

const textGroupApi = new TextGroupApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
textGroupApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
textGroupApi.setApiKey(apiKey);


var api = new Text.TextGroupApi.deleteGroup()
var groupId = groupId_example; // {String} The unique identifier (`name`) of this text group.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
textGroupApi.deleteGroup(groupId, callback);

Scopes

data/read Read access to text
admin/write Write (update) access to text
admin/delete Delete access to text
data/full Full access to text

Parameters

Path parameters
Name Description
groupId*
String
The unique identifier (`name`) of this text group.
Required

Responses


getGroup

Fetch a representation of this text group

Return a [HAL](http://developer.apiture.com/docs/concepts/hal) representation of this text group resource.


/groups/{groupId}

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///text/groups/{groupId}"
import { TextGroupApi } from "@apiture/text-client-sdk";

const textGroupApi = new TextGroupApi(configuration);

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
textGroupApi.setApiKey(apiKey);


var api = new Text.TextGroupApi.getGroup()
var groupId = groupId_example; // {String} The unique identifier (`name`) of this text group.
var opts = {
  'ifNoneMatch': ifNoneMatch_example // {String} The entity tag that was returned in the `ETag` response. If the resource's current entity tag matches, the `GET` will return 304 (Not Modified) and no response body, else the resource representation will be returned.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
textGroupApi.getGroup(groupId, opts, callback);

Scopes

Parameters

Path parameters
Name Description
groupId*
String
The unique identifier (`name`) of this text group.
Required
Header parameters
Name Description
If-None-Match
String
The entity tag that was returned in the `ETag` response. If the resource's current entity tag matches, the `GET` will return 304 (Not Modified) and no response body, else the resource representation will be returned.

Responses

Name Type Format Description
ETag String The `ETag` response header specifies an entity tag which may be provided in an `If-Match` request header for *`PUT`* or *`PATCH`* operations which update this text group resource.


getGroups

Return a collection of text groups

Return the collection of text groups. Since the number of groups is relatively small, this operation does not implement pagination, sorting, filtering, or searching.


/groups

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///text/groups"
import { TextGroupApi } from "@apiture/text-client-sdk";

const textGroupApi = new TextGroupApi(configuration);

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
textGroupApi.setApiKey(apiKey);


var api = new Text.TextGroupApi.getGroups()
var opts = {
  'ifNoneMatch': ifNoneMatch_example // {String} The entity tag that was returned in the `ETag` response. If the resource's current entity tag matches, the `GET` will return 304 (Not Modified) and no response body, else the resource representation will be returned.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
textGroupApi.getGroups(opts, callback);

Scopes

Parameters

Header parameters
Name Description
If-None-Match
String
The entity tag that was returned in the `ETag` response. If the resource's current entity tag matches, the `GET` will return 304 (Not Modified) and no response body, else the resource representation will be returned.

Responses

Name Type Format Description
ETag String The `ETag` response header specifies an entity tag which may be provided in an `If-Match` request header for *`PUT`* or *`PATCH`* operations which update this text format resource.


setGroup

Create or update a text group

Create a text group, or update an existing text group's properties.


/groups/{groupId}

Usage and SDK Samples

curl -X PUT -H "API-Key: [[apiKey]]" "http:///text/groups/{groupId}"
import { TextGroupApi } from "@apiture/text-client-sdk";

const textGroupApi = new TextGroupApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
textGroupApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
textGroupApi.setApiKey(apiKey);


var api = new Text.TextGroupApi.setGroup()
var groupId = groupId_example; // {String} The unique identifier (`name`) of this text group.
var group = ; // {Group} 
var opts = {
  'ifMatch': ifMatch_example // {String} The entity tag that was returned in the `ETag` response. If passed, this must match the current entity tag of the resource.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
textGroupApi.setGroup(groupId, group, opts, callback);

Scopes

data/read Read access to text
admin/write Write (update) access to text
admin/delete Delete access to text
data/full Full access to text

Parameters

Path parameters
Name Description
groupId*
String
The unique identifier (`name`) of this text group.
Required
Header parameters
Name Description
If-Match
String
The entity tag that was returned in the `ETag` response. If passed, this must match the current entity tag of the resource.
Body parameters
Name Description
group *

Responses

Name Type Format Description
ETag String The `ETag` response header specifies an entity tag which may be provided in an `If-Match` request header for *`PUT`* or *`PATCH`* operations which update this text group resource.

Name Type Format Description
ETag String The `ETag` response header specifies an entity tag which may be provided in an `If-Match` request header for *`PUT`* or *`PATCH`* operations which update this text group resource.
Location String uri The URI of the new string resource. If the URI begins with / it is relative to the API root context. Else, it is a full URI starting with *`scheme`*`://host`


TextString

deleteString

Delete this text string resource

Delete this text string resource and any resources that are owned by it. This operation is limited to administrative use.


/groups/{groupId}/strings/{textStringId}

Usage and SDK Samples

curl -X DELETE -H "API-Key: [[apiKey]]" "http:///text/groups/{groupId}/strings/{textStringId}"
import { TextStringApi } from "@apiture/text-client-sdk";

const textStringApi = new TextStringApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
textStringApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
textStringApi.setApiKey(apiKey);


var api = new Text.TextStringApi.deleteString()
var groupId = groupId_example; // {String} The unique identifier (`name`) of this text group.
var textStringId = textStringId_example; // {String} The unique identifier (`name`) of this text string.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
textStringApi.deleteString(groupId, textStringId, callback);

Scopes

data/read Read access to text
admin/write Write (update) access to text
admin/delete Delete access to text
data/full Full access to text

Parameters

Path parameters
Name Description
groupId*
String
The unique identifier (`name`) of this text group.
Required
textStringId*
String
The unique identifier (`name`) of this text string.
Required

Responses


getString

Fetch a representation of this text string

Return a [HAL](http://developer.apiture.com/docs/concepts/hal) representation of this text string resource.


/groups/{groupId}/strings/{textStringId}

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///text/groups/{groupId}/strings/{textStringId}"
import { TextStringApi } from "@apiture/text-client-sdk";

const textStringApi = new TextStringApi(configuration);

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
textStringApi.setApiKey(apiKey);


var api = new Text.TextStringApi.getString()
var groupId = groupId_example; // {String} The unique identifier (`name`) of this text group.
var textStringId = textStringId_example; // {String} The unique identifier (`name`) of this text string.
var opts = {
  'ifNoneMatch': ifNoneMatch_example // {String} The entity tag that was returned in the `ETag` response. If the resource's current entity tag matches, the `GET` will return 304 (Not Modified) and no response body, else the resource representation will be returned.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
textStringApi.getString(groupId, textStringId, opts, callback);

Scopes

Parameters

Path parameters
Name Description
groupId*
String
The unique identifier (`name`) of this text group.
Required
textStringId*
String
The unique identifier (`name`) of this text string.
Required
Header parameters
Name Description
If-None-Match
String
The entity tag that was returned in the `ETag` response. If the resource's current entity tag matches, the `GET` will return 304 (Not Modified) and no response body, else the resource representation will be returned.

Responses

Name Type Format Description
ETag String The `ETag` response header specifies an entity tag which may be provided in an `If-Match` request header for *`PUT`* or *`PATCH`* operations which update this text string resource.


getStrings

Return a collection of text strings

Return a collection of text strings within the group. Since the number of text strings in a group is relatively small, this operation does not implement pagination, sorting, filtering, or searching.


/groups/{groupId}/strings

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///text/groups/{groupId}/strings"
import { TextStringApi } from "@apiture/text-client-sdk";

const textStringApi = new TextStringApi(configuration);

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
textStringApi.setApiKey(apiKey);


var api = new Text.TextStringApi.getStrings()
var groupId = groupId_example; // {String} The unique identifier (`name`) of this text group.
var opts = {
  'ifNoneMatch': ifNoneMatch_example // {String} The entity tag that was returned in the `ETag` response. If the resource's current entity tag matches, the `GET` will return 304 (Not Modified) and no response body, else the resource representation will be returned.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
textStringApi.getStrings(groupId, opts, callback);

Scopes

Parameters

Path parameters
Name Description
groupId*
String
The unique identifier (`name`) of this text group.
Required
Header parameters
Name Description
If-None-Match
String
The entity tag that was returned in the `ETag` response. If the resource's current entity tag matches, the `GET` will return 304 (Not Modified) and no response body, else the resource representation will be returned.

Responses

Name Type Format Description
ETag String The `ETag` response header specifies an entity tag which may be provided in an `If-Match` request header for *`PUT`* or *`PATCH`* operations which update this text format resource.


setString

Create or update a text string

Create a new text with the `textStringId` name if one did not already exist, or update the properties of an existing text string. This operation is limited to administrative use.


/groups/{groupId}/strings/{textStringId}

Usage and SDK Samples

curl -X PUT -H "API-Key: [[apiKey]]" "http:///text/groups/{groupId}/strings/{textStringId}"
import { TextStringApi } from "@apiture/text-client-sdk";

const textStringApi = new TextStringApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
textStringApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
textStringApi.setApiKey(apiKey);


var api = new Text.TextStringApi.setString()
var groupId = groupId_example; // {String} The unique identifier (`name`) of this text group.
var textStringId = textStringId_example; // {String} The unique identifier (`name`) of this text string.
var textString = ; // {TextString} 
var opts = {
  'ifMatch': ifMatch_example // {String} The entity tag that was returned in the `ETag` response. If passed, this must match the current entity tag of the resource.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
textStringApi.setString(groupId, textStringId, textString, opts, callback);

Scopes

data/read Read access to text
admin/write Write (update) access to text
admin/delete Delete access to text
data/full Full access to text

Parameters

Path parameters
Name Description
groupId*
String
The unique identifier (`name`) of this text group.
Required
textStringId*
String
The unique identifier (`name`) of this text string.
Required
Header parameters
Name Description
If-Match
String
The entity tag that was returned in the `ETag` response. If passed, this must match the current entity tag of the resource.
Body parameters
Name Description
textString *

A text string and variants for different languages and client formats.

Responses

Name Type Format Description
ETag String The `ETag` response header specifies an entity tag which may be provided in an `If-Match` request header for *`PUT`* or *`PATCH`* operations which update this text string resource.

Name Type Format Description
ETag String The `ETag` response header specifies an entity tag which may be provided in an `If-Match` request header for *`PUT`* or *`PATCH`* operations which update this text string resource.
Location String uri The URI of the new string resource. If the URI begins with / it is relative to the API root context. Else, it is a full URI starting with *`scheme`*`://host`