1. No category

OpenBook API Instructions

OpenBook Rest API
Version 2.0
Table of Contents
Billable Features ....................................................................................................................... 3
Customer Resource .................................................................................................................. 6
Email Resource .......................................................................................................................... 9
Entity Attribute Resource ................................................................................................... 11
Invoice Resource .................................................................................................................... 16
Promo Code Resource .......................................................................................................... 20
Query Resource ...................................................................................................................... 22
Rate Plan Resource ............................................................................................................... 26
Reseller Resource .................................................................................................................. 32
Resource Manager Resource ............................................................................................. 37
Root Provider Resource ...................................................................................................... 42
Self Registration Resource ................................................................................................. 44
User Resource ......................................................................................................................... 46
Workflow Resource .............................................................................................................. 57
© 2014 Talligent, Inc. All rights reserved.
2
Talligent API Instructions – OpenBook v2.0
Billable Features
Retrieve All Billable Features
Path
/billablefeatures
Action
GET
Response
MediaType.APPLICATION_JSON
Parameters
Query parameters vendorType, featureCategory
Authorization
Via Basic Authorization Header
Sample Invocation
curl -X GET -H "Accept: application/json" -H "Authorization: Basic
dXNlcjpwYXNzd29yZA=="
https://demo.talligent.com/resource/billablefeatures?vendorType=OpenSta
ck&featureCategory=Port
Create a Billable Feature
Path
/billablefeatures
Action
POST
Response
201 Created
Parameters
Form parameter billableFeature
Content Type
MediaType.APPLICATION_FORM_URLENCODED
Authorization
Via Basic Authorization Header
© 2014 Talligent, Inc. All rights reserved.
3
Talligent API Instructions – OpenBook v2.0
Sample Invocation
curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -H
"Authorization:
Basic
dXNlcjpwYXNzd29yZA=="
–d
“billableFeature=
Subnet” https://demo.talligent.com/resource/billablefeatures
Update a Billable Feature
Path
/billablefeatures/{billableFeatureID}
Action
PUT
Response
200 OK
Parameters
Path parameter billableFeatureID
Form parameter billableFeature
Content Type
MediaType.APPLICATION_FORM_URLENCODED
Authorization
Via Basic Authorization Header
Sample Invocation
curl -X PUT -H "Content-Type: application/x-www-form-urlencoded" -H
"Authorization:
Basic
dXNlcjpwYXNzd29yZA=="
–d
“billableFeature=
Subnet”
https://demo.talligent.com/resource/billablefeatures/962B06F13A24-4DA6-A24D-05C270E8A7C8
Retrieve a Billable Feature
Path
/billablefeatures/{billableFeatureId}
Action
GET
Response
MediaType.APPLICATION_JSON
Parameters
Path parameter billableFeatureID
© 2014 Talligent, Inc. All rights reserved.
4
Talligent API Instructions – OpenBook v2.0
Authorization
Via Basic Authorization Header
Sample Invocation
curl -X GET -H "Accept: application/json" -H "Authorization: Basic
dXNlcjpwYXNzd29yZA=="
https://demo.talligent.com/resource/billablefeatures/962B06F1-3A24
Remove a Billable Feature
Path
/billablefeatures/{billableFeatureId}
Action
DELETE
Response
200 OK
Parameters
Path parameter billableFeatureID
Sample Invocation
curl -X DELETE
https://demo.talligent.com/resource/billablefeatures/962B06F1
© 2014 Talligent, Inc. All rights reserved.
5
Talligent API Instructions – OpenBook v2.0
Customer Resource
Retrieve All Customers
Path
/customers
Action
GET
Response
MediaType.APPLICATION_JSON
Parameters
Header parameter Range
Query parameter query
Authorization
Via Basic Authorization Header
Range
Via Range Header
Sample Invocation
curl -X GET -H "Accept: application/json" -H "Authorization: Basic
dXNlcjpwYXNzd29yZA=="
–H
“Range:
rows=0-9”
https://demo.talligent.com/resource/customers?
Create a Customer
Path
/customers
Action
POST
Response
201 Created
Parameters
Form parameters name, description, foreignID, resourceManagerId, otherForeignIds,
activeCustomer,
billingFrequency,
currency,
taxRate,
discountPercent,
minimumCommittedInvoiceAmount,
billingAddressLine1,
billingAddressLine2,
billingAddressCity,
billingAddressRegion,
billingAddressPostalCode,
billingAddressCountry, invoicingMethod, ratePlan, users
© 2014 Talligent, Inc. All rights reserved.
6
Talligent API Instructions – OpenBook v2.0
Content Type
MediaType.APPLICATION_FORM_URLENCODED
Authorization
Via Basic Authorization Header
Sample Invocation
curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -H
"Authorization:
Basic
dXNlcjpwYXNzd29yZA=="
–d
“name=Pizzeria&
billingFrequency=Monthly&currency=AED”
https://demo.talligent.com/resource/customers
Update a Customer
Path
/customers/{customerId}
Action
PUT
Response
200 OK
Parameters
Path parameter customerId
Form
parameters
name,
description,
otherForeignIds,
activeCustomer,
billingFrequency,
currency,
taxRate,
discountPercent,
minimumCommittedInvoiceAmount,
billingAddressLine1,
billingAddressLine2,
billingAddressCity,
billingAddressRegion,
billingAddressPostalCode,
billingAddressCountry, invoicingMethod, ratePlan, users
Content Type
MediaType.APPLICATION_FORM_URLENCODED
Authorization
Via Basic Authorization Header
Sample Invocation
curl -X PUT -H "Content-Type: application/x-www-form-urlencoded" -H
"Authorization: Basic dXNlcjpwYXNzd29yZA==" –d “name=ioAce&taxRate=10”
https://demo.talligent.com/resource/customers/962B06F1-3A24-4DA6-A24D05C270E8A7C8
Retrieve a Customer
Path
/customers/{customerId}
© 2014 Talligent, Inc. All rights reserved.
7
Talligent API Instructions – OpenBook v2.0
Action
GET
Response
MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML
Parameters
Path parameter customerId
Authorization
Via Basic Authorization Header
Sample Invocation
curl -X GET -H "Accept: application/json" -H "Authorization: Basic
dXNlcjpwYXNzd29yZA=="
https://demo.talligent.com/resource/customers/962B06F1-3A24-4DA6-A24D05C270E8A7C8
Retrieve the Customer for the Currently Logged In User
Path
/customers/customer
Action
GET
Response
MediaType.APPLICATION_JSON
Parameters
None
Authorization
Via Basic Authorization Header
Sample Invocation
curl -X GET -H "Accept: application/json" -H "Authorization:
dXNlcjpwYXNzd29yZA=="
https://demo.talligent.com/resource/customers/customer
© 2014 Talligent, Inc. All rights reserved.
8
Basic
Talligent API Instructions – OpenBook v2.0
Email Resource
Retrieve Email Templates by Owner
Path
/email/templates/{ownerId}
Action
GET
Response
MediaType.APPLICATION_JSON
Parameters
Path parameter ownerId
Authorization
Via Basic Authorization Header
Sample Invocation
curl -X GET –H “Accept: application/json” -H "Authorization: Basic
dXNlcjpwYXNzd29yZA=="
https://demo.talligent.com/resource/email/templates/529FG723E1
Update an Email Template
Path
/email/template
Action
POST
Response
200 OK
Parameters
Form parameters entityId, templateName, templateText
Content Type
MediaType.APPLICATION_FORM_URLENCODED
Authorization
Via Basic Authorization Header
Sample Invocation
curl -X POST –H “Content-Type: application/x-www-form-urlencoded” -H
"Authorization: Basic dXNlcjpwYXNzd29yZA==" –d
© 2014 Talligent, Inc. All rights reserved.
9
Talligent API Instructions – OpenBook v2.0
“entityID=340F23BN3&templateName=WorkFlow%Failure”
https://demo.talligent.com/resource/email/template
Send a Test Email Using a Template
Path
/email/testmessage
Action
POST
Response
200 OK
Parameters
Form parameters smtpServerDetails, recipient
Content Type
MediaType.APPLICATION_FORM_URLENCODED
Authorization
Via Basic Authorization Header
Sample Invocation
curl -X POST –H “Content-Type: application/x-www-form-urlencoded” -H
"Authorization:
Basic
dXNlcjpwYXNzd29yZA=="
–d
“smtpServerDetails=testserver.talligent.com&[email protected]”
https://demo.talligent.com/resource/email/testmessage
© 2014 Talligent, Inc. All rights reserved.
10
Talligent API Instructions – OpenBook v2.0
Entity Attribute Resource
Retrieve All Categories
Path
/entityattributes/categories
Action
GET
Response
200 OK
Parameters
Query parameters attributeClass, responseFormat
Authorization
Via Basic Authorization Header
Sample Invocation
curl
-X
GET
-H
"Authorization:
Basic
dXNlcjpwYXNzd29yZA=="
https://demo.talligent.com/resource/entityattributes/categories?attribu
teClass=User&responseFormat=String
Retrieve the Attributes of a Category
Path
/entityattributes/category/{categoryName}
Action
GET
Response
200 OK
Parameters
Path parameter categoryName
Query parameter responseFormat
Authorization
Via Basic Authorization Header
Sample Invocation
curl
-X
GET
-H
"Authorization:
Basic
dXNlcjpwYXNzd29yZA=="
https://demo.talligent.com/resource/entityattributes/category/Hardware?
responseFormat=String
© 2014 Talligent, Inc. All rights reserved.
11
Talligent API Instructions – OpenBook v2.0
Retrieve an Attribute’s Values
Path
/entityattributes/category/{categoryName}/attribute/{attributeName}/values
Action
GET
Response
200 OK
Parameters
Path parameters categoryName, attributeName
Query parameters responseFormat
Authorization
Via Basic Authorization Header
Sample Invocation
curl
-X
GET
-H
"Authorization:
Basic
dXNlcjpwYXNzd29yZA=="
https://demo.talligent.com/resource/entityattributes/category/Hardware/
attribute/CPUNum/values?responseFormat=Integer
Retrieve an Attribute’s Units
Path
/entityattributes/category/{categoryName}/attribute/{attributeName}/units
Action
GET
Response
200 OK
Parameters
Path parameters categoryName, attributeName
Query parameter responseFormat
Authorization
Via Basic Authorization Header
Sample Invocation
curl
-X
GET
-H
"Authorization:
Basic
dXNlcjpwYXNzd29yZA=="
https://demo.talligent.com/resource/entityattributes/category/Hardware/
attribute/CPUNum/units?responseFormat=Integer
© 2014 Talligent, Inc. All rights reserved.
12
Talligent API Instructions – OpenBook v2.0
Retrieve the Attributes of the Current Entity
Path
/entityattributes/entity/{entityId}
Action
GET
Response
MediaType.APPLICATION_JSON
Parameters
Path parameter entityId
Authorization
Via Basic Authorization Header
Sample Invocation
curl -X GET -H "Accept: application/json" -H "Authorization: Basic
dXNlcjpwYXNzd29yZA=="
https://demo.talligent.com/resource/entityattributes/entity/962B06F13A24-4DA6-A24D-05C270E8A7C8
Retrieve All Attributes of an Entity
Path
/entityattributes/entity/{entityId}/all
Action
GET
Response
MediaType.APPLICATION_JSON
Parameters
Path parameters entityId
Authorization
Via Basic Authorization Header
Sample Invocation
curl -X GET -H "Accept: application/json" -H "Authorization: Basic
dXNlcjpwYXNzd29yZA=="
https://demo.talligent.com/resource/entityattributes/entity/962B06F13A24-4DA6-A24D-05C270E8A7C8/all
© 2014 Talligent, Inc. All rights reserved.
13
Talligent API Instructions – OpenBook v2.0
Create an Attribute
Path
/entityattributes
Action
POST
Response
201 Created
Parameters
Form parameter attribute
Content Type
MediaType.APPLICATION_FORM_URLENCODED
Authorization
Via Basic Authorization Header
Sample Invocation
curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -H
"Authorization: Basic dXNlcjpwYXNzd29yZA==" –d “attribute=CPUGHz”
https://demo.talligent.com/resource/entityattributes
Update an Attribute
Path
/entityattributes
Action
PUT
Response
200 OK
Parameters
Form parameter attribute
Content Type
MediaType.APPLICATION_FORM_URLENCODED
Authorization
Via Basic Authorization Header
© 2014 Talligent, Inc. All rights reserved.
14
Talligent API Instructions – OpenBook v2.0
Sample Invocation
curl -X PUT -H "Content-Type: application/x-www-form-urlencoded" -H
"Authorization: Basic dXNlcjpwYXNzd29yZA==" –d “attribute=CPUGHz”
https://demo.talligent.com/resource/entityattributes
Remove an Entity Attribute
Path
/entityattributes/entity/{entityId}
Action
DELETE
Response
200 OK
Parameters
Path parameter entityId
Content Type
MediaType.APPLICATION_FORM_URLENCODED
Sample Invocation
curl -X DELETE –H “Content-Type: application/x-www-form-urlencoded”
“https://demo.talligent.com/resource/entityattributes/entity/962B06F13A24-4DA6-A24D-05C270E8A7C8
© 2014 Talligent, Inc. All rights reserved.
15
Talligent API Instructions – OpenBook v2.0
Invoice Resource
Retrieve the Invoice History for the Currently Logged In User
Path
/invoice/history
Action
GET
Response
MediaType.APPLICATION_JSON
Parameters
Header parameter Range
Authorization
Via Basic Authorization Header
Range
Via Range Header
Sample Invocation
curl -X GET –H “Accept: application/json” –H “Range: rows=0-3” -H
"Authorization:
Basic
dXNlcjpwYXNzd29yZA=="
https://demo.talligent.com/resource/invoice/history
Retrieve the Unbilled Charges for the Currently Logged In User
Path
/invoice/currentcharges
Action
GET
Response
MediaType.APPLICATION_JSON
Parameters
Header parameter X-Auth-Project-Id
Authorization
Via Basic Authorization Header
Range
Via Range Header
© 2014 Talligent, Inc. All rights reserved.
16
Talligent API Instructions – OpenBook v2.0
Sample Invocation
curl -X GET –H “Accept: application/json” –H "X-Auth-Project-Id: testproject"
-H
"Authorization:
Basic
dXNlcjpwYXNzd29yZA=="
https://demo.talligent.com/resource/invoice/currentcharges
Retrieve Invoice Details
Path
/invoice/{invoiceId}
Action
GET
Response
MediaType.APPLICATION_JSON
Parameters
Path parameter invoiceId
Authorization
Via Basic Authorization Header
Sample Invocation
curl -X GET –H “Accept: application/json” -H "Authorization: Basic
dXNlcjpwYXNzd29yZA=="
https://demo.talligent.com/resource/invoice/642FG452
Retrieve Unbilled Charges for a Payer
Path
/invoice/unbilledcharges/{payerType}/{payerId}
Action
GET
Response
MediaType.APPLICATION_JSON
Parameters
Path parameters payerId, payerType
Authorization
Via Basic Authorization Header
Sample Invocation
© 2014 Talligent, Inc. All rights reserved.
17
Talligent API Instructions – OpenBook v2.0
curl -X GET –H “Accept: application/json” -H "Authorization: Basic
dXNlcjpwYXNzd29yZA=="
https://demo.talligent.com/resource/invoice/unbilledcharges/Customer/4
Retrieve Invoice History for a Payer
Path
/invoice/history/{payerType}/{payerId}
Action
GET
Response
MediaType.APPLICATION_JSON
Parameters
Path parameters payerId, payerType
Header parameter Range
Authorization
Via Basic Authorization Header
Range
Via Range Header
Sample Invocation
curl -X GET –H “Accept: application/json” –H “Range: rows=0-3” -H
"Authorization:
Basic
dXNlcjpwYXNzd29yZA=="
https://demo.talligent.com/resource/invoice/history/Customer/4
Retrieve the Invoice Count for a Payer
Path
/invoice/count/{payerType}/{payerId}
Action
GET
Response
MediaType.APPLICATION_JSON
Parameters
Path parameters payerId, payerType
Authorization
Via Basic Authorization Header
Sample Invocation
© 2014 Talligent, Inc. All rights reserved.
18
Talligent API Instructions – OpenBook v2.0
curl -X GET –H “Accept: application/json” -H "Authorization: Basic
dXNlcjpwYXNzd29yZA=="
https://demo.talligent.com/resource/count/Customer/4
Retrieve Payments for a Payer
Path
/invoice/payments
Action
GET
Response
MediaType.APPLICATION_JSON
Parameters
Query parameters payerId, payerType
Authorization
Via Basic Authorization Header
Sample Invocation
curl -X GET –H “Accept: application/json” -H "Authorization: Basic
dXNlcjpwYXNzd29yZA=="
https://demo.talligent.com/resource/payments?payerID=4&payerType=Custom
er
© 2014 Talligent, Inc. All rights reserved.
19
Talligent API Instructions – OpenBook v2.0
Promo Code Resource
Retrieve All Promotional Codes
Path
/promocodes
Action
GET
Response
MediaType.APPLICATION_JSON
Parameters
Header parameter Range
Authorization
Via Basic Authorization Header
Range
Via Range Header
Sample Invocation
curl -X GET –H “Accept: application/json” –H “Range: rows=0-3” -H
"Authorization:
Basic
dXNlcjpwYXNzd29yZA=="
https://demo.talligent.com/resource/promocodes
Create a Promotional Code
Path
/promocodes
Action
POST
Response
201 Created
Parameters
Form parameters name, salespersonId, discountOrCredit, discountPercent,
creditAmount,
creditType,
applyToChargeCategory,
availableInvoicePeriods,
applyUntil, notValidAfter, triggerChargeCategory, triggerAmount, currency
Content Type
MediaType.APPLICATION_FORM_URLENCODED
© 2014 Talligent, Inc. All rights reserved.
20
Talligent API Instructions – OpenBook v2.0
Authorization
Via Basic Authorization Header
Sample Invocation
curl -X POST –H “Content-Type: application/x-www-form-urlencoded” -H
"Authorization:
Basic
dXNlcjpwYXNzd29yZA=="
–d
“name=10OFF&discountOrCredit=Credit&creditAmount=10&currency=USD”
https://demo.talligent.com/resource/promocodes
Validate a Promotional Code
Path
/promocodes/validate
Action
GET
Response
MediaType.APPLICATION_JSON
Parameters
Query parameter promoCode, managementRegionId
Authorization
Via Basic Authorization Header
Sample Invocation
curl -X GET –H “Accept: application/json” -H "Authorization: Basic
dXNlcjpwYXNzd29yZA=="
https://demo.talligent.com/resource/promocodes/validate?promoCode=10OFF
© 2014 Talligent, Inc. All rights reserved.
21
Talligent API Instructions – OpenBook v2.0
Query Resource
Retrieve In-Use Intervals for a Virtual Machine
Path
/query/inUseIntervals
Action
GET
Response
MediaType.APPLICATION_JSON
Parameters
Query parameters resourceId, resourceName, resourceForeignId, resourceManagerId,
resourceManagerName, resourceManagerForeignId, startDateTime, endDateTime,
customerId, customerName, customerForeignId, groupId, groupName, groupForeignId
Authorization
Via Basic Authorization Header
Sample Invocation
curl -X GET –H “Accept: application/json” -H "Authorization: Basic
dXNlcjpwYXNzd29yZA=="
https://demo.talligent.com/resource/query/inUseIntervals?resourceId=983
4F4NB33&resourceForeignId=7WE44BSfR
Retrieve Usage Metrics
Path
/query/usagemetrics
Action
GET
Response
MediaType.APPLICATION_JSON
Parameters
Header parameter Range
Query parameters resourceID, resourceName, metricName,
endDateTime, customerId, groupId, customerName, groupName
startDateTime,
Authorization
Via Basic Authorization Header
© 2014 Talligent, Inc. All rights reserved.
22
Talligent API Instructions – OpenBook v2.0
Range
Via Range Header
Sample Invocation
curl -X GET –H “Accept: application/json” –H “Range: rows=0-3” -H
"Authorization:
Basic
dXNlcjpwYXNzd29yZA=="
https://demo.talligent.com/resource/query/usagemetrics?resourceID=934FD
44B98ED&customerId=SJ9823NJ002HG
Retrieve Infrastructure Events
Path
/query/infrastructureEvents
Action
GET
Response
MediaType.APPLICATION_JSON
Parameters
Header parameter Range
Query parameters resourceID, resourceName, eventType, startDateTime,
endDateTime, customerId, groupId, customerName, customerForeignId, groupName
Authorization
Via Basic Authorization Header
Range
Via Range Header
Sample Invocation
curl -X GET –H “Accept: application/json” –H “Range: rows=0-3” -H
"Authorization:
Basic
dXNlcjpwYXNzd29yZA=="
https://demo.talligent.com/resource/query/infrastructureEvents?resource
ID=934FD44B98ED&customerId=SJ9823NJ002HG
Retrieve Invoices
Path
/query/invoices
Action
GET
Response
© 2014 Talligent, Inc. All rights reserved.
23
Talligent API Instructions – OpenBook v2.0
MediaType.APPLICATION_JSON
Parameters
Header parameter Range
Query parameters payerId, payerType, startDateTime, endDateTime, amount,
amountOp
Authorization
Via Basic Authorization Header
Range
Via Range Header
Sample Invocation
curl -X GET –H “Accept: application/json” –H “Range: rows=0-3” -H
"Authorization:
Basic
dXNlcjpwYXNzd29yZA=="
https://demo.talligent.com/resource/query/invoices?payerID=4&amount=200
&amountOp=greaterThan
Retrieve Unbilled Charges
Path
/query/unbilledcharges
Action
GET
Response
MediaType.APPLICATION_JSON
Parameters
Header parameter Range
Query parameters payerId, payerType, startDateTime, endDateTime, amount,
amountOp
Authorization
Via Basic Authorization Header
Range
Via Range Header
Sample Invocation
curl -X GET –H “Accept: application/json” –H “Range: rows=0-3” -H
"Authorization:
Basic
dXNlcjpwYXNzd29yZA=="
https://demo.talligent.com/resource/query/unbilledcharges?customerId=98
FD2HG3NKL0&amount=2000
© 2014 Talligent, Inc. All rights reserved.
24
Talligent API Instructions – OpenBook v2.0
Retrieve Users
Path
/query/users
Action
GET
Response
MediaType.APPLICATION_JSON
Parameters
Header parameter Range
Query parameters userName, firstName, lastName, emailAddress, isActive
Authorization
Via Basic Authorization Header
Range
Via Range Header
Sample Invocation
curl -X GET –H “Accept: application/json” –H “Range: rows=0-3” -H
"Authorization:
Basic
dXNlcjpwYXNzd29yZA=="
https://demo.talligent.com/resource/query/users?isActive=true
© 2014 Talligent, Inc. All rights reserved.
25
Talligent API Instructions – OpenBook v2.0
Rate Plan Resource
Retrieve All Rate Plans
Path
/rateplans
Action
GET
Response
MediaType.APPLICATION_JSON
Parameters
Query parameter appliesTo
Authorization
Via Basic Authorization Header
Sample Invocation
curl -X GET -H "Accept: application/json" -H "Authorization:
dXNlcjpwYXNzd29yZA=="
https://demo.talligent.com/resource/rateplans?appliesTo=RESELLER
Basic
Create a Rate Plan
Path
/rateplans
Action
POST
Response
201 Created
Parameters
Form parameter ratePlan
Content Type
MediaType.APPLICATION_FORM_URLENCODED
Authorization
Via Basic Authorization Header
© 2014 Talligent, Inc. All rights reserved.
26
Talligent API Instructions – OpenBook v2.0
Sample Invocation
curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -H
"Authorization: Basic dXNlcjpwYXNzd29yZA==" –d “ratePlan=Default”
https://demo.talligent.com/resource/rateplans
Update a Rate Plan
Path
/rateplans
Action
PUT
Response
200 OK
Parameters
Form parameter ratePlan
Content Type
MediaType.APPLICATION_FORM_URLENCODED
Authorization
Via Basic Authorization Header
Sample Invocation
curl -X PUT -H "Content-Type: application/x-www-form-urlencoded" -H
"Authorization: Basic dXNlcjpwYXNzd29yZA==" –d “ratePlan=Default”
https://demo.talligent.com/resource/rateplans
Remove a Rate Plan
Path
/rateplans/{ratePlanId}
Action
DELETE
Response
200 OK
Parameters
Path parameter ratePlanID
Authorization
Via Basic Authorization Header
© 2014 Talligent, Inc. All rights reserved.
27
Talligent API Instructions – OpenBook v2.0
Sample Invocation
curl -X
DELETE
-H "Authorization: Basic dXNlcjpwYXNzd29yZA=="
https://demo.talligent.com/resource/rateplans/962B06F1
Retrieve a Rate Plan
Path
/rateplans/{ratePlanId}
Action
GET
Response
MediaType.APPLICATION_JSON
Parameters
Path parameter ratePlanID
Authorization
Via Basic Authorization Header
Sample Invocation
curl -X GET -H " Accept: application/json " -H "Authorization: Basic
dXNlcjpwYXNzd29yZA=="
https://demo.talligent.com/resource/rateplans/962B06F1
Retrieve Full Rate Plan Information
Path
/rateplans/{ratePlanId}/full
Action
GET
Response
MediaType.APPLICATION_JSON
Parameters
Path parameter ratePlanID
Authorization
Via Basic Authorization Header
Sample Invocation
curl -X GET -H " Accept: application/json " -H "Authorization: Basic
dXNlcjpwYXNzd29yZA=="
https://demo.talligent.com/resource/rateplans/962B06F1/full
© 2014 Talligent, Inc. All rights reserved.
28
Talligent API Instructions – OpenBook v2.0
Retrieve Rate Plan Assignments
Path
/rateplans/{ratePlanId}/assignments
Action
GET
Response
MediaType.APPLICATION_JSON
Parameters
Path parameter ratePlanID
Authorization
Via Basic Authorization Header
Sample Invocation
curl -X GET -H " Accept: application/json " -H "Authorization: Basic
dXNlcjpwYXNzd29yZA=="
https://demo.talligent.com/resource/rateplans/962B06F1/assignments
Create a Rate Plan Assignment
Path
/rateplans/{ratePlanId}/assignments
Action
POST
Response
200 OK
Parameters
Path parameter ratePlanID
Form parameters assigneeId, assigneeType, beginDate, endDate
Content Type
MediaType.APPLICATION_FORM_URLENCODED
Authorization
Via Basic Authorization Header
Sample Invocation
curl -X POST -H " Content-Type: application/x-www-form-urlencoded" -H
"Authorization: Basic dXNlcjpwYXNzd29yZA==" –d “assigneeId=783B04F1© 2014 Talligent, Inc. All rights reserved.
29
Talligent API Instructions – OpenBook v2.0
5C21-4DA6-A24D93G270E8A1D4&assigneeType=CUSTOMER&beginDate=12012013&endDate=12092013”
https://demo.talligent.com/resource/rateplans/962B06F1/assignments
Retrieve the Billable Features of a Rate Plan
Path
/rateplans/{ratePlanId}/features
Action
GET
Response
MediaType.APPLICATION_JSON
Parameters
Path parameter ratePlanID
Authorization
Via Basic Authorization Header
Sample Invocation
curl -X GET -H " Accept: application/json " -H "Authorization: Basic
dXNlcjpwYXNzd29yZA=="
https://demo.talligent.com/resource/rateplans/962B06F1/features
Retrieve the Billable Metrics of a Rate Plan
Path
/rateplans/{ratePlanId}/metrics
Action
GET
Response
MediaType.APPLICATION_JSON
Parameters
Path parameter ratePlanID
Authorization
Via Basic Authorization Header
Sample Invocation
curl -X GET -H " Accept: application/json " -H "Authorization: Basic
dXNlcjpwYXNzd29yZA=="
https://demo.talligent.com/resource/rateplans/962B06F1/metrics
© 2014 Talligent, Inc. All rights reserved.
30
Talligent API Instructions – OpenBook v2.0
Retrieve the Billable Events of a Rate Plan
Path
/rateplans/{ratePlanId}/events
Action
GET
Response
MediaType.APPLICATION_JSON
Parameters
Path parameter ratePlanID
Authorization
Via Basic Authorization Header
Sample Invocation
curl -X GET -H " Accept: application/json " -H "Authorization: Basic
dXNlcjpwYXNzd29yZA=="
https://demo.talligent.com/resource/rateplans/962B06F1/events
Retrieve the Billable Attributes of a Rate Plan
Path
/rateplans/{ratePlanId}/attributes
Action
GET
Response
MediaType.APPLICATION_JSON
Parameters
Path parameter ratePlanID
Authorization
Via Basic Authorization Header
Sample Invocation
curl -X GET -H “Accept: application/json" -H "Authorization: Basic
dXNlcjpwYXNzd29yZA=="
https://demo.talligent.com/resource/rateplans/962B06F1/attributes
© 2014 Talligent, Inc. All rights reserved.
31
Talligent API Instructions – OpenBook v2.0
Reseller Resource
Retrieve All Resellers
Path
/resellers
Action
GET
Response
MediaType.APPLICATION_JSON
Parameters
Header parameter Range
Query parameters query
Authorization
Via Basic Authorization Header
Range
Via Range Header
Sample Invocation
curl -X GET –H “Accept: application/json” -H "Authorization: Basic
dXNlcjpwYXNzd29yZA=="
–H
“Range:
rows=0-3”
https://demo.talligent.com/resource/resellers
Retrieve Reseller by ID
Path
/resellers/selfreg/{resellerId}
Action
GET
Response
MediaType.APPLICATION_JSON
Parameters
Path parameter resellerId
Authorization
Via Basic Authorization Header
© 2014 Talligent, Inc. All rights reserved.
32
Talligent API Instructions – OpenBook v2.0
Sample Invocation
curl -X GET –H “Accept: application/json” -H "Authorization: Basic
dXNlcjpwYXNzd29yZA=="
https://demo.talligent.com/resource/resellers/selfreg/9FER29K02
Retrieve Reseller by Current Region
Path
/resellers/ currentregion
Action
GET
Response
MediaType.APPLICATION_JSON
Parameters
None
Authorization
Via Basic Authorization Header
Sample Invocation
curl -X GET –H “Accept: application/json” -H "Authorization: Basic
dXNlcjpwYXNzd29yZA=="
https://demo.talligent.com/resource/resellers/currentregion
Create a Reseller
Path
/resellers
Action
POST
Response
201 Created
Parameters
Form parameters name, description, foreignIDs, activeReseller, legalAddressLine1,
legalAddressLine2, legalAddressCity, legalAddressRegion, legalAddressPostalCode,
legalAddressCountry, billingAddressLine1, billingAddressLine2, billingAddressCity,
billingAddressRegion,
billingAddressPostalCode,
billingAddressCountry,
billingFrequency,
currency,
taxRate,
discountPercent,
minimumCommittedInvoiceAmount, invoicingMethod, ratePlan, invoicePercent,
invoiceProcessingMethod,
openbookProcessesPayments,
payerPaymentDetails,
© 2014 Talligent, Inc. All rights reserved.
33
Talligent API Instructions – OpenBook v2.0
payeePaymentDetails,
privateUrl,
notificationSettings, users, emailTemplates
publicUrl,
personalizationSettings,
Content Type
MediaType.APPLICATION_FORM_URLENCODED
Authorization
Via Basic Authorization Header
Sample Invocation
curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -H
"Authorization:
Basic
dXNlcjpwYXNzd29yZA=="
–d
“name=Reseller1&&billingFrequency=Monthly&currency=AED&foreignID=962B06
F1-3A24-4DA6-A24D-05C270E8A7C8”
https://demo.talligent.com/resource/resellers/
Update a Reseller
Path
/resellers/{resellerId}
Action
PUT
Response
200 OK
Parameters
Path parameter resellerId
Form parameters name, description, foreignIDs, activeReseller, legalAddressLine1,
legalAddressLine2, legalAddressCity, legalAddressRegion, legalAddressPostalCode,
legalAddressCountry, billingAddressLine1, billingAddressLine2, billingAddressCity,
billingAddressRegion,
billingAddressPostalCode,
billingAddressCountry,
billingFrequency,
currency,
taxRate,
discountPercent,
minimumCommittedInvoiceAmount, invoicingMethod, ratePlan, invoicePercent,
invoiceProcessingMethod,
openbookProcessesPayments,
payerPaymentDetails,
payeePaymentDetails,
privateUrl,
publicUrl,
personalizationSettings,
notificationSettings, users, emailTemplates
Content Type
MediaType.APPLICATION_FORM_URLENCODED
Authorization
Via Basic Authorization Header
Sample Invocation
© 2014 Talligent, Inc. All rights reserved.
34
Talligent API Instructions – OpenBook v2.0
curl -X PUT -H "Content-Type: application/x-www-form-urlencoded" -H
"Authorization: Basic dXNlcjpwYXNzd29yZA==" –d “name=Reseller1NewName”
https://demo.talligent.com/resource/resellers/923GN76J10
Update a Reseller of the Current Reseller
Path
/resellers/currentregion
Action
PUT
Response
200 OK
Parameters
Form parameters name, legalAddressLine1, legalAddressLine2, legalAddressCity,
legalAddressRegion,
legalAddressPostalCode,
legalAddressCountry,
billingAddressLine1, billingAddressLine2, billingAddressCity, billingAddressRegion,
billingAddressPostalCode,
billingAddressCountry,
billingFrequency,
currency,
payerPaymentDetails,
payeePaymentDetails,
openbookProcessesPayments,
personalizationSettings, notificationSettings, users, emailTemplates
Content Type
MediaType.APPLICATION_FORM_URLENCODED
Authorization
Via Basic Authorization Header
Sample Invocation
curl -X PUT -H "Content-Type: application/x-www-form-urlencoded" -H
"Authorization: Basic dXNlcjpwYXNzd29yZA==" –d “name=Reseller1NewName”
https://demo.talligent.com/resource/resellers/currentregion
Retrieve a Reseller
Path
/resellers/{resellerId}
Action
GET
Response
MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML
Parameters
Path parameter resellerId
© 2014 Talligent, Inc. All rights reserved.
35
Talligent API Instructions – OpenBook v2.0
Authorization
Via Basic Authorization Header
Sample Invocation
curl -X GET –H “Accept: application/json” -H "Authorization: Basic
dXNlcjpwYXNzd29yZA=="
https://demo.talligent.com/resource/resellers/92DF072H1N02
Remove a Reseller
Path
/resellers/{resellerId}
Action
DELETE
Response
200 OK
Parameters
Path parameter resellerId
Sample Invocation
curl -X DELETE
https://demo.talligent.com/resource/resellers/92DF072H1N02
© 2014 Talligent, Inc. All rights reserved.
36
Talligent API Instructions – OpenBook v2.0
Resource Manager Resource
Retrieve All Resource Managers
Path
/resourcemanagers
Action
GET
Response
MediaType.APPLICATION_JSON
Parameters
Query parameter vendorType
Authorization
Via Basic Authorization Header
Sample Invocation
curl -X GET -H "Accept: application/json" -H "Authorization: Basic
dXNlcjpwYXNzd29yZA=="
https://demo.talligent.com/resource/resourcemanagers?vendorType=OpenSta
ck
Retrieve a Resource Manager
Path
/resourcemanagers/{resourceManagerId}
Action
GET
Response
MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML
Parameters
Path parameter resourceManagerId
Authorization
Via Basic Authorization Header
Sample Invocation
curl -X GET -H "Accept: application/json" -H "Authorization:
dXNlcjpwYXNzd29yZA=="
https://demo.talligent.com/resource/resourcemanagers/926B06F1
© 2014 Talligent, Inc. All rights reserved.
37
Basic
Talligent API Instructions – OpenBook v2.0
Create a Resource Manager
Path
/resourcemanagers
Action
POST
Response
201 Created
Parameters
Form parameters name, vendorType, description, metadata
Content Type
MediaType.APPLICATION_FORM_URLENCODED
Authorization
Via Basic Authorization Header
Sample Invocation
curl -X POST -H "Content-Type: application/x-www-form-urlencoded"
"Authorization:
Basic
dXNlcjpwYXNzd29yZA=="
“name=NewManager&vendorType=OpenStack”
https://demo.talligent.com/resource/resourcemanagers
-H
–d
Update a Resource Manager
Path
/resourcemanagers/{resourceManagerId}
Action
PUT
Response
200 OK
Parameters
Path parameter resourceManagerId
Form parameters name, vendorType, description, metadata
Content Type
MediaType.APPLICATION_FORM_URLENCODED
© 2014 Talligent, Inc. All rights reserved.
38
Talligent API Instructions – OpenBook v2.0
Authorization
Via Basic Authorization Header
Sample Invocation
curl -X PUT -H "Content-Type: application/x-www-form-urlencoded"
"Authorization:
Basic
dXNlcjpwYXNzd29yZA=="
“name=NewManager&vendorType=OpenStack”
https://demo.talligent.com/resource/resourcemanagers/962B06F1
-H
–d
Remove a Resource Manager
Path
/resourcemanagers/{resourceManagerId}
Action
DELETE
Response
200 OK
Parameters
Path parameter resourceManagerId
Authorization
Via Basic Authorization Header
Sample Invocation
curl -X
DELETE
-H "Authorization: Basic dXNlcjpwYXNzd29yZA=="
https://demo.talligent.com/resource/resourcemanagers/962B06F1
Test a Resource Manager Connection
Path
/resourcemanagers/testconnection/{vendorType}
Action
GET
Response
MediaType.TEXT_HTML
Parameters
Path parameter vendorType
Header parameter X-Connection-Details
Authorization
Via Basic Authorization Header
© 2014 Talligent, Inc. All rights reserved.
39
Talligent API Instructions – OpenBook v2.0
Sample Invocation
curl -X GET -H "Accept: application/html" -H "Authorization: Basic
dXNlcjpwYXNzd29yZA=="
–H
“X-Connection-Details:
keep-alive”
https://demo.talligent.com/resource/resourcemanagers/testconnection/Ope
nStack
Retrieve the Billable Events for a Resource Manager
Path
/resourcemanagers/billableevents
Action
GET
Response
MediaType.APPLICATION_JSON
Parameters
Query parameters vendorType, entityType
Authorization
Via Basic Authorization Header
Sample Invocation
curl -X GET -H "Accept: application/json" -H "Authorization: Basic
dXNlcjpwYXNzd29yZA=="
https://demo.talligent.com/resource/resourcemanagers/billableevents?ven
dorType=OpenStack&entityType=SUBNET
Retrieve the Available Metrics for a Resource Manager
Path
/resourcemanagers/usagemetrics
Action
GET
Response
MediaType.APPLICATION_JSON
Parameters
Query parameter vendorType
Authorization
Via Basic Authorization Header
© 2014 Talligent, Inc. All rights reserved.
40
Talligent API Instructions – OpenBook v2.0
Sample Invocation
curl -X GET -H "Accept: application/json" -H "Authorization: Basic
dXNlcjpwYXNzd29yZA=="
https://demo.talligent.com/resource/resourcemanagers/usagemetrics?vendo
rType=OpenStack
© 2014 Talligent, Inc. All rights reserved.
41
Talligent API Instructions – OpenBook v2.0
Root Provider Resource
Retrieve the Root Provider
Path
/rootprovider
Action
GET
Response
MediaType.APPLICATION_JSON
Parameters
None
Authorization
Via Basic Authorization Header
Sample Invocation
curl -X GET –H “Accept: application/json” -H "Authorization: Basic
dXNlcjpwYXNzd29yZA==" https://demo.talligent.com/resource/rootprovider
Update the Root Provider
Path
/rootprovider
Action
PUT
Response
200 OK
Parameters
Form
parameters
name,
payeePaymentDetails,
privateUrl,
publicUrl,
personalizationSettings, notificationSettings, openbookProcessesPayments, users,
emailTemplates
Content Type
MediaType.APPLICATION_FORM_URLENCODED
Authorization
Via Basic Authorization Header
© 2014 Talligent, Inc. All rights reserved.
42
Talligent API Instructions – OpenBook v2.0
Sample Invocation
curl -X PUT -H "Content-Type: application/x-www-form-urlencoded" -H
"Authorization:
Basic
dXNlcjpwYXNzd29yZA=="
–d
“name=Root”
https://demo.talligent.com/resource/resellers/rootprovider
© 2014 Talligent, Inc. All rights reserved.
43
Talligent API Instructions – OpenBook v2.0
Self Registration Resource
Create a Customer
Path
/selfRegistration/create
Action
POST
Response
MediaType.APPLICATION_JSON
Parameters
None
Content Type
MediaType.APPLICATION_JSON
Authorization
Via Basic Authorization Header
Sample Invocation
curl
-X
POST
-H "Accept: application/json"
-H "ContentType: application/json" -H "Authorization: Basic dXNlcjpwYXNzd29yZA=="
https://demo.talligent.com/resource/selfRegistration/create
Retrieve Reseller Registration Information
Path
/selfRegistration/setup
Action
GET
Response
MediaType.APPLICATION_JSON
Parameters
Header parameter X-Openbook-Requester
Authorization
Via Basic Authorization Header
Sample Invocation
curl -X GET –H “Accept: application/json” -H "Authorization: Basic
dXNlcjpwYXNzd29yZA=="
–H
“X-Openbook-Requester:
© 2014 Talligent, Inc. All rights reserved.
44
Talligent API Instructions – OpenBook v2.0
https://demo.talligent.com”
https://demo.talligent.com/resource/selfRegistration/setup
Validate a Promotional Code
Path
/selfRegistration/promoCheck
Action
GET
Response
MediaType.APPLICATION_JSON
Parameters
Query parameters promoCode, managementRegionId
Authorization
Via Basic Authorization Header
Sample Invocation
curl -X GET –H “Accept: application/json” -H "Authorization: Basic
dXNlcjpwYXNzd29yZA=="
https://demo.talligent.com/resource/selfRegistration/promoCheck?promoCo
de=10OFF
© 2014 Talligent, Inc. All rights reserved.
45
Talligent API Instructions – OpenBook v2.0
User Resource
Retrieve the Current User’s Information
Path
/users/currentuser
Action
GET
Response
MediaType.APPLICATION_JSON
Parameters
None
Authorization
Via Basic Authorization Header
Sample Invocation
curl -X GET -H "Accept: application/json" -H "Authorization:
dXNlcjpwYXNzd29yZA=="
https://demo.talligent.com/resource/users/currentuser
Basic
Retrieve All Roles for the Current User
Path
/users/currentuser/approles
Action
GET
Response
MediaType.APPLICATION_JSON
Parameters
None
Authorization
Via Basic Authorization Header
Sample Invocation
curl -X GET -H "Accept: application/json" -H "Authorization:
dXNlcjpwYXNzd29yZA=="
https://demo.talligent.com/resource/users/currentuser/approles
© 2014 Talligent, Inc. All rights reserved.
46
Basic
Talligent API Instructions – OpenBook v2.0
Retrieve the Current User Role by Context
Path
/users/currentuser/currentrole/{contextType}
Action
GET
Response
MediaType.APPLICATION_JSON
Parameters
Path parameter contextType
Authorization
Via Basic Authorization Header
Sample Invocation
curl -X GET -H "Accept: application/json" -H "Authorization: Basic
dXNlcjpwYXNzd29yZA=="
https://demo.talligent.com/resource/users/currentuser/currentrole
Set the Context for Current User
Path
/users/currentuser/setcontext
Action
POST
Response
201 Created
Parameters
Form parameters role, context
Content Type
MediaType.APPLICATION_FORM_URLENCODED
Authorization
Via Basic Authorization Header
Sample Invocation
curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -H
"Authorization:
Basic
dXNlcjpwYXNzd29yZA=="
–d
“role=Customer”
https://demo.talligent.com/resource/users/currentuser/setcontext
© 2014 Talligent, Inc. All rights reserved.
47
Talligent API Instructions – OpenBook v2.0
Update Password for Current User
Path
/users/currentuser/password
Action
PUT
Response
201 Created
Parameters
Form parameter currentPassword, newPassword
Content Type
MediaType.APPLICATION_FORM_URLENCODED
Authorization
Via Basic Authorization Header
Sample Invocation
curl -X PUT -H "Content-Type: application/x-www-form-urlencoded"
"Authorization:
Basic
dXNlcjpwYXNzd29yZA=="
“currentPassword=ChangeMe&newPassword=ChangeNow”
https://demo.talligent.com/resource/users/currentuser/password
-H
–d
Retrieve User Information by Region
Path
/users/region/{regionId}
Action
GET
Response
MediaType.APPLICATION_JSON
Parameters
Header parameter Range
Path parameter regionId
Authorization
Via Basic Authorization Header
Range
Via Range Header
© 2014 Talligent, Inc. All rights reserved.
48
Talligent API Instructions – OpenBook v2.0
Sample Invocation
curl -X GET -H "Accept: application/json" -H "Authorization: Basic
dXNlcjpwYXNzd29yZA=="
–H
“Range:
rows=0-3”
https://demo.talligent.com/resource/users/region/926B01F64
Retrieve User Information for Current Customer
Path
/users/customer
Action
GET
Response
MediaType.APPLICATION_JSON
Parameters
Header parameter Range
Query parameter customerId
Authorization
Via Basic Authorization Header
Range
Via Range Header
Sample Invocation
curl -X GET -H "Accept: application/json" -H "Authorization: Basic
dXNlcjpwYXNzd29yZA=="
–H
“Range:
rows=0-3”
https://demo.talligent.com/resource/users/customer?customerId=926B01F64
Create a User for Current Customer
Path
/users
Action
POST
Response
201 Created
Parameters
None
Content Type
MediaType.APPLICATION_JSON
© 2014 Talligent, Inc. All rights reserved.
49
Talligent API Instructions – OpenBook v2.0
Authorization
Via Basic Authorization Header
Sample Invocation
curl
-X
POST
–H
“Accept:
application/json”
-H "ContentType: application/json" -H "Authorization: Basic dXNlcjpwYXNzd29yZA=="
https://demo.talligent.com/resource/users
Update a JSON User
Path
/users/{userId}
Action
PUT
Response
201 Created
Parameters
Path parameter userId
Content Type
MediaType.APPLICATION_JSON
Authorization
Via Basic Authorization Header
Sample Invocation
curl
-X
PUT
–H
“Accept:
application/json”
-H "ContentType: application/json" -H "Authorization: Basic dXNlcjpwYXNzd29yZA=="
https://demo.talligent.com/resource/users/92GW25JN201
Update a User
Path
/users/{userId}
Action
PUT
Response
201 Created
Parameters
Path parameter userId
© 2014 Talligent, Inc. All rights reserved.
50
Talligent API Instructions – OpenBook v2.0
Form parameters
emailAddress,
username,
firstName,
lastName,
isActive,
phoneNumber,
Content Type
MediaType.APPLICATION_FORM_URLENCODED
Authorization
Via Basic Authorization Header
Sample Invocation
curl -X PUT -H "Content-Type: application/x-www-form-urlencoded"
"Authorization:
Basic
dXNlcjpwYXNzd29yZA=="
“lastName=Davids&[email protected]”
https://demo.talligent.com/resource/users/935FG23X3
-H
–d
Retrieve a User
Path
/users
Action
GET
Response
MediaType.APPLICATION_JSON
Parameters
Query parameters userId, username
Authorization
Via Basic Authorization Header
Sample Invocation
curl -X PUT -H "Accept: application/json" -H "Authorization: Basic
dXNlcjpwYXNzd29yZA=="
https://demo.talligent.com/resource/[email protected]
Retrieve All Roles by User
Path
/users/{userID}/roles
Action
GET
Response
MediaType.APPLICATION_JSON
© 2014 Talligent, Inc. All rights reserved.
51
Talligent API Instructions – OpenBook v2.0
Parameters
Path parameter userId
Authorization
Via Basic Authorization Header
Sample Invocation
curl -X GET -H "Accept: application/json" -H "Authorization:
dXNlcjpwYXNzd29yZA=="
https://demo.talligent.com/resource/users/983F3FD32/roles
Basic
Retrieve User Permissions
Path
/users/{userId}/permissions
Action
GET
Response
MediaType.APPLICATION_JSON
Parameters
Path parameter userId
Authorization
Via Basic Authorization Header
Sample Invocation
curl -X GET -H "Accept: application/json" -H "Authorization: Basic
dXNlcjpwYXNzd29yZA=="
https://demo.talligent.com/resource/users/983F45H234/permissions
Check Password
Path
/users/checkpassword
Action
POST
Response
200 OK
Parameters
Form parameters username, password
© 2014 Talligent, Inc. All rights reserved.
52
Talligent API Instructions – OpenBook v2.0
Content Type
MediaType.APPLICATION_FORM_URLENCODED
Authorization
Via Basic Authorization Header
Sample Invocation
curl -X GET -H "Content-Type: application/x-www-form-urlencoded" -H
"Authorization:
Basic
dXNlcjpwYXNzd29yZA=="
https://demo.talligent.com/resource/users/checkpassword/ChangeMe
Verify the Password Token
Path
/users/verifypasswordtoken/{token}
Action
GET
Response
200 OK
Parameters
Path parameter token
Authorization
Via Basic Authorization Header
Sample Invocation
curl
-X
GET
-H
"Authorization:
Basic
dXNlcjpwYXNzd29yZA=="
https://demo.talligent.com/resource/users/verifypasswordtoken/123552
Create a Password Change Token
Path
/users/changepassword
Action
POST
Response
MediaType.TEXT_PLAIN
Parameters
Form parameter username
Authorization
Via Basic Authorization Header
© 2014 Talligent, Inc. All rights reserved.
53
Talligent API Instructions – OpenBook v2.0
Sample Invocation
curl -X
POST -H "Accept: text/plain"
-H
"Authorization: Basic
dXNlcjpwYXNzd29yZA=="
–d
“[email protected]”
https://demo.talligent.com/resource/users/changepassword
Set Password Using a Token
Path
/users/setpasswordwithtoken
Action
POST
Response
201 Created
Parameters
Form parameters token, password
Authorization
Via Basic Authorization Header
Content Type
MediaType.APPLICATION_FORM_URLENCODED
Sample Invocation
curl -X GET -H "Content-Type: application/x-www-form-urlencoded"
"Authorization:
Basic
dXNlcjpwYXNzd29yZA=="
“token=2342345&password=ChangeMe!”
https://demo.talligent.com/resource/users/setpasswordwithtoken
-H
–d
Grant a User Role
Path
/users/{userId}/roles
Action
POST
Response
201 Created
Parameters
Form parameter role
Content Type
MediaType.APPLICATION_JSON
© 2014 Talligent, Inc. All rights reserved.
54
Talligent API Instructions – OpenBook v2.0
Authorization
Via Basic Authorization Header
Sample Invocation
curl -X POST -H "Content-Type: application/json" -H "Authorization:
Basic
dXNlcjpwYXNzd29yZA=="
–d
“role=CustomerAdmin”
https://demo.talligent.com/resource/users/345NE341/roles
Revoke User Roles
Path
/users/{userName}/roles
Action
DELETE
Response
200 OK
Parameters
Path parameter userName
Query parameter roles
Content Type
MediaType.APPLICATION_JSON
Authorization
Via Basic Authorization Header
Sample Invocation
curl -X DELETE -H "Content-Type: application/json" -H "Authorization:
Basic
dXNlcjpwYXNzd29yZA=="
https://demo.talligent.com/resource/users/johnw/roles?roles=CustomerAdm
in
Revoke User Permissions
Path
/users/{userName}/permissions
Action
DELETE
Response
200 OK
© 2014 Talligent, Inc. All rights reserved.
55
Talligent API Instructions – OpenBook v2.0
Parameters
Path parameter userName
Query parameter permissions
Content Type
MediaType.APPLICATION_JSON
Authorization
Via Basic Authorization Header
Sample Invocation
curl -X DELETE -H "Content-Type: application/json" -H "Authorization:
Basic
dXNlcjpwYXNzd29yZA=="
https://demo.talligent.com/resource/users/johnw/permissions?permissions
=Edit
Update User Permissions
Path
/users/{userName}/permissions
Action
PUT
Response
201 Created
Parameters
Path parameter userName
Form parameter permissions
Content Type
MediaType.APPLICATION_JSON
Authorization
Via Basic Authorization Header
Sample Invocation
curl -X PUT -H "Content-Type: application/json" -H "Authorization:
Basic
dXNlcjpwYXNzd29yZA=="
–d
“permissions=Edit”
https://demo.talligent.com/resource/users/johnw/permissions
© 2014 Talligent, Inc. All rights reserved.
56
Talligent API Instructions – OpenBook v2.0
Workflow Resource
Complete a Task
Path
/workflow/tasks/complete/{taskID}
Action
POST
Response
MediaType.APPLICATION_JSON
Parameters
Path parameter taskId
Content Type
MediaType.APPLICATION_JSON
Authorization
Via Basic Authorization Header
Sample Invocation
curl
-X
POST
-H "Accept: application/json"
-H "ContentType: application/json" -H "Authorization: Basic dXNlcjpwYXNzd29yZA=="
https://demo.talligent.com/resource/workflow/tasks/complete/35PN18HJ201
Retrieve Queued Tasks
Path
/workflow/tasks/queue
Action
GET
Response
MediaType.APPLICATION_JSON
Parameters
None
Authorization
Via Basic Authorization Header
Sample Invocation
curl -X GET -H "Accept: application/json" -H "Authorization: Basic
dXNlcjpwYXNzd29yZA==" https://demo.talligent.com/workflow/tasks/queue
© 2014 Talligent, Inc. All rights reserved.
57
Talligent API Instructions – OpenBook v2.0
Retrieve Currently Running Processes
Path
/workflow/processes/running
Action
GET
Response
MediaType.APPLICATION_JSON
Parameters
None
Authorization
Via Basic Authorization Header
Sample Invocation
curl -X GET -H "Accept: application/json" -H "Authorization:
dXNlcjpwYXNzd29yZA=="
https://demo.talligent.com/workflow/processes/running
Basic
Retrieve Failed Processes
Path
/workflow/processes/fail
Action
GET
Response
MediaType.APPLICATION_JSON
Parameters
None
Authorization
Via Basic Authorization Header
Sample Invocation
curl -X GET -H "Accept: application/json" -H "Authorization:
dXNlcjpwYXNzd29yZA=="
https://demo.talligent.com/workflow/processes/fail
Basic
Retrieve Active Tasks
Path
© 2014 Talligent, Inc. All rights reserved.
58
Talligent API Instructions – OpenBook v2.0
/workflow/tasks/active
Action
GET
Response
MediaType.APPLICATION_JSON
Parameters
None
Authorization
Via Basic Authorization Header
Sample Invocation
curl -X GET -H "Accept: application/json" -H "Authorization: Basic
dXNlcjpwYXNzd29yZA==" https://demo.talligent.com/workflow/tasks/active
Claim a Task
Path
/workflow/tasks/claim/{taskID}
Action
GET
Response
MediaType.APPLICATION_JSON
Parameters
Path parameter taskID
Authorization
Via Basic Authorization Header
Sample Invocation
curl -X GET -H "Accept: application/json" -H "Authorization:
dXNlcjpwYXNzd29yZA=="
https://demo.talligent.com/workflow/tasks/claim/532E2
Basic
Release a Task
Path
/workflow/tasks/release/{taskID}
Action
GET
© 2014 Talligent, Inc. All rights reserved.
59
Talligent API Instructions – OpenBook v2.0
Response
MediaType.APPLICATION_JSON
Parameters
Path parameter taskID
Authorization
Via Basic Authorization Header
Sample Invocation
curl -X GET -H "Accept: application/json" -H "Authorization:
dXNlcjpwYXNzd29yZA=="
https://demo.talligent.com/workflow/tasks/release/532E2
© 2014 Talligent, Inc. All rights reserved.
60
Basic
Talligent API Instructions – OpenBook v2.0

 Download  Report

Paperzz.com

Your Paperzz

© Copyright 2026 Paperzz