Table of Contents

axilent.plugins.profiler

Version beta3

Resources

Profile

Back to Top

https://www.axilent.net/api/resource/axilent.plugins.profiler/beta3/profile/

GET

Permissions: Profiler

Retrieves the profile.

Parameter Type Required Default Description
key Unicode Required None The unique id of the profile to retrieve.
model Unicode Required None The name of the profiling model to use.

POST

This is a data parsing function. Params must be posted as serialized data.

Permissions: Profiler

Creates a new profile.

Parameter Type Required Default Description
search_index Unicode Not Required True If set to True, will re-index the library search to include this content.
content Dictionary Required None The profile information.
model Unicode Required None The name of the profiling model to use.
identity Unicode Required None The name of the identity template to use.

PUT

This is a data parsing function. Params must be posted as serialized data.

Permissions: Profiler

Updates an existing profile.

Parameter Type Required Default Description
search_index Unicode Not Required True If set to True, will re-index the library search to include this content.
content Dictionary Required None The profile information.
key Unicode Required None The unique id of the profile to update.
model Unicode Required None The name of the profiling model to use.

DELETE

This is a data parsing function. Params must be posted as serialized data.

Permissions: Profiler

Deletes the profile.

Parameter Type Required Default Description
key Unicode Required None The unique id of the profile to retrieve.
model Unicode Required None The name of the profiling model to use.

Event

Back to Top

https://www.axilent.net/api/resource/axilent.plugins.profiler/beta3/event/

GET

Permissions: Profiler

Retrieves the event.

Parameter Type Required Default Description
event_type Unicode Required None The type of event to create.
model Unicode Required None The profiling model to target.
event_key Unicode Required None The unique key for the event.

POST

This is a data parsing function. Params must be posted as serialized data.

Permissions: Profiler

Creates an event.

Parameter Type Required Default Description
profile Unicode Required None The profile for which the event pertains.
event_type Unicode Required None The type of event to create.
content Dictionary Required None The event content data.
model Unicode Required None The profiling model to target.

PUT

This is a data parsing function. Params must be posted as serialized data.

Permissions: Profiler

Updates an existing event.

Parameter Type Required Default Description
event_type Unicode Required None The type of event to create.
content Dictionary Required None The event content data.
model Unicode Required None The profiling model to target.
event_key Unicode Required None The unique key for the event.

DELETE

This is a data parsing function. Params must be posted as serialized data.

Permissions: Profiler

Deletes the event.

Parameter Type Required Default Description
event_type Unicode Required None The type of event to create.
model Unicode Required None The profiling model to target.
event_key Unicode Required None The unique key for the event.

Functions

Associate Goal

Back to Top

https://www.axilent.net/api/axilent.plugins.profiler/beta3/associategoal/

Permissions: Profiler

Associates a goal with a profile.

Parameter Type Required Default Description
profile Unicode Required None The unique id of the profile to retrieve.
goal Unicode Required None The goal to associate.
model Unicode Required None The name of the profiling model to use.

List Outcomes

Back to Top

https://www.axilent.net/api/axilent.plugins.profiler/beta3/listoutcomes/

Permissions: Profiler

Lists all of the possible outcomes in the model.

Parameter Type Required Default Description
model Unicode Required None The name of the profiling model to use.

List Goals

Back to Top

https://www.axilent.net/api/axilent.plugins.profiler/beta3/listgoals/

Permissions: Profiler

Lists goals in the model.

Parameter Type Required Default Description
model Unicode Required None The name of the profiling model to use.

Get Associated Goals

Back to Top

https://www.axilent.net/api/axilent.plugins.profiler/beta3/getassociatedgoals/

Permissions: Profiler

Gets goals associated with the profile.

Parameter Type Required Default Description
profile Unicode Required None The unique id of the profile to retrieve.
model Unicode Required None The name of the profiling model to use.

Rebuild Segment

Back to Top

https://www.axilent.net/api/axilent.plugins.profiler/beta3/rebuildsegment/

Permissions: Profiler

Rebuilds the specified segment.

Parameter Type Required Default Description
model Unicode Required None The name of the profiling model to use.
segment Unicode Required None The segment name

Get Segment Profiles

Back to Top

https://www.axilent.net/api/axilent.plugins.profiler/beta3/getsegmentprofiles/

Permissions: Profiler

Downloads the profiles for the segments.

Parameter Type Required Default Description
page_size Integer Not Required 25 The number of profiles per page.
constrain Unicode Not Required None If set, will constrain profiles to the specified Identity type.
no_pagination Unicode Not Required None If set to True, will disable pagination and return all of the profiles in the segment.
model Unicode Required None The name of the profiling model to use.
segment Unicode Required None The segment name
page Integer Not Required 1 The page number of profiles to use.

List Personas

Back to Top

https://www.axilent.net/api/axilent.plugins.profiler/beta3/listpersonas/

Permissions: Profiler

Lists the personas in the model.

Parameter Type Required Default Description
model Unicode Required None The name of the profiling model to use.

Disassociate Goal

Back to Top

https://www.axilent.net/api/axilent.plugins.profiler/beta3/disassociategoal/

Permissions: Profiler

Disassociates a goal from a profile.

Parameter Type Required Default Description
profile Unicode Required None The unique id of the profile to retrieve.
goal Unicode Required None The goal to associate.
model Unicode Required None The name of the profiling model to use.

Tag Event

Back to Top

https://www.axilent.net/api/axilent.plugins.profiler/beta3/tagevent/

Permissions: Profiler

Tags the event.

Parameter Type Required Default Description
event_type Unicode Required None The type of event to create.
tag Unicode Required None The tag to use on the event.
model Unicode Required None The profiling model to target.
event_key Unicode Required None The unique key for the event.

Associate Outcome

Back to Top

https://www.axilent.net/api/axilent.plugins.profiler/beta3/associateoutcome/

Permissions: Profiler

Associates an outcome with a profile.

Parameter Type Required Default Description
profile Unicode Required None The unique id of the profile to associate.
model Unicode Required None The name of the profiling model to use.
outcome Unicode Required None The outcome to associate.

Detag Event

Back to Top

https://www.axilent.net/api/axilent.plugins.profiler/beta3/detagevent/

Permissions: Profiler

De-tags the event.

Parameter Type Required Default Description
event_type Unicode Required None The type of event to create.
tag Unicode Required None The tag to use on the event.
model Unicode Required None The profiling model to target.
event_key Unicode Required None The unique key for the event.

Predict Outcomes

Back to Top

https://www.axilent.net/api/axilent.plugins.profiler/beta3/predictoutcomes/

Permissions: Profiler

Predicts outcomes for a profile that has not had an explicit outcome set.

Parameter Type Required Default Description
profile Unicode Required None The unique id of the profile for which outcomes are to be predicted.
model Unicode Required None The name of the profiling model to use.

Associate Persona

Back to Top

https://www.axilent.net/api/axilent.plugins.profiler/beta3/associatepersona/

Permissions: Profiler

Associates a persona with a profile.

Parameter Type Required Default Description
profile Unicode Required None The unique id of the profile to retrieve.
persona Unicode Required None The persona to associate.
model Unicode Required None The name of the profiling model to use.

Disassociate Outcome

Back to Top

https://www.axilent.net/api/axilent.plugins.profiler/beta3/disassociateoutcome/

Permissions: Profiler

Disassociates an outcoem from a profile.

Parameter Type Required Default Description
profile Unicode Required None The unique id of the profile to disassociate.
model Unicode Required None The name of the profiling model to use.
outcome Unicode Required None The outcome to disassociate.

Get Associated Outcomes

Back to Top

https://www.axilent.net/api/axilent.plugins.profiler/beta3/getassociatedoutcomes/

Permissions: Profiler

Gets the outcome associated with the profile.

Parameter Type Required Default Description
profile Unicode Required None The unique id of the profile to retrieve.
model Unicode Required None The name of the profiling model to use.

Get Associated Personas

Back to Top

https://www.axilent.net/api/axilent.plugins.profiler/beta3/getassociatedpersonas/

Permissions: Profiler

Gets personas associated with a profile.

Parameter Type Required Default Description
profile Unicode Required None The unique id of the profile to retrieve.
model Unicode Required None The name of the profiling model to use.

Disassociate Persona

Back to Top

https://www.axilent.net/api/axilent.plugins.profiler/beta3/disassociatepersona/

Permissions: Profiler

Dis-associates a persona with a profile.

Parameter Type Required Default Description
profile Unicode Required None The unique id of the profile to retrieve.
persona Unicode Required None The persona to associate.
model Unicode Required None The name of the profiling model to use.

axilent.plugins.calendar

Version beta3

Resources

Calendar

Back to Top

https://www.axilent.net/api/resource/axilent.plugins.calendar/beta3/calendar/

GET

Permissions: Calendar

Lists the calendars for the graphstack.

POST

Permissions: Calendar

Creates a new Calendar.

Parameter Type Required Default Description
calendar Unicode Required None The name of the calendar to create.

DELETE

Permissions: Calendar

Deletes a calendar.

Parameter Type Required Default Description
calendar Unicode Required None The name of the calendar to delete.

Event

Back to Top

https://www.axilent.net/api/resource/axilent.plugins.calendar/beta3/event/

GET

Permissions: Calendar

Gets the specified event.

Parameter Type Required Default Description
calendar Unicode Required None The name of the calendar on which the event exists.
key Unicode Required None The unique key for the event.

POST

This is a data parsing function. Params must be posted as serialized data.

Permissions: Calendar

Creates a new event.

Parameter Type Required Default Description
end Unicode Required None The end time for the event. Must be a valid date time string in the format "YYYY-MM-DD hh:mm:ss".
event_type Unicode Required None The type of event to create.
recurrence_unit Unicode Not Required None The unit of time for recurrence. Must be one of "Days", "Weeks", "Months" or "Years"
recurrence_end Unicode Not Required None The date time on which to end recurrence. If there is recurrence and the recurrence_end is not set, recurrence will go on indefinately.
content Dictionary Required None The content to post to the event. Fields should match the content type associated with the event type.
start Unicode Required None The start time for the event. Must be a valid date time string in the format "YYYY-MM-DD hh:mm:ss".
calendar Unicode Required None The name of the calendar on which the event exists.
resources List Not Required None A list of profile keys for the resources to book. Bookings will be created for the specified resources.
recurrence_quantity Integer Not Required None The number of time units to elapse between event recurrence.

PUT

This is a data parsing function. Params must be posted as serialized data.

Permissions: Calendar

Updates an existing event.

Parameter Type Required Default Description
end Unicode Not Required None The end time for the event. Must be a valid date time string in the format "YYYY-MM-DD hh:mm:ss".
event_type Unicode Not Required None The type of event to create.
recurrence_unit Unicode Not Required None The unit of time for recurrence. Must be one of "Days", "Weeks", "Months" or "Years"
recurrence_end Unicode Not Required None The date time on which to end recurrence. If there is recurrence and the recurrence_end is not set, recurrence will go on indefinately.
content Dictionary Not Required None The content to post to the event. Fields should match the content type associated with the event type.
start Unicode Not Required None The start time for the event. Must be a valid date time string in the format "YYYY-MM-DD hh:mm:ss".
key Unicode Required None The unique key for the event.
calendar Unicode Required None The name of the calendar on which the event exists.
recurrence_quantity Integer Not Required None The number of time units to elapse between event recurrence. You must specify this value to modify the recurrence, even if it is the same as the current value.

DELETE

Permissions: Calendar

Deletes the specified event.

Parameter Type Required Default Description
calendar Unicode Required None The name of the calendar on which the event exists.
key Unicode Required None The unique key for the event.

Resource

Back to Top

https://www.axilent.net/api/resource/axilent.plugins.calendar/beta3/resource/

GET

Permissions: Calendar

Retrieves the specified resource.

Parameter Type Required Default Description
profile Unicode Required None The profile key of the resource to retrieve.

POST

Permissions: Calendar

Creates a new Resource.

Parameter Type Required Default Description
profile Unicode Not Required None The profile key of the resource to create. If not specified a new profile will be created
name Unicode Required None The name of the resource to create.

PUT

Permissions: Calendar

Updates an existing resource. (Only update available is to re-name the resource.)

Parameter Type Required Default Description
profile Unicode Required None The profile key of the resource to update.
name Unicode Required None The name of the resource to create.

DELETE

Permissions: Calendar

Deletes the resource.

Parameter Type Required Default Description
profile Unicode Required None The profile key of the resource to delete.

Functions

Get Availability By Date Range

Back to Top

https://www.axilent.net/api/axilent.plugins.calendar/beta3/getavailabilitybydaterange/

Permissions: Calendar

Gets the common availability zones for the specified resources in the specified date range.

Parameter Type Required Default Description
end Unicode Required None The ending date. Must be a valid string in the format YYYY-MM-DD
calendars List Required None A list of calendars to access.
start Unicode Required None The starting date. Must be a valid date string in the format YYYY-MM-DD.
resources List Required None The resources for which availability should be retrieved.

List Events For Month

Back to Top

https://www.axilent.net/api/axilent.plugins.calendar/beta3/listeventsformonth/

Permissions: Calendar

Lists the events for the specified month.

Parameter Type Required Default Description
calendars List Required None A list of calendars to access.
month Integer Required None The number of the month for which events should be retrieved.
event_types List Not Required None The types of events to retrieve. If not specified, all types of events will be retrieved.
year Integer Required None The calendar year.
resources List Not Required None The resources for which events should be retrieved. If not specified, all events will be retrieved.

Get Availability For Week

Back to Top

https://www.axilent.net/api/axilent.plugins.calendar/beta3/getavailabilityforweek/

Permissions: Calendar

Gets the availability fo the specified resources in the specified month.

Parameter Type Required Default Description
week Integer Required None The number of the week in the year
calendars List Required None A list of calendars to access.
year Integer Required None The calendar year.
resources List Required None The resources for which availability should be retrieved.

List Events For Week

Back to Top

https://www.axilent.net/api/axilent.plugins.calendar/beta3/listeventsforweek/

Permissions: Calendar

Lists the events for the specified week.

Parameter Type Required Default Description
week Integer Required None The number of the week in the year
calendars List Required None A list of calendars to access.
event_types List Not Required None The types of events to retrieve. If not specified, all types of events will be retrieved.
year Integer Required None The calendar year.
resources List Not Required None The resources for which events should be retrieved. If not specified, all events will be retrieved.

List Events By Date Range

Back to Top

https://www.axilent.net/api/axilent.plugins.calendar/beta3/listeventsbydaterange/

Permissions: Calendar

Lists events according to supplied date range.

Parameter Type Required Default Description
end Unicode Required None The ending date. Must be a valid string in the format YYYY-MM-DD
calendars List Required None A list of calendars to access.
start Unicode Required None The starting date. Must be a valid date string in the format YYYY-MM-DD.
event_types List Not Required None The types of events to retrieve. If not specified, all types of events will be retrieved.
resources List Not Required None The resources for which events should be retrieved. If not specified, all events will be retrieved.

Get Availability For Month

Back to Top

https://www.axilent.net/api/axilent.plugins.calendar/beta3/getavailabilityformonth/

Permissions: Calendar

Gets the availability zones for the specified resources in the specified month.

Parameter Type Required Default Description
calendars List Required None A list of calendars to access.
month Integer Required None The number of the month for which availability should be retrieved.
year Integer Required None The calendar year.
resources List Required None The resources for which availability should be retrieved.

Clear Event Recurrence

Back to Top

https://www.axilent.net/api/axilent.plugins.calendar/beta3/cleareventrecurrence/

Permissions: Calendar

Clears the recurrence on an event.

Parameter Type Required Default Description
calendar Unicode Required None The name of the calendar on which the event exists.
key Unicode Required None The unique key for the event.

List Events

Back to Top

https://www.axilent.net/api/axilent.plugins.calendar/beta3/listevents/

Permissions: Calendar

Lists events for the established criteria.

Parameter Type Required Default Description
end Unicode Required None The end datetime for the event list.
start Unicode Required None The start datetime for the event list.
render_ical Unicode Not Required None If specified, will render the events in an iCalendar format string.
event_types List Not Required None If specified, will only return events matching the specified event types.
calendar Unicode Required None The name of the calendar for which events should be retrieved.
resources List Not Required None If specified will only return events that have bookings for the specified resources.

axilent.content

Version beta3

Resources

Content

Back to Top

https://www.axilent.net/api/resource/axilent.content/beta3/content/

GET

Permissions: Content Access

Gets the specified content.

Parameter Type Required Default Description
content_type_slug Unicode Required None The type of content to retrieve.
content_key Unicode Required None The key for the content to be retrieved.

POST

This is a data parsing function. Params must be posted as serialized data.

Permissions: Content

Creates new content in the target graphstack.

Parameter Type Required Default Description
content_type_slug Unicode Required None The type of content to create.
content Dictionary Required None The content data itself, a dictionary of field values

PUT

This is a data parsing function. Params must be posted as serialized data.

Permissions: Content

Updates content already resident in a graphstack.

Parameter Type Required Default Description
content_type_slug Unicode Required None The type of content to update.
content_key Unicode Required None The key for the content to be update.
content Dictionary Required None The content data itself, a dictionary of field values

DELETE

Permissions: Content

Deletes the specified content.

Parameter Type Required Default Description
content_type_slug Unicode Required None The type of content to delete.
content_key Unicode Required None The key for the content to be deleted.

Functions

Content Channel Group

Back to Top

https://www.axilent.net/api/axilent.content/beta3/contentchannelgroup/

Permissions: Content Access

Gets content from a channel group - meaning the group selects a content channel which is then used to supply the content.

Parameter Type Required Default Description
profile Unicode Not Required None The profile of the user accessing the content group.
group Unicode Required None The slug of the content group to address.
basekey Unicode Not Required None The content key of a reference content object. Used for related content.
limit Integer Not Required 0 A limit on the number of content objects that will be returned. If a limit has been set in the admin, the lesser of the internal limit or this value will be returned. If not defined, the channel will return a number of content objects limited by the limit set in the control center, or an unlimited number of content objects if no limit has been set.
flavor Unicode Not Required None If set, specifies that resulting content is filtered by the specified content flavor.

Search

Back to Top

https://www.axilent.net/api/axilent.content/beta3/search/

Permissions: Content Access

Text search for content items.

Parameter Type Required Default Description
content_types Unicode Required None Comma separated list of content types to search.
query Unicode Required None The query. Will apply to full text search. You can specify content fields with the syntax "field:term".

Content Channel

Back to Top

https://www.axilent.net/api/axilent.content/beta3/contentchannel/

Permissions: Content Access

Gets content from the channel. Content channels have specific definitions about how content should be generated, filtered and grouped.

Parameter Type Required Default Description
profile Unicode Not Required None The profile of the user accessing the content channel.
flavor Unicode Not Required None If set, specifies that resulting content is filtered by the specified content flavor.
basekey Unicode Not Required None The content key of a reference content object. Used for related content.
limit Integer Not Required 0 A limit on the number of content objects that will be returned. If a limit has been set in the admin, the lesser of the internal limit or this value will be returned. If not defined, the channel will return a number of content objects limited by the limit set in the control center, or an unlimited number of content objects if no limit has been set.
channel Unicode Required None The slug of the content content channel.

Get Content Keys

Back to Top

https://www.axilent.net/api/axilent.content/beta3/getcontentkeys/

Permissions: Content Access

Gets the content keys for the specified content type.

Parameter Type Required Default Description
content_type_slug Unicode Required None The type of content to retrieve.

Get Content By Unique Field

Back to Top

https://www.axilent.net/api/axilent.content/beta3/getcontentbyuniquefield/

Permissions: Content Access

Gets a content item by a specified field value. Will only return a single content item, so it is intended to be used with a unique field.

Will either return a content item, or an empty dictionary if no matching item is found.

Parameter Type Required Default Description
content_type Unicode Required None The name of the content type.
field_value Unicode Required None The field value.
field_name Unicode Required None The name of the field in question

Tag Content

Back to Top

https://www.axilent.net/api/axilent.content/beta3/tagcontent/

Permissions: Content

Tags the specified content.

Parameter Type Required Default Description
content_type_slug Unicode Required None The type of content to tag.
content_key Unicode Required None The key for the content to tag.
tag Unicode Required None The tag to apply to the content.

Detag Content

Back to Top

https://www.axilent.net/api/axilent.content/beta3/detagcontent/

Permissions: Content

De-tags the specified content.

Parameter Type Required Default Description
content_type_slug Unicode Required None The type of content to detag.
content_key Unicode Required None The key for the content to detag.
tag Unicode Required None The tag to remove from the content.

Re Index Content

Back to Top

https://www.axilent.net/api/axilent.content/beta3/reindexcontent/

Permissions: Content

Forces re-indexing of content for search.

Parameter Type Required Default Description
content_type_slug Unicode Required None The type of content to re-index.
content_key Unicode Required None The key for the content to re-index.

Latest Update

Back to Top

https://www.axilent.net/api/axilent.content/beta3/latestupdate/

Permissions: Content Access

Gets the timestamp of the latest time the specified content item was deployed.

Parameter Type Required Default Description
content_type_slug Unicode Required None The type of content to check.
content_key Unicode Required None The key of the content to check.

axilent.plugins.messaging

Version beta3

Resources

Recipient

Back to Top

https://www.axilent.net/api/resource/axilent.plugins.messaging/beta3/recipient/

GET

Permissions: Messaging

Gets content data for the specified recipient.

Parameter Type Required Default Description
key Unicode Required None The key of the recipient to retrieve.

POST

This is a data parsing function. Params must be posted as serialized data.

Permissions: Messaging

Creates a new recipient in the message bus.

Parameter Type Required Default Description
bus Unicode Required None The name of the message bus in which the recipient should be created.
content Dictionary Not Required None The content of the recipient. Fields should match the fields in the recipient type's associated content type.
recipient_type Unicode Required None The type of recipient to make.

PUT

This is a data parsing function. Params must be posted as serialized data.

Permissions: Messaging

Updates an existing recipient.

Parameter Type Required Default Description
content Dictionary Not Required None The content of the recipient. Fields should match the fields in the recipient type's associated content type.
key Unicode Required None The key of the recipient to update.

DELETE

Permissions: Messaging

Deletes the specified recipient.

Parameter Type Required Default Description
key Unicode Required None The key of the recipient to update.

ReceivedMessage

Back to Top

https://www.axilent.net/api/resource/axilent.plugins.messaging/beta3/receivedmessage/

GET

Permissions: Messaging

Retrieves the received message.

Parameter Type Required Default Description
message_key Unicode Required None The key of the message to recieve.
recipient_key Unicode Required None The key of the recipient who received the message.

PUT

Permissions: Messaging

Updates attributes of the received message.

Parameter Type Required Default Description
message_key Unicode Required None The key of the message to recieve.
read Unicode Not Required True If "True" will mark the message as read. Otherwise will mark the message as unread.
recipient_key Unicode Required None The key of the recipient who received the message.

DELETE

Permissions: Messaging

Deletes the received message out of the inbox.

Parameter Type Required Default Description
message_key Unicode Required None The key of the message to recieve.
recipient_key Unicode Required None The key of the recipient who received the message.

Message

Back to Top

https://www.axilent.net/api/resource/axilent.plugins.messaging/beta3/message/

POST

This is a data parsing function. Params must be posted as serialized data.

Permissions: Messaging

Creates a new message, using the specified content and structure.

Will return the key of the created message.

Parameter Type Required Default Description
sender Unicode Required None The content key of the sender.
bus Unicode Required None The name of the message bus in which the message should be created.
content Dictionary Required None The content of the message. Fields should match the fields in the content type associated with the message type.
message_type Unicode Required None The type of message to create.

Functions

Unsubscribe

Back to Top

https://www.axilent.net/api/axilent.plugins.messaging/beta3/unsubscribe/

Permissions: Messaging

Unsubscribes a recipient from a topic.

Parameter Type Required Default Description
topic Unicode Required None The topic from which the recipient is unsubscribing.
recipient_key Unicode Required None The key of the recipient that is unsubscribing from the topic.

Send Message

Back to Top

https://www.axilent.net/api/axilent.plugins.messaging/beta3/sendmessage/

Permissions: Messaging

Sends the message to a specified recipient.

Parameter Type Required Default Description
message_key Unicode Required None The key of the message to send.
recipient_key Unicode Required None The key of the message recipient.

Subscribe

Back to Top

https://www.axilent.net/api/axilent.plugins.messaging/beta3/subscribe/

Permissions: Messaging

Subscribes a recipient to a topic.

Parameter Type Required Default Description
topic Unicode Required None The topic to which the recipient is subscribing.
recipient_key Unicode Required None The key of the recipient that is subscribing to the topic.

Inbox

Back to Top

https://www.axilent.net/api/axilent.plugins.messaging/beta3/inbox/

Permissions: Messaging

Gets a list of received messages for the specified recipient.

Parameter Type Required Default Description
unread_only Unicode Not Required True If set to "True" will only return unread messages. Otherwise all received messages are returned.
recipient_key Unicode Required None The key of the recipient for whom messages should be retrieved.

Publish Message

Back to Top

https://www.axilent.net/api/axilent.plugins.messaging/beta3/publishmessage/

Permissions: Messaging

Publishes a message to a topic. All subscribers on that topic will receive the message.

Parameter Type Required Default Description
topic Unicode Required None The topic to which the message should be published.
key Unicode Required None The message key. Indicates the message to send.

axilent.library

Version beta3

Resources

Content

Back to Top

https://www.axilent.net/api/resource/axilent.library/beta3/content/

POST

This is a data parsing function. Params must be posted as serialized data.

Permissions: Library

Creates new content of the specified type, at the head end of the workflow.

Parameter Type Required Default Description
content Dictionary Required None The content data itself, a dictionary of field values
search_index Unicode Not Required True If set to True, will re-index the library search to include this content.
project Unicode Required None The name of the project to use.
content_type Unicode Required None The name of the content type.

PUT

This is a data parsing function. Params must be posted as serialized data.

Permissions: Library

Updates existing content, creating a new version.

Parameter Type Required Default Description
content Dictionary Required None The content data itself, a dictionary of field values
content_type Unicode Required None The name of the content type.
search_index Unicode Not Required True If set to True, will re-index the library search to include this content.
project Unicode Required None The name of the project to use.
reset_workflow Unicode Not Required True If set to True, will reset the workflow on the updated content item.
key Unicode Required None The content key of the content to update

DELETE

Permissions: Library

Archives the specified content, undeploying it from wherever it has been deployed.

Parameter Type Required Default Description
content_type Unicode Required None The name of the content type.
project Unicode Required None The name of the project to use.
key Unicode Required None The content key of the content to update

Functions

Ping

Back to Top

https://www.axilent.net/api/axilent.library/beta3/ping/

Permissions: Library

A no-op method to help integrators test their settings.

Parameter Type Required Default Description
project Unicode Required None The name of the project.
content_type Unicode Required None The name of the type of content being tagged.

Index Content

Back to Top

https://www.axilent.net/api/axilent.library/beta3/indexcontent/

Permissions: Library

Indexes the content in the library search.

Parameter Type Required Default Description
content_key Unicode Required None The key of the content being tagged.
project Unicode Required None The name of the project.
content_type Unicode Required None The name of the type of content being tagged.

Web Hook Callback

Back to Top

https://www.axilent.net/api/axilent.library/beta3/webhookcallback/

This is a data parsing function. Params must be posted as serialized data.

Permissions: Library

Callback method for webhook.

Content Structure

Parameter Type Required Default Description
content Dictionary Required None The content data. See Content Structure above.
project Unicode Required None The name of the project to use.

Tag Content

Back to Top

https://www.axilent.net/api/axilent.library/beta3/tagcontent/

Permissions: Library

Tags existing content.

Parameter Type Required Default Description
search_index Unicode Not Required True If set to True, will re-index the library search to include this content.
content_key Unicode Required None The key of the content being tagged.
project Unicode Required None The name of the project.
tag Unicode Required None The tag to apply to the content.
content_type Unicode Required None The name of the type of content being tagged.

Detag Content

Back to Top

https://www.axilent.net/api/axilent.library/beta3/detagcontent/

Permissions: Library

Removes tagging from content.

Parameter Type Required Default Description
search_index Unicode Not Required True If set to True, will re-index the library search to include this content.
content_key Unicode Required None The key of the content being tagged.
project Unicode Required None The name of the project.
tag Unicode Required None The tag to apply to the content.
content_type Unicode Required None The name of the type of content being tagged.

Version astoria-preview

Resources

Content

Back to Top

https://www.axilent.net/api/resource/axilent.library/astoria-preview/content/

POST

This is a data parsing function. Params must be posted as serialized data.

Permissions: Library

Creates new content of the specified type, at the head end of the workflow.

Parameter Type Required Default Description
search_index Unicode Not Required True If set to True, will re-index the library search to include this content.
content Dictionary Required None The content data itself, a dictionary of field values
content_type Unicode Required None The name of the content type.

PUT

This is a data parsing function. Params must be posted as serialized data.

Permissions: Library

Updates existing content, creating a new version.

Parameter Type Required Default Description
content_type Unicode Required None The name of the content type.
search_index Unicode Not Required True If set to True, will re-index the library search to include this content.
content Dictionary Required None The content data itself, a dictionary of field values
reset_workflow Unicode Not Required True If set to True, will reset the workflow on the updated content item.
key Unicode Required None The content key of the content to update

DELETE

Permissions: Library

Archives the specified content, undeploying it from wherever it has been deployed.

Parameter Type Required Default Description
content_type Unicode Required None The name of the content type.
key Unicode Required None The content key of the content to update

Project

Back to Top

https://www.axilent.net/api/resource/axilent.library/astoria-preview/project/

GET

Permissions: Library

Gets a dump of the project structure as a JSON file.

PUT

This is a data parsing function. Params must be posted as serialized data.

Permissions: Library

Loads the project from the data file.

Parameter Type Required Default Description
project-data Unicode Required None The project data in JSON format.

Functions

Index Content

Back to Top

https://www.axilent.net/api/axilent.library/astoria-preview/indexcontent/

Permissions: Library

Indexes the content in the library search.

Parameter Type Required Default Description
content_key Unicode Required None The key of the content being tagged.
content_type Unicode Required None The name of the type of content being tagged.

Ping

Back to Top

https://www.axilent.net/api/axilent.library/astoria-preview/ping/

Permissions: Library

No-op connection test method - does not require any arguments. (Previous versions of this function tested for the existing of a ContentType. This has now been moved to ContentTypePing.)

Content Type Ping

Back to Top

https://www.axilent.net/api/axilent.library/astoria-preview/contenttypeping/

Permissions: Library

A no-op method to help integrators test their settings.

Parameter Type Required Default Description
content_type Unicode Required None The name of the type of content being tagged.

Detag Content

Back to Top

https://www.axilent.net/api/axilent.library/astoria-preview/detagcontent/

Permissions: Library

Removes tagging from content.

Parameter Type Required Default Description
search_index Unicode Not Required True If set to True, will re-index the library search to include this content.
content_key Unicode Required None The key of the content being tagged.
tag Unicode Required None The tag to apply to the content.
content_type Unicode Required None The name of the type of content being tagged.

Tag Content

Back to Top

https://www.axilent.net/api/axilent.library/astoria-preview/tagcontent/

Permissions: Library

Tags existing content.

Parameter Type Required Default Description
search_index Unicode Not Required True If set to True, will re-index the library search to include this content.
content_key Unicode Required None The key of the content being tagged.
tag Unicode Required None The tag to apply to the content.
content_type Unicode Required None The name of the type of content being tagged.

Web Hook Callback

Back to Top

https://www.axilent.net/api/axilent.library/astoria-preview/webhookcallback/

This is a data parsing function. Params must be posted as serialized data.

Permissions: Library

Callback method for webhook.

Content Structure

Parameter Type Required Default Description
content Dictionary Required None The content data. See Content Structure above.

axilent.triggers

Version beta3

Functions

Trigger

Back to Top

https://www.axilent.net/api/axilent.triggers/beta3/trigger/

This is a data parsing function. Params must be posted as serialized data.

Permissions: Triggers

Registers a trigger. Triggers are indications about user behavior and intent, sent back to Axilent to be used for reporting and personalization purposes.


Environment Data Format

Environments are dictionaries where the keys are one or more of the following:

Parameter Type Required Default Description
profile Unicode Not Required None The Axilent profile of the user causing the trigger.
category Unicode Required None The trigger category.
timestamp Unicode Not Required None The time at which the trigger occured. If undefined this will be thepoint at which the system registers the trigger.
variables Dictionary Not Required None Other data passed with the trigger. A dictionary of key/value pairs as arbitrarily defined.
environment Dictionary Not Required {} Clues about the user environment. See Environment Data Format above.
action Unicode Required None The user action that this trigger represents.
identity Dictionary Not Required {} A dictionary of identity information. Keys might be "email", "phone" or "surname"

Profile

Back to Top

https://www.axilent.net/api/axilent.triggers/beta3/profile/

Permissions: Triggers

Convenience method to get a profile to associate with a user. Profiles may then be used with triggers.