Approvals

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:///approvals/"
import { APIApi } from "@apiture/approvals-client-sdk";

const aPIApi = new APIApi(configuration);

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


var api = new Approvals.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:///approvals/apiDoc"
import { APIApi } from "@apiture/approvals-client-sdk";

const aPIApi = new APIApi(configuration);

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


var api = new Approvals.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


Approval

createApproval

Create a new approval

Create a new approval in the approvals collection. The link to an Approval Type resource is required in order to create a new Approval resource. This link should be passed in the `_links` in the request with an `apiture:approvalType` key. The optional target of an approval may be passed on in either the `_links` with the link relation `apiture:target`, or in `attributes`.


/approvals

Usage and SDK Samples

curl -X POST -H "API-Key: [[apiKey]]" "http:///approvals/approvals"
import { ApprovalApi } from "@apiture/approvals-client-sdk";

const approvalApi = new ApprovalApi(configuration);

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

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


var api = new Approvals.ApprovalApi.createApproval()
var createApproval = ; // {CreateApproval} 

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

Scopes

data/read Read access to non-account, non-profile data.
data/write Write (update) access to non-account, non-profile data.
data/delete Delete access to non-account, non-profile data.
data/full Full access to non-account, non-profile data.
admin/write Admin write (update) access to non-account, non-profile data.

Parameters

Body parameters
Name Description
createApproval *

The data necessary to create a new approval.

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 the resource.
Location String uri The URI of the new resource. If the URI begins with / it is relative to the API root context. Else, it is a full URI starting with *`scheme`*`://host`


deleteApproval

Delete this approval resource

Delete this approval resource and any resources that are owned by it. An approval may only be deleted if its state is `open` or `canceled`.


/approvals/{approvalId}

Usage and SDK Samples

curl -X DELETE -H "API-Key: [[apiKey]]" "http:///approvals/approvals/{approvalId}"
import { ApprovalApi } from "@apiture/approvals-client-sdk";

const approvalApi = new ApprovalApi(configuration);

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

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


var api = new Approvals.ApprovalApi.deleteApproval()
var approvalId = approvalId_example; // {String} The unique identifier of this approval. This is an opaque string.
var opts = {
  'ifMatch': ifMatch_example // {String} The entity tag that was returned in the `ETag` response. If supplied, 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.');
  }
};
approvalApi.deleteApproval(approvalId, opts, callback);

Scopes

data/read Read access to non-account, non-profile data.
data/write Write (update) access to non-account, non-profile data.
data/delete Delete access to non-account, non-profile data.
data/full Full access to non-account, non-profile data.
admin/write Admin write (update) access to non-account, non-profile data.

Parameters

Path parameters
Name Description
approvalId*
String
The unique identifier of this approval. This is an opaque string.
Required
Header parameters
Name Description
If-Match
String
The entity tag that was returned in the `ETag` response. If supplied, this must match the current entity tag of the resource.

Responses


getApproval

Fetch a representation of this approval

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


/approvals/{approvalId}

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///approvals/approvals/{approvalId}?embed="
import { ApprovalApi } from "@apiture/approvals-client-sdk";

const approvalApi = new ApprovalApi(configuration);

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

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


var api = new Approvals.ApprovalApi.getApproval()
var approvalId = approvalId_example; // {String} The unique identifier of this approval. This is an opaque 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.
  'embed':  // {array[String]} The `embed` query parameter specifies which related resources to include in the `_embedded` object in the response. `embed` supports the following comma-separated values: 
  • `approvalType` : include the approval type in the `_embedded.approvalType` object. (See the `approvalEmbeddedObjects` schema.)
  • `target` : include the approval target.
For example, to embed both the `approvalType` and `target` for approvals use `GET .../approval/{approvalId}?embed=approvalType,target`. To embed the target only, use `GET .../approval/{approvalId}?embed=target`. }; var callback = function(error, data, response) { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }; approvalApi.getApproval(approvalId, opts, callback);

Scopes

data/read Read access to non-account, non-profile data.
data/write Write (update) access to non-account, non-profile data.
data/delete Delete access to non-account, non-profile data.
data/full Full access to non-account, non-profile data.
admin/write Admin write (update) access to non-account, non-profile data.

Parameters

Path parameters
Name Description
approvalId*
String
The unique identifier of this approval. This is an opaque 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.
Query parameters
Name Description
embed
array[String]
The `embed` query parameter specifies which related resources to include in the `_embedded` object in the response. `embed` supports the following comma-separated values: <ul> <li>`approvalType` : include the approval type in the `_embedded.approvalType` object. (See the `approvalEmbeddedObjects` schema.)</li> <li>`target` : include the approval target.</li> </ul> For example, to embed both the `approvalType` and `target` for approvals use `GET .../approval/{approvalId}?embed=approvalType,target`. To embed the target only, use `GET .../approval/{approvalId}?embed=target`.

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 approval resource.


getApprovals

Return a collection of approvals

Return a [paginated](https://developer.apiture.com/docs/concepts/pagination) [sortable](https://developer.apiture.com/docs/concepts/sorting) [filterable](https://developer.apiture.com/docs/concepts/filtering) [searchable](https://developer.apiture.com/docs/concepts/searchable) collection of approvals. The [links](https://developer.apiture.com/docs/concepts/links) in the response include pagination links.


/approvals

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///approvals/approvals?start=&limit=&sortBy=&filter=&q=&state=&label="
import { ApprovalApi } from "@apiture/approvals-client-sdk";

const approvalApi = new ApprovalApi(configuration);

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

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


var api = new Approvals.ApprovalApi.getApprovals()
var opts = {
  'start': 789, // {Long} The zero-based index of the first approval item to include in this page. The default 0 denotes the beginning of the collection.
  'limit': 56, // {Integer} The maximum number of approval representations to return in this page.
  'sortBy': sortBy_example, // {String} Optional sort criteria. See [sort criteria format](https://developer.apiture.com/docs/concepts/sorting), such as `?sortBy=field1,-field2`.
  'filter': filter_example, // {String} Optional filter criteria. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
  'q': q_example, // {String} Optional search string. See [searching](https://developer.apiture.com/docs/concepts/searching).
  'state': , // {array[String]} Subset the approvals collection to those whose `state` matches this value. Use `|` to separate multiple values. For example, `?state=submitted` matches only items whose `state` is `submitted`; `?state=rejected|approved` matches items whose `state` is `rejected` or `approved`. The value or `|`-separated values should be from the `approvalState` enumeration. This is combined with an implicit `and` with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
  'label': label_example // {String} Subset the approvals collection to those with this label value. Use `|` to separate multiple values. For example, `?label=email_verification` matches only items whose label is `email_verification`; `?label=email_verification|account_verification` will match items whose label is `email_verification` or `account_verification`. This is combined with an implicit and with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
};

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

Scopes

data/read Read access to non-account, non-profile data.
data/write Write (update) access to non-account, non-profile data.
data/delete Delete access to non-account, non-profile data.
data/full Full access to non-account, non-profile data.
admin/write Admin write (update) access to non-account, non-profile data.

Parameters

Query parameters
Name Description
start
Long (int64)
The zero-based index of the first approval item to include in this page. The default 0 denotes the beginning of the collection.
limit
Integer (int32)
The maximum number of approval representations to return in this page.
sortBy
String
Optional sort criteria. See [sort criteria format](https://developer.apiture.com/docs/concepts/sorting), such as `?sortBy=field1,-field2`.
filter
String
Optional filter criteria. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
q
String
Optional search string. See [searching](https://developer.apiture.com/docs/concepts/searching).
state
array[String]
Subset the approvals collection to those whose `state` matches this value. Use `|` to separate multiple values. For example, `?state=submitted` matches only items whose `state` is `submitted`; `?state=rejected|approved` matches items whose `state` is `rejected` or `approved`. The value or `|`-separated values should be from the `approvalState` enumeration. This is combined with an implicit `and` with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
label
String
Subset the approvals collection to those with this label value. Use `|` to separate multiple values. For example, `?label=email_verification` matches only items whose label is `email_verification`; `?label=email_verification|account_verification` will match items whose label is `email_verification` or `account_verification`. This is combined with an implicit and with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).

Responses


patchApproval

Update this approval

Perform a partial update of this approval. Omitted fields are not updated. Nested `_embedded` and `_links` are ignored if included. The `state` is not updated by this operation; use the state-change operations described in the `approval` schema.


/approvals/{approvalId}

Usage and SDK Samples

curl -X PATCH -H "API-Key: [[apiKey]]" "http:///approvals/approvals/{approvalId}"
import { ApprovalApi } from "@apiture/approvals-client-sdk";

const approvalApi = new ApprovalApi(configuration);

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

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


var api = new Approvals.ApprovalApi.patchApproval()
var approvalId = approvalId_example; // {String} The unique identifier of this approval. This is an opaque string.
var updateApproval = ; // {UpdateApproval} 
var opts = {
  'ifMatch': ifMatch_example // {String} The entity tag that was returned in the `ETag` response. If supplied, 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);
  }
};
approvalApi.patchApproval(approvalId, updateApproval, opts, callback);

Scopes

data/read Read access to non-account, non-profile data.
data/write Write (update) access to non-account, non-profile data.
data/delete Delete access to non-account, non-profile data.
data/full Full access to non-account, non-profile data.
admin/write Admin write (update) access to non-account, non-profile data.

Parameters

Path parameters
Name Description
approvalId*
String
The unique identifier of this approval. This is an opaque string.
Required
Header parameters
Name Description
If-Match
String
The entity tag that was returned in the `ETag` response. If supplied, this must match the current entity tag of the resource.
Body parameters
Name Description
updateApproval *

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 approval resource.


updateApproval

Update this approval

Perform a complete replacement of this approval. Nested `_embedded` and `_links` are ignored if included. The `state` is not updated by this operation; use the state-change operations described in the `approval` schema.


/approvals/{approvalId}

Usage and SDK Samples

curl -X PUT -H "API-Key: [[apiKey]]" "http:///approvals/approvals/{approvalId}"
import { ApprovalApi } from "@apiture/approvals-client-sdk";

const approvalApi = new ApprovalApi(configuration);

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

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


var api = new Approvals.ApprovalApi.updateApproval()
var approvalId = approvalId_example; // {String} The unique identifier of this approval. This is an opaque string.
var updateApproval = ; // {UpdateApproval} 
var opts = {
  'ifMatch': ifMatch_example // {String} The entity tag that was returned in the `ETag` response. If supplied, 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);
  }
};
approvalApi.updateApproval(approvalId, updateApproval, opts, callback);

Scopes

data/read Read access to non-account, non-profile data.
data/write Write (update) access to non-account, non-profile data.
data/delete Delete access to non-account, non-profile data.
data/full Full access to non-account, non-profile data.
admin/write Admin write (update) access to non-account, non-profile data.

Parameters

Path parameters
Name Description
approvalId*
String
The unique identifier of this approval. This is an opaque string.
Required
Header parameters
Name Description
If-Match
String
The entity tag that was returned in the `ETag` response. If supplied, this must match the current entity tag of the resource.
Body parameters
Name Description
updateApproval *

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 approval resource.


ApprovalActions

approveApproval

Approve an approval

Approve an approval. Only approvals which are `submitted` may be `approved`. This operation is invoked from the `apiture:approve` link on a product type when it is eligible to be approved. This changes the `state` to `approved`.


/approvedApprovals

Usage and SDK Samples

curl -X POST -H "API-Key: [[apiKey]]" "http:///approvals/approvedApprovals?approval=&approvalUri="
import { ApprovalActionsApi } from "@apiture/approvals-client-sdk";

const approvalActionsApi = new ApprovalActionsApi(configuration);

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

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


var api = new Approvals.ApprovalActionsApi.approveApproval()
var approval = approval_example; // {String} A server-generated key which identifies an existing approval resource.
var opts = {
  'approvalUri': approvalUri_example, // {String} The URI of an existing approval which is eligible to be approved. Note: This parameter is **deprecated** and will be removed in the next version. Use `?approval=` instead.
  'ifMatch': ifMatch_example // {String} The entity tag that was returned in the `ETag` response. If supplied, 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);
  }
};
approvalActionsApi.approveApproval(approval, opts, callback);

Scopes

data/read Read access to non-account, non-profile data.
data/write Write (update) access to non-account, non-profile data.
data/delete Delete access to non-account, non-profile data.
data/full Full access to non-account, non-profile data.
admin/write Admin write (update) access to non-account, non-profile data.

Parameters

Header parameters
Name Description
If-Match
String
The entity tag that was returned in the `ETag` response. If supplied, this must match the current entity tag of the resource.
Query parameters
Name Description
approval*
String
A server-generated key which identifies an existing approval resource.
Required
approvalUri
String
The URI of an existing approval which is eligible to be approved. Note: This parameter is **deprecated** and will be removed in the next version. Use `?approval=` instead.

Responses


cancelApproval

Cancel an approval

Cancel an approval. Only approvals which are `open`, `submitted` or `returned` may be `canceled`. This operation is invoked from the `apiture:cancel` link on an approval when it is eligible to be canceled. This changes the `state` to `canceled`.


/canceledApprovals

Usage and SDK Samples

curl -X POST -H "API-Key: [[apiKey]]" "http:///approvals/canceledApprovals?approval=&approvalUri="
import { ApprovalActionsApi } from "@apiture/approvals-client-sdk";

const approvalActionsApi = new ApprovalActionsApi(configuration);

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

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


var api = new Approvals.ApprovalActionsApi.cancelApproval()
var approval = approval_example; // {String} A server-generated key which identifies an existing approval resource.
var approvalUri = approvalUri_example; // {String} The URI of an existing approval which is eligible to be canceled. Note: This parameter is **deprecated** and will be removed in the next version. Use `?approval=` instead.
var opts = {
  'ifMatch': ifMatch_example // {String} The entity tag that was returned in the `ETag` response. If supplied, 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);
  }
};
approvalActionsApi.cancelApproval(approval, approvalUri, opts, callback);

Scopes

data/read Read access to non-account, non-profile data.
data/write Write (update) access to non-account, non-profile data.
data/delete Delete access to non-account, non-profile data.
data/full Full access to non-account, non-profile data.
admin/write Admin write (update) access to non-account, non-profile data.

Parameters

Header parameters
Name Description
If-Match
String
The entity tag that was returned in the `ETag` response. If supplied, this must match the current entity tag of the resource.
Query parameters
Name Description
approval*
String
A server-generated key which identifies an existing approval resource.
Required
approvalUri*
String
The URI of an existing approval which is eligible to be canceled. Note: This parameter is **deprecated** and will be removed in the next version. Use `?approval=` instead.
Required

Responses


rejectApproval

Reject an approval

Reject an approval. Only approvals which are `submitted` may be `rejected`. This operation is invoked from the `apiture:reject` link on an approval when it is eligible to be rejected. This changes the `state` to `rejected`.


/rejectedApprovals

Usage and SDK Samples

curl -X POST -H "API-Key: [[apiKey]]" "http:///approvals/rejectedApprovals?approval=&approvalUri="
import { ApprovalActionsApi } from "@apiture/approvals-client-sdk";

const approvalActionsApi = new ApprovalActionsApi(configuration);

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

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


var api = new Approvals.ApprovalActionsApi.rejectApproval()
var approval = approval_example; // {String} A server-generated key which identifies an existing approval resource.
var opts = {
  'approvalUri': approvalUri_example, // {String} The URI of an existing approval which is eligible to be rejected. Note: This parameter is **deprecated** and will be removed in the next version. Use `?approval=` instead.
  'ifMatch': ifMatch_example // {String} The entity tag that was returned in the `ETag` response. If supplied, 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);
  }
};
approvalActionsApi.rejectApproval(approval, opts, callback);

Scopes

data/read Read access to non-account, non-profile data.
data/write Write (update) access to non-account, non-profile data.
data/delete Delete access to non-account, non-profile data.
data/full Full access to non-account, non-profile data.
admin/write Admin write (update) access to non-account, non-profile data.

Parameters

Header parameters
Name Description
If-Match
String
The entity tag that was returned in the `ETag` response. If supplied, this must match the current entity tag of the resource.
Query parameters
Name Description
approval*
String
A server-generated key which identifies an existing approval resource.
Required
approvalUri
String
The URI of an existing approval which is eligible to be rejected. Note: This parameter is **deprecated** and will be removed in the next version. Use `?approval=` instead.

Responses


returnApproval

Return an approval

Return an approval. Only approvals which are `submitted` may be `returned`. This operation is invoked from the `apiture:return` link on an approval when it is eligible to be returned. This changes the `state` to `returned`.


/returnedApprovals

Usage and SDK Samples

curl -X POST -H "API-Key: [[apiKey]]" "http:///approvals/returnedApprovals?approval=&approvalUri="
import { ApprovalActionsApi } from "@apiture/approvals-client-sdk";

const approvalActionsApi = new ApprovalActionsApi(configuration);

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

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


var api = new Approvals.ApprovalActionsApi.returnApproval()
var approval = approval_example; // {String} A server-generated key which identifies an existing approval resource.
var approvalUri = approvalUri_example; // {String} The URI of an existing approval which is eligible to be returned. Note: This parameter is **deprecated** and will be removed in the next version. Use `?approval=` instead.
var opts = {
  'ifMatch': ifMatch_example // {String} The entity tag that was returned in the `ETag` response. If supplied, 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);
  }
};
approvalActionsApi.returnApproval(approval, approvalUri, opts, callback);

Scopes

data/read Read access to non-account, non-profile data.
data/write Write (update) access to non-account, non-profile data.
data/delete Delete access to non-account, non-profile data.
data/full Full access to non-account, non-profile data.
admin/write Admin write (update) access to non-account, non-profile data.

Parameters

Header parameters
Name Description
If-Match
String
The entity tag that was returned in the `ETag` response. If supplied, this must match the current entity tag of the resource.
Query parameters
Name Description
approval*
String
A server-generated key which identifies an existing approval resource.
Required
approvalUri*
String
The URI of an existing approval which is eligible to be returned. Note: This parameter is **deprecated** and will be removed in the next version. Use `?approval=` instead.
Required

Responses


submitApproval

Submit an approval

Submit an approval. Only approvals which are `open` or `returned` may be `submitted`. This operation is invoked from the `apiture:submit` link on an approval when it is eligible to be submitted. This changes the `state` to `submitted`.


/submittedApprovals

Usage and SDK Samples

curl -X POST -H "API-Key: [[apiKey]]" "http:///approvals/submittedApprovals?approval=&approvalUri="
import { ApprovalActionsApi } from "@apiture/approvals-client-sdk";

const approvalActionsApi = new ApprovalActionsApi(configuration);

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

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


var api = new Approvals.ApprovalActionsApi.submitApproval()
var approval = approval_example; // {String} A server-generated key which identifies an existing approval resource.
var approvalUri = approvalUri_example; // {String} The URI of an existing approval which is eligible to be submitted. Note: This parameter is **deprecated** and will be removed in the next version. Use `?approval=` instead.
var opts = {
  'ifMatch': ifMatch_example // {String} The entity tag that was returned in the `ETag` response. If supplied, 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);
  }
};
approvalActionsApi.submitApproval(approval, approvalUri, opts, callback);

Scopes

data/read Read access to non-account, non-profile data.
data/write Write (update) access to non-account, non-profile data.
data/delete Delete access to non-account, non-profile data.
data/full Full access to non-account, non-profile data.
admin/write Admin write (update) access to non-account, non-profile data.

Parameters

Header parameters
Name Description
If-Match
String
The entity tag that was returned in the `ETag` response. If supplied, this must match the current entity tag of the resource.
Query parameters
Name Description
approval*
String
A server-generated key which identifies an existing approval resource.
Required
approvalUri*
String
The URI of an existing approval which is eligible to be submitted. Note: This parameter is **deprecated** and will be removed in the next version. Use `?approval=` instead.
Required

Responses


waiveApproval

Waive an approval

Waive an approval. Only approvals which are `open` or `submitted` may be `waived`. This operation is invoked from the `apiture:waive` link on an approval when it is eligible to be waived. This changes the `state` to `waived`.


/waivedApprovals

Usage and SDK Samples

curl -X POST -H "API-Key: [[apiKey]]" "http:///approvals/waivedApprovals?approval=&approvalUri="
import { ApprovalActionsApi } from "@apiture/approvals-client-sdk";

const approvalActionsApi = new ApprovalActionsApi(configuration);

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

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


var api = new Approvals.ApprovalActionsApi.waiveApproval()
var approval = approval_example; // {String} A server-generated key which identifies an existing approval resource.
var approvalUri = approvalUri_example; // {String} The URI of an existing approval which is eligible to be waived. Note: This parameter is **deprecated** and will be removed in the next version. Use `?approval=` instead.
var opts = {
  'ifMatch': ifMatch_example // {String} The entity tag that was returned in the `ETag` response. If supplied, 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);
  }
};
approvalActionsApi.waiveApproval(approval, approvalUri, opts, callback);

Scopes

data/read Read access to non-account, non-profile data.
data/write Write (update) access to non-account, non-profile data.
data/delete Delete access to non-account, non-profile data.
data/full Full access to non-account, non-profile data.
admin/write Admin write (update) access to non-account, non-profile data.

Parameters

Header parameters
Name Description
If-Match
String
The entity tag that was returned in the `ETag` response. If supplied, this must match the current entity tag of the resource.
Query parameters
Name Description
approval*
String
A server-generated key which identifies an existing approval resource.
Required
approvalUri*
String
The URI of an existing approval which is eligible to be waived. Note: This parameter is **deprecated** and will be removed in the next version. Use `?approval=` instead.
Required

Responses


ApprovalType

createApprovalType

Create a new approval type

Create a new approval type in the approval types collection.


/approvalTypes

Usage and SDK Samples

curl -X POST -H "API-Key: [[apiKey]]" "http:///approvals/approvalTypes"
import { ApprovalTypeApi } from "@apiture/approvals-client-sdk";

const approvalTypeApi = new ApprovalTypeApi(configuration);

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

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


var api = new Approvals.ApprovalTypeApi.createApprovalType()
var createApprovalType = ; // {CreateApprovalType} 

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

Scopes

data/read Read access to non-account, non-profile data.
data/write Write (update) access to non-account, non-profile data.
data/delete Delete access to non-account, non-profile data.
data/full Full access to non-account, non-profile data.
admin/write Admin write (update) access to non-account, non-profile data.

Parameters

Body parameters
Name Description
createApprovalType *

The data necessary to create a new approval type.

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 the resource.
Location String uri The URI of the new resource. If the URI begins with / it is relative to the API root context. Else, it is a full URI starting with *`scheme`*`://host`


deleteApprovalType

Delete this approval type resource

Delete this approval type resource and any resources that are owned by it. Deleting an Approval Type is only allowed if it is not in use by any existing Approvals.


/approvalTypes/{approvalTypeId}

Usage and SDK Samples

curl -X DELETE -H "API-Key: [[apiKey]]" "http:///approvals/approvalTypes/{approvalTypeId}"
import { ApprovalTypeApi } from "@apiture/approvals-client-sdk";

const approvalTypeApi = new ApprovalTypeApi(configuration);

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

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


var api = new Approvals.ApprovalTypeApi.deleteApprovalType()
var approvalTypeId = approvalTypeId_example; // {String} The unique identifier of this approval type. This is an opaque string.
var opts = {
  'ifMatch': ifMatch_example // {String} The entity tag that was returned in the `ETag` response. If supplied, 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.');
  }
};
approvalTypeApi.deleteApprovalType(approvalTypeId, opts, callback);

Scopes

data/read Read access to non-account, non-profile data.
data/write Write (update) access to non-account, non-profile data.
data/delete Delete access to non-account, non-profile data.
data/full Full access to non-account, non-profile data.
admin/write Admin write (update) access to non-account, non-profile data.

Parameters

Path parameters
Name Description
approvalTypeId*
String
The unique identifier of this approval type. This is an opaque string.
Required
Header parameters
Name Description
If-Match
String
The entity tag that was returned in the `ETag` response. If supplied, this must match the current entity tag of the resource.

Responses


getApprovalType

Fetch a representation of this approval type

Return a [HAL](https://developer.apiture.com/docs/concepts/hal) representation of this approval type resource.


/approvalTypes/{approvalTypeId}

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///approvals/approvalTypes/{approvalTypeId}"
import { ApprovalTypeApi } from "@apiture/approvals-client-sdk";

const approvalTypeApi = new ApprovalTypeApi(configuration);

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

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


var api = new Approvals.ApprovalTypeApi.getApprovalType()
var approvalTypeId = approvalTypeId_example; // {String} The unique identifier of this approval type. This is an opaque 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);
  }
};
approvalTypeApi.getApprovalType(approvalTypeId, opts, callback);

Scopes

data/read Read access to non-account, non-profile data.
data/write Write (update) access to non-account, non-profile data.
data/delete Delete access to non-account, non-profile data.
data/full Full access to non-account, non-profile data.
admin/write Admin write (update) access to non-account, non-profile data.

Parameters

Path parameters
Name Description
approvalTypeId*
String
The unique identifier of this approval type. This is an opaque 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 approval type resource.


getApprovalTypes

Return a collection of approval types

Return a [paginated](https://developer.apiture.com/docs/concepts/pagination) [sortable](https://developer.apiture.com/docs/concepts/sorting) [filterable](https://developer.apiture.com/docs/concepts/filtering) [searchable](https://developer.apiture.com/docs/concepts/searchable) collection of approvals. The [links](https://developer.apiture.com/docs/concepts/links) in the response include pagination links.


/approvalTypes

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///approvals/approvalTypes?start=&limit=&sortBy=&filter=&q=&label=&name="
import { ApprovalTypeApi } from "@apiture/approvals-client-sdk";

const approvalTypeApi = new ApprovalTypeApi(configuration);

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

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


var api = new Approvals.ApprovalTypeApi.getApprovalTypes()
var opts = {
  'start': 789, // {Long} The zero-based index of the first approval type item to include in this page. The default 0 denotes the beginning of the collection.
  'limit': 56, // {Integer} The maximum number of approval type representations to return in this page.
  'sortBy': sortBy_example, // {String} Optional sort criteria. See [sort criteria format](https://developer.apiture.com/docs/concepts/sorting), such as `?sortBy=field1,-field2`.
  'filter': filter_example, // {String} Optional filter criteria. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
  'q': q_example, // {String} Optional search string. See [searching](https://developer.apiture.com/docs/concepts/searching).
  'label': label_example, // {String} Subset the approvals collection to those with this label value. Use `|` to separate multiple values. For example, `?label=email_verification` matches only items whose label is `email_verification`; `?label=email_verification|account_verification` will match items whose label is `email_verification` or `account_verification`. This is combined with an implicit and with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
  'name': name_example // {String} Subset the approvals collection to those with this name value. Use `|` to separate multiple values. For example, `?name=Bartell` will match only items whose name is Bartell; `?name=Bartell|kirsten` will match items whose name is Bartell or kirsten. This is combined with an implicit and with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
};

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

Scopes

data/read Read access to non-account, non-profile data.
data/write Write (update) access to non-account, non-profile data.
data/delete Delete access to non-account, non-profile data.
data/full Full access to non-account, non-profile data.
admin/write Admin write (update) access to non-account, non-profile data.

Parameters

Query parameters
Name Description
start
Long (int64)
The zero-based index of the first approval type item to include in this page. The default 0 denotes the beginning of the collection.
limit
Integer (int32)
The maximum number of approval type representations to return in this page.
sortBy
String
Optional sort criteria. See [sort criteria format](https://developer.apiture.com/docs/concepts/sorting), such as `?sortBy=field1,-field2`.
filter
String
Optional filter criteria. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
q
String
Optional search string. See [searching](https://developer.apiture.com/docs/concepts/searching).
label
String
Subset the approvals collection to those with this label value. Use `|` to separate multiple values. For example, `?label=email_verification` matches only items whose label is `email_verification`; `?label=email_verification|account_verification` will match items whose label is `email_verification` or `account_verification`. This is combined with an implicit and with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
name
String
Subset the approvals collection to those with this name value. Use `|` to separate multiple values. For example, `?name=Bartell` will match only items whose name is Bartell; `?name=Bartell|kirsten` will match items whose name is Bartell or kirsten. This is combined with an implicit and with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).

Responses


patchApprovalType

Update this approval type

Perform a partial update of this approval type. Fields which are omitted are not updated. Nested `_embedded` and `_links` are ignored if included.


/approvalTypes/{approvalTypeId}

Usage and SDK Samples

curl -X PATCH -H "API-Key: [[apiKey]]" "http:///approvals/approvalTypes/{approvalTypeId}"
import { ApprovalTypeApi } from "@apiture/approvals-client-sdk";

const approvalTypeApi = new ApprovalTypeApi(configuration);

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

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


var api = new Approvals.ApprovalTypeApi.patchApprovalType()
var approvalTypeId = approvalTypeId_example; // {String} The unique identifier of this approval type. This is an opaque string.
var patchApprovalType = ; // {PatchApprovalType} 
var opts = {
  'ifMatch': ifMatch_example // {String} The entity tag that was returned in the `ETag` response. If supplied, 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);
  }
};
approvalTypeApi.patchApprovalType(approvalTypeId, patchApprovalType, opts, callback);

Scopes

data/read Read access to non-account, non-profile data.
data/write Write (update) access to non-account, non-profile data.
data/delete Delete access to non-account, non-profile data.
data/full Full access to non-account, non-profile data.
admin/write Admin write (update) access to non-account, non-profile data.

Parameters

Path parameters
Name Description
approvalTypeId*
String
The unique identifier of this approval type. This is an opaque string.
Required
Header parameters
Name Description
If-Match
String
The entity tag that was returned in the `ETag` response. If supplied, this must match the current entity tag of the resource.
Body parameters
Name Description
patchApprovalType *

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 approval type resource.


updateApprovalType

Update this approval type

Perform a complete replacement of this approval type.


/approvalTypes/{approvalTypeId}

Usage and SDK Samples

curl -X PUT -H "API-Key: [[apiKey]]" "http:///approvals/approvalTypes/{approvalTypeId}"
import { ApprovalTypeApi } from "@apiture/approvals-client-sdk";

const approvalTypeApi = new ApprovalTypeApi(configuration);

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

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


var api = new Approvals.ApprovalTypeApi.updateApprovalType()
var approvalTypeId = approvalTypeId_example; // {String} The unique identifier of this approval type. This is an opaque string.
var updateApprovalType = ; // {UpdateApprovalType} 
var opts = {
  'ifMatch': ifMatch_example // {String} The entity tag that was returned in the `ETag` response. If supplied, 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);
  }
};
approvalTypeApi.updateApprovalType(approvalTypeId, updateApprovalType, opts, callback);

Scopes

data/read Read access to non-account, non-profile data.
data/write Write (update) access to non-account, non-profile data.
data/delete Delete access to non-account, non-profile data.
data/full Full access to non-account, non-profile data.
admin/write Admin write (update) access to non-account, non-profile data.

Parameters

Path parameters
Name Description
approvalTypeId*
String
The unique identifier of this approval type. This is an opaque string.
Required
Header parameters
Name Description
If-Match
String
The entity tag that was returned in the `ETag` response. If supplied, this must match the current entity tag of the resource.
Body parameters
Name Description
updateApprovalType *

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 approval type resource.