Access Token

Refresh Token

Subdomain

Tenant Id

SuperOffice

Please, add the SuperOffice subdomain and tenant Id below

Add a new field to the current AppointmentEntity user-defined field layout.

Change a AppointmentEntity user-defined field's type based on the prog-id or label.

NetServer calculates default values on the entity, which is required when creating/storing a new instance Calls the Appointment agent service CreateDefaultAppointmentEntity.

Set default values into a new AppointmentEntity.

Calls the Appointment agent service DeleteAppointmentEntity.

Deletes the AppointmentEntity

Deletes the admin version of the field. The layout needs to be published before the change is visible.

Delete a AppointmentEntity user-defined field's details based on the prog-id or label.

True if the AppointmentEntity user-defined field layout has been changed.

Is the UDef Layout changed? This may or may not involve moving data (which takes longer).

Can be sorted and further filtered using OData conventions:

* Appointment?$select=col1,col2,abc/col3
* Appointment?$filter=col1 eq 'foo' and startswith(col2, 'baz')
* Appointment?$orderby=abc/col3,col1
* Appointment?$top=1000
* Appointment?$mode=full


OData returns XML or JSON carriers depending on the Accept headers.


Calls the Archive service using the "FindAppointment" archive.


## Filter Operators: ##

ints: eq =, ne, le, lt, gt, ge, set, equals, greater, less, unequals, between

strings: contains, is, notBegins, notContains, isNot

associate: associateIsOneOf, associateIsNotOneOf,  

list ids: oneOf, NotOneOf, 

dates: before, date, after, dateBetween, beforeToday

Unary ops: currentAssociate, beforeToday, today, afterToday, lastWeek, thisWeek, nextWeek, lastMonth, thisMonth, nextMonth, lastQuarter, thisQuarter, nextQuarter, thisHalf, thisYear

Funcs: substringof(a,b), startswith(a,b), endswith(a,b), this(f,period), next(f,n,period), previous(f,n,period), thisAndNext(f,n,period), thisAndPrevious(f,n,period), thisAndPreviousAndNext(f,period)


OData list of all AppointmentEntity.

Foreign keys on the AppointmentEntity.

Calls the Appointment agent service GetAppointmentEntity.

Gets a AppointmentEntity object.

Custom field meta-data (published user defined + extra fields) on AppointmentEntity.

Custom fields meta-data (published user defined + extra fields) on AppointmentEntity.

Get a published AppointmentEntity user-defined field's details based on the prog-id or label.

Currently published AppointmentEntity user-defined field layout.

Get a AppointmentEntity user-defined field's details based on the prog-id or label.

May be different from the published version.

Current AppointmentEntity user-defined field layout.

True if the AppointmentEntity user-defined field layout is being updated.

Is UDef Layout Publishing active?

Can be sorted and further filtered using OData conventions:

* Appointment/1234/Links?$select=col1,col2,abc/col3
* Appointment/1234/Links?$filter=col1 eq 'foo' and startswith(col2, 'baz')
* Appointment/1234/Links?$orderby=abc/col3,col1
* Appointment/1234/Links?$top=1000
* Appointment/1234/Links?$mode=full


OData returns XML or JSON carriers depending on the HTTP Accept header.


Calls the Archive service using the "Links" archive provider.


## Filter Operators: ##

ints: eq =, ne, le, lt, gt, ge, set, equals, greater, less, unequals, between

strings: contains, is, notBegins, notContains, isNot

associate: associateIsOneOf, associateIsNotOneOf,  

list ids: oneOf, NotOneOf, 

dates: before, date, after, dateBetween, beforeToday

Unary ops: currentAssociate, beforeToday, today, afterToday, lastWeek, thisWeek, nextWeek, lastMonth, thisMonth, nextMonth, lastQuarter, thisQuarter, nextQuarter, thisHalf, thisYear

Funcs: substringof(a,b), startswith(a,b), endswith(a,b), this(f,period), next(f,n,period), previous(f,n,period), thisAndNext(f,n,period), thisAndPrevious(f,n,period), thisAndPreviousAndNext(f,period)


OData list of Links under a specific AppointmentEntity.

Can be sorted and further filtered using OData conventions:

* Appointment/1234/Participants?$select=col1,col2,abc/col3
* Appointment/1234/Participants?$filter=col1 eq 'foo' and startswith(col2, 'baz')
* Appointment/1234/Participants?$orderby=abc/col3,col1
* Appointment/1234/Participants?$top=1000
* Appointment/1234/Participants?$mode=full


OData returns XML or JSON carriers depending on the HTTP Accept header.


Calls the Archive service using the "Participants" archive provider.


## Filter Operators: ##

ints: eq =, ne, le, lt, gt, ge, set, equals, greater, less, unequals, between

strings: contains, is, notBegins, notContains, isNot

associate: associateIsOneOf, associateIsNotOneOf,  

list ids: oneOf, NotOneOf, 

dates: before, date, after, dateBetween, beforeToday

Unary ops: currentAssociate, beforeToday, today, afterToday, lastWeek, thisWeek, nextWeek, lastMonth, thisMonth, nextMonth, lastQuarter, thisQuarter, nextQuarter, thisHalf, thisYear

Funcs: substringof(a,b), startswith(a,b), endswith(a,b), this(f,period), next(f,n,period), previous(f,n,period), thisAndNext(f,n,period), thisAndPrevious(f,n,period), thisAndPreviousAndNext(f,period)


OData list of Participants under a specific AppointmentEntity.

See <a href="https://tools.ietf.org/html/rfc6902">RFC6902</a> and <a href="https://tools.ietf.org/html/rfc7386">RFC 7396</a>. Update the Department field to "foo" can be done either as a JSON PATCH:
<code lang="js">
  [ { "op": "replace", "path": "/Department", "value": "foo" } ]
</code>
or as a JSON MERGE PATCH, which describes the change directly:
<code lang="js">
  { "Department": "foo" }
</code><para />
JSON PATCH supports operations 'add', 'replace', 'remove' and 'test'.
The path is case insensitive, and the leading slash is optional, so the paths "/department", "Department" and "department" are all equivalent.
<para />
Calls the {SuperOffice.CRM.Services.IAppointmentAgent} service SaveAppointmentEntity.

Update a AppointmentEntity with changes, as described in a JSON Patch or a JSON Merge Patch document.

Calls the Appointment agent service SaveAppointmentEntity.

Creates a new AppointmentEntity

This will trigger movement of field data etc.

Publish the AppointmentEntity user-defined field layout.

Updates the existing AppointmentEntity

Revert all un-published AppointmentEntity udef layout changes.

Save AppointmentEntity user-defined field layout.

This is a simpler, smaller variation of the full AppointmentEntity. Calls the Appointment agent service GetAppointment.

A simple Appointment object.

Check that entity is ready for saving.

Use the "$metadata" archive to get a list of all columns supported by the archive providers in XML format.

Returns list of archive providers supported by the OData endpoint at api/Services80/archives.

Supports JSON and ATOM+XML results based on Accept headers. Supports OData query parameters:
<ul><li>$select=col1,col2,abc/col3</li><li>$filter=col1 eq 'foo' and startswith(col2, 'baz')</li><li>$orderby=col1,abc/col3</li><li>$top=1000</li><li>$options=GrandTotal=true</li><li>$context=foo</li><li>$format=json</li></ul>
## Filter Operators: ##

ints: eq =, ne, le, lt, gt, ge, set, equals, greater, less, unequals, between

strings: contains, is, notBegins, notContains, isNot

associate: associateIsOneOf, associateIsNotOneOf,  

list ids: oneOf, NotOneOf, 

dates: before, date, after, dateBetween, beforeToday

Unary ops: currentAssociate, beforeToday, today, afterToday, lastWeek, thisWeek, nextWeek, lastMonth, thisMonth, nextMonth, lastQuarter, thisQuarter, nextQuarter, thisHalf, thisYear

Funcs: substringof(a,b), startswith(a,b), endswith(a,b), this(f,period), next(f,n,period), previous(f,n,period), thisAndNext(f,n,period), thisAndPrevious(f,n,period), thisAndPreviousAndNext(f,period)


OData returns XML or JSON carriers depending on the Accept headers. $format can also be used to 
control the response format via the URL. 

<h2>Aggregation operators</h2>

The column names can encode grouping and summarizing.
You add functions and modifiers to the column name to trigger aggregation.

<list type="bullet">* <description>GroupBy(col)</description>
* <description>Sum(col)</description>
* <description>Avg(col)</description>
* <description>Percent(col)</description>
* <description>Count(col)</description>
* <description>CountAll(col)</description>
* <description>DatePart(col)</description>



You add modifiers to the end of the column name to trigger aggregation.

<list type="bullet">* <description>:Header</description>
* <description>:Footer</description>
* <description>:HideDetail</description>


DatePart specific modifiers
<list type="bullet">* <description>:Year</description>
* <description>:Quarter</description>
* <description>:Month</description>
* <description>:Day</description>
* <description>:DayOfYear</description>
* <description>:DayOfWeek</description>
* <description>:Hour</description>
* <description>:Weekno</description>
* <description>:YearMonth</description>
* <description>:YearWeekno</description>
* <description>:YearQuarter</description>


Example: group last names together, and inject a header row for each group.
<code>
GroupBy(lastName):Header
</code>
Example: count instances of middle names, and hide the individual rows, 
report just the totals for each group using a footer. Note how the modifiers stack.
<code>
Count(middleName):HideDetail:Footer
</code>
Example: the aggregator functions can nest, so you can say
<code>
GroupBy(DatePart(personUpdatedDate):YearMonth):Header
</code>
Some simple queries can be used to filter and simplify the result list:
<code>
GET api/archives/$metadata
GET api/archives/findContact
GET api/archives/findContact?$top=20
GET api/archives/findContact?$select=nameDepartment,fullname
GET api/archives/findContact?$filter=name begins 'foo'
GET api/archives/findContact?$filter=thisAndPrevious(registered, 2, 'weeks')
GET api/archives/findContact?$select=nameDepartment,fullname&amp;$filter=name begins 'foo'
</code>

Returns archive providers in OData format.

Copy CRM document to an attachment

NetServer calculates default values on the entity, which is required when creating/storing a new instance Calls the Ticket agent service CreateDefaultAttachmentEntity.

Set default values into a new AttachmentEntity.

Calls the Ticket agent service GetAttachmentEntity.

Gets a AttachmentEntity object.

Get the content of an attachment

See <a href="https://tools.ietf.org/html/rfc6902">RFC6902</a> and <a href="https://tools.ietf.org/html/rfc7386">RFC 7396</a>. Update the Department field to "foo" can be done either as a JSON PATCH:
<code lang="js">
  [ { "op": "replace", "path": "/Department", "value": "foo" } ]
</code>
or as a JSON MERGE PATCH, which describes the change directly:
<code lang="js">
  { "Department": "foo" }
</code><para />
JSON PATCH supports operations 'add', 'replace', 'remove' and 'test'.
The path is case insensitive, and the leading slash is optional, so the paths "/department", "Department" and "department" are all equivalent.
<para />
Calls the {SuperOffice.CRM.Services.ITicketAgent} service SaveAttachmentEntity.

Update a AttachmentEntity with changes, as described in a JSON Patch or a JSON Merge Patch document.

Calls the Ticket agent service SaveAttachmentEntity.

Creates a new AttachmentEntity

Updates the existing AttachmentEntity

Upload the content for an attachment

Delete a batch task from the database.

Can be sorted and further filtered using OData conventions:

* BatchTask?$select=col1,col2,abc/col3
* BatchTask?$filter=col1 eq 'foo' and startswith(col2, 'baz')
* BatchTask?$orderby=abc/col3,col1
* BatchTask?$top=1000
* BatchTask?$mode=full


OData returns XML or JSON carriers depending on the Accept headers.


Calls the Archive service using the "BatchTasks" archive.


## Filter Operators: ##

ints: eq =, ne, le, lt, gt, ge, set, equals, greater, less, unequals, between

strings: contains, is, notBegins, notContains, isNot

associate: associateIsOneOf, associateIsNotOneOf,  

list ids: oneOf, NotOneOf, 

dates: before, date, after, dateBetween, beforeToday

Unary ops: currentAssociate, beforeToday, today, afterToday, lastWeek, thisWeek, nextWeek, lastMonth, thisMonth, nextMonth, lastQuarter, thisQuarter, nextQuarter, thisHalf, thisYear

Funcs: substringof(a,b), startswith(a,b), endswith(a,b), this(f,period), next(f,n,period), previous(f,n,period), thisAndNext(f,n,period), thisAndPrevious(f,n,period), thisAndPreviousAndNext(f,period)


OData list of all Batch.

Get a single BatchTaskInfo based on Id.

Gets an array of user BatchTaskInfo with state defined by a BatchTaskState.

Start a batch job based on BatchTaskInfo.

Stop a batch job based on Id.

Only the following properties can be updated: State, Description, Response and Request.

Update information about a BatchTask.

Gets a default Business list item.

Delete all the items in the Business list.

Calls the List agent service SaveFromListDefinition.

Marks the existing Business list item as deleted.

Calls the List agent service DeleteAllHeadingsFromListDefinition.

Delete all headings for the Business list.

Gets all the Business items

Gets a Business  item by id.

Calls the List agent service GetGetHeadingsFromListDefinition.

Gets headings for the Business list.

Calls the List agent service GetHeadings.

Gets headings for the Business list's item.

Gets user groups visible for the Business list's item.

Gets description of Business list

Get the MDO list items for "Business" - with headings and filtering by user group.

Add a new Business to the list.

Calls the List agent service SaveHeadingFromListDefinition.

Saves a new heading for the Business list.

Update the Business list

Updates an existing Business list item.

Calls the List agent service SaveHeadingsFromListDefinition.

Saves headings for the Business list.

Calls the List agent service SaveHeadingsForListItemFromListDefinition.

Saves headings for the Business list's item.

Saves user groups visible for the Business list's item.

Save the description of Business list

NetServer calculates default values on the entity, which is required when creating/storing a new instance
<para />## Online Restricted: ## The CRMScript agent is not available in Online by default. Access must be requested specifically when app is registered. Calls the CRMScript agent service CreateDefaultCRMScriptEntity.

Set default values into a new CRMScriptEntity.

<para />## Online Restricted: ## The CRMScript agent is not available in Online by default. Access must be requested specifically when app is registered. Calls the CRMScript agent service DeleteCRMScriptEntity.

Deletes the CRMScriptEntity

<para />## Online Restricted: ## The CRMScript agent is not available in Online by default. Access must be requested specifically when app is registered.

Execute a CRMScript with parameters, returning printed output value.

Returns event data with output variable values.
<para />## Online Restricted: ## The CRMScript agent is not available in Online by default. Access must be requested specifically when app is registered.

Execute a CRMScript with event data as input.

Can be sorted and further filtered using OData conventions:

* CRMScript?$select=col1,col2,abc/col3
* CRMScript?$filter=col1 eq 'foo' and startswith(col2, 'baz')
* CRMScript?$orderby=abc/col3,col1
* CRMScript?$top=1000
* CRMScript?$mode=full


OData returns XML or JSON carriers depending on the Accept headers.


Calls the Archive service using the "Ejscripts" archive.


## Filter Operators: ##

ints: eq =, ne, le, lt, gt, ge, set, equals, greater, less, unequals, between

strings: contains, is, notBegins, notContains, isNot

associate: associateIsOneOf, associateIsNotOneOf,  

list ids: oneOf, NotOneOf, 

dates: before, date, after, dateBetween, beforeToday

Unary ops: currentAssociate, beforeToday, today, afterToday, lastWeek, thisWeek, nextWeek, lastMonth, thisMonth, nextMonth, lastQuarter, thisQuarter, nextQuarter, thisHalf, thisYear

Funcs: substringof(a,b), startswith(a,b), endswith(a,b), this(f,period), next(f,n,period), previous(f,n,period), thisAndNext(f,n,period), thisAndPrevious(f,n,period), thisAndPreviousAndNext(f,period)


OData list of all CRMScriptEntity.

Calls the CRMScript agent service GetCRMScriptEntity.
<para />## Online Restricted: ## The CRMScript agent is not available in Online by default. Access must be requested specifically when app is registered.

Gets a CRMScriptEntity object.

See <a href="https://tools.ietf.org/html/rfc6902">RFC6902</a> and <a href="https://tools.ietf.org/html/rfc7386">RFC 7396</a>.
<para />## Online Restricted: ## The CRMScript agent is not available in Online by default. Access must be requested specifically when app is registered. Update the Department field to "foo" can be done either as a JSON PATCH:
<code lang="js">
  [ { "op": "replace", "path": "/Department", "value": "foo" } ]
</code>
or as a JSON MERGE PATCH, which describes the change directly:
<code lang="js">
  { "Department": "foo" }
</code><para />
JSON PATCH supports operations 'add', 'replace', 'remove' and 'test'.
The path is case insensitive, and the leading slash is optional, so the paths "/department", "Department" and "department" are all equivalent.
<para />
Calls the {SuperOffice.CRM.Services.ICRMScriptAgent} service SaveCRMScriptEntity.

Update a CRMScriptEntity with changes, as described in a JSON Patch or a JSON Merge Patch document.

Calls the CRMScript agent service SaveCRMScriptEntity.
<para />## Online Restricted: ## The CRMScript agent is not available in Online by default. Access must be requested specifically when app is registered.

Creates a new CRMScriptEntity

Updates the existing CRMScriptEntity

This will check that the syntax is correct
<para />## Online Restricted: ## The CRMScript agent is not available in Online by default. Access must be requested specifically when app is registered.

Validate a CRMScript.

Gets a default Category list item.

Delete all the items in the Category list.

Marks the existing Category list item as deleted.

Delete all headings for the Category list.

Gets all the Category items

Gets a Category  item by id.

Gets headings for the Category list.

Gets headings for the Category list's item.

Gets user groups visible for the Category list's item.

Gets description of Category list

Get the MDO list items for "Category" - with headings and filtering by user group.

Add a new Category to the list.

Saves a new heading for the Category list.

Update the Category list

Updates an existing Category list item.

Saves headings for the Category list.

Saves headings for the Category list's item.

Saves user groups visible for the Category list's item.

Save the description of Category list

Get the chat presence status for all chat users

Save the chat presence for specified users

If the session is not being transferred, nothing happens.

Accept the transfer: assign the session to the user.

Add a new message to a chat session

Members means that you have at least one of: Can Respond, Notifications, Listen or Manager

Get all chat sessions which this user is a member of.

NetServer calculates default values on the entity, which is required when creating/storing a new instance Calls the Chat agent service CreateDefaultChatSessionEntity.

SuperOffice integration connector

Managed authentication

Execute SuperOffice operations on behalf of your customers

Add a new field to the current AppointmentEntity user-defined field layout.

Deletes the AppointmentEntity

Change a AppointmentEntity user-defined field's type based on the prog-id or label.

Delete a AppointmentEntity user-defined field's details based on the prog-id or label.

Set default values into a new AppointmentEntity.

Is the UDef Layout changed? This may or may not involve moving data (which takes longer).

Try our AI-powered integration development environment for free

SuperOffice integration connector

Managed authentication

Execute SuperOffice operations on behalf of your customersself.__wrap_n!=1&&self.__wrap_b(":r1:",1)

Add a new field to the current AppointmentEntity user-defined field layout.

Deletes the AppointmentEntity

Change a AppointmentEntity user-defined field's type based on the prog-id or label.

Delete a AppointmentEntity user-defined field's details based on the prog-id or label.

Set default values into a new AppointmentEntity.

Is the UDef Layout changed? This may or may not involve moving data (which takes longer).

Try our AI-powered integration development environment for free

Execute SuperOffice operations on behalf of your customers