#Supported APIs

The following sections list the supported APIs.

#POST api/connector/SubmitRecords

Submit records to AvePoint Opus. You need to download the JSON file of each connection from Settings > Connector to prepare the record information. You can only submit up to 15 records at a time.

Example

{ "id": " ",
"confilictOption": "Overwrite",
"data": [
    {
    "rowKey": "SingleText",
    "leafName": "SingleText",
    "termFullPath": "Taxonomy",
    "timeCreated": "DateTime",
    "timeModified": "DateTime",
    "createdBy": "SingleText",
    "modifiedBy": "SingleText",
    "_Multiple_%20_Text_%20_Column": "MultipleText",
    "_DateTime_%20_Column": "DateTime",
    "_Single_%20_Choice_%20_Column": "SingleChoice",
    "_Multiple_%20_Choice_%20_Column": "MultipleChoice",
    "_People_%20_or_%20_Group_%20_Column": "PeopleOrGroup",
    "_Number_%20_Column": "Number"
    }     
    ] 
    }

Request Information

AvePoint Opus supports creating custom columns of different types to meet your requirements for variable record properties. When submitting records with custom columns, enter the internal name of each custom column you have defined in the connection. Values of custom columns are optional. For details, refer to Create a Connection.

• For the Single line of text type of column, value should be a single line of text.

• For the Multiple lines of text type of column, value should be multiple lines of text.

• For the Date and Time type of column, value should be a date and/or time.

• For the Choice (single selection) type of column, value should be the numerical order of the correct option, not the option name.

• For the Choice (multiple selections) type of column, value should be the numerical orders of the correct options separated by commas in square brackets.

• For the Person or Group type of column, value should be the full email address of users and/or groups separated by commas in square brackets. If the user or group does not exist in AvePoint Opus, AvePoint Opus will query it in the Microsoft Entra that is authorized via the app profile in AvePoint Online Services.

• For the Number type of column, value should be a number.

Response Information

#POST api/connector/GetDueRecords

Retrieve the records whose disposed due date is earlier than the specified time.

Example

{id: " ",
disposalDueDate: 2024-04-01 00:59:34,
startIndex: "",
itemsPerPage: 15}

Request Information

Response Information

#POST api/connector/DisposeRecords

Update the status of records as Destroyed in AvePoint Opus. You can only update the status for up to 15 records at a time. If manual approval is enabled, after record reviewers approve or reject the records, you can use this API to update the status of the approved records as Destroyed in AvePoint Opus.

Example

{disposalIds: ["Item RowKey1","Item RowKey2"]}

Request Information

Response Information