Create Connection
Field | Optional | Default | Multiple | Notes | Example |
|---|---|---|---|---|---|
| type | No | - | No | The value must be "<connector>". | "<connector>" |
| description | No | - | No | Name of the connection object. | "My<connector>Connection" |
| throttlePolicy | Yes | - | No | Id of the throttle policy that applies to this connection object. | "f5587cee-9116-4011-b3a9-6b235b333a1b" |
| routingPolicies | Yes | [ ] | Yes | The ids of the routing policies that this connection will use. | ["313de87c-3cb9-4fe0-a2cb-17f75ce7d0c7", "b4d2579f-1a0a-4a8b-9fd4-d42780003b36"] |
| properties | No | - | No | Configuration object | |
Example
POST aspire/_api/connections
{
"type": "<connector>",
"description": "<connector> Test Connector",
"properties": {
}
}
Update Connection
Field | Optional | Default | Multiple | Notes | Example |
|---|---|---|---|---|---|
| id | No | - | No | Id of the connection to update | "89d6632a-a296-426c-adb0-d442adcab4b0", |
| description | Yes | - | No | Name of the connection object. | "MyAspiderConnection" |
| throttlePolicy | Yes | - | No | Id of the throttle policy that applies to this connection object. | "f5587cee-9116-4011-b3a9-6b235b333a1b" |
| routingPolicies | Yes | [ ] | Yes | The ids of the routing policies that this connection will use. | ["313de87c-3cb9-4fe0-a2cb-17f75ce7d0c7", "b4d2579f-1a0a-4a8b-9fd4-d42780003b36"] |
| properties | No | - | No | Configuration object | |
Example
PUT aspire/_api/connections/89d6632a-a296-426c-adb0-d442adcab4b0
{
"id": "89d6632a-a296-426c-adb0-d442adcab4b0",
"description": "<connector> Test Connector",
"properties": {
}
}
Create Seed
Field | Optional | Default | Multiple | Notes | Example |
|---|---|---|---|---|---|
| seed | No | - | No | <seed description> | |
| type | No | - | No | The value must be "<connector>". | "<connector>" |
| description | No | - | No | Name of the seed object. | "My<connector>Seed" |
| connector | No | - | No | The id of the connector to be used with this seed. The connector type must match the seed type. | "82f7f0a4-8d28-47ce-8c9d-e3ca414b0d31" |
| connection | No | - | No | The id of the connection to be used with this seed. The connection type must match the seed type. | "602d3700-28dd-4a6a-8b51-e4a663fe9ee6" |
| workflows | Yes | [ ] | Yes | The ids of the workflows that will be executed for the documents crawled. | ["f8c414cb-1f5d-42ef-9cc9-5696c3f0bda4"] |
| throttlePolicy | Yes | - | No | Id of the throttle policy that applies to this connection object. | "f5587cee-9116-4011-b3a9-6b235b333a1b" |
| routingPolicies | Yes | [ ] | Yes | The ids of the routing policies that this seed will use. | ["313de87c-3cb9-4fe0-a2cb-17f75ce7d0c7", "b4d2579f-1a0a-4a8b-9fd4-d42780003b36"] |
| tags | Yes | [ ] | Yes | The tags of the seed. These can be used to filter the seed | ["tag1", "tag2"] |
| properties | No | - | No | Configuration object | |
Example
POST aspire/_api/seeds
{
"type": "<connector>",
"seed": "directory",
"connector": "82f7f0a4-8d28-47ce-8c9d-e3ca414b0d31",
"description": "<connector>_Test_Seed",
"throttlePolicy": "6b8b5f23-fc77-47a1-9b58-106577162e7b",
"routingPolicies": ["313de87c-3cb9-4fe0-a2cb-17f75ce7d0c7", "b4d2579f-1a0a-4a8b-9fd4-d42780003b36"],
"connection": "602d3700-28dd-4a6a-8b51-e4a663fe9ee6",
"workflows": ["f8c414cb-1f5d-42ef-9cc9-5696c3f0bda4"],
"tags": ["tag1", "tag2"],
"properties": {
}
}
Update Seed
Field | Optional | Default | Multiple | Notes | Example |
|---|---|---|---|---|---|
| id | No | - | No | Id of the seed to update. | "2f287669-d163-4e35-ad17-6bbfe9df3778" |
| seed | Yes | - | No | <seed description> | |
| description | Yes | - | No | Name of the seed object. | "My<connector>Seed" |
| connector | Yes | - | No | The id of the connector to be used with this seed. The connector type must match the seed type. | "82f7f0a4-8d28-47ce-8c9d-e3ca414b0d31" |
| connection | Yes | - | No | The id of the connection to be used with this seed. The connection type must match the seed type. | "602d3700-28dd-4a6a-8b51-e4a663fe9ee6" |
| workflows | Yes | [ ] | Yes | The ids of the workflows that will be executed for the documents crawled. | ["f8c414cb-1f5d-42ef-9cc9-5696c3f0bda4"] |
| workflows.add | Yes | [ ] | Yes | The ids of the workflows to add. | ["f8c414cb-1f5d-42ef-9cc9-5696c3f0bda4"] |
| workflows.remove | Yes | [ ] | Yes | The ids of the workflows to remove. | ["f8c414cb-1f5d-42ef-9cc9-5696c3f0bda4"] |
| throttlePolicy | Yes | - | No | Id of the throttle policy that applies to this connection object. | "f5587cee-9116-4011-b3a9-6b235b333a1b" |
| routingPolicies | Yes | [ ] | Yes | The ids of the routing policies that this seed will use. | ["313de87c-3cb9-4fe0-a2cb-17f75ce7d0c7", "b4d2579f-1a0a-4a8b-9fd4-d42780003b36"] |
| routingPolicies.add | Yes | [ ] | Yes | The ids of the routingPolicies to add. | ["b4d2579f-1a0a-4a8b-9fd4-d42780003b36"] |
| routingPolicies.remove | Yes | [ ] | Yes | The ids of the routingPolicies to remove. | ["313de87c-3cb9-4fe0-a2cb-17f75ce7d0c7"] |
| tags | Yes | [ ] | Yes | The tags of the seed. These can be used to filter the seed | ["tag1", "tag3"] |
| tags.add | Yes | [ ] | Yes | The tags to add | ["tag4"] |
| tags.remove | Yes | [ ] | Yes | The tags to remove | ["tag2"] |
| properties | No | - | No | Configuration object | |
Example
PUT aspire/_api/seeds/2f287669-d163-4e35-ad17-6bbfe9df3778
{
"id": "2f287669-d163-4e35-ad17-6bbfe9df3778",
"seed": "<seed example>",
"connector": "82f7f0a4-8d28-47ce-8c9d-e3ca414b0d31",
"description": "<connector>_Test_Seed",
"throttlePolicy": "6b8b5f23-fc77-47a1-9b58-106577162e7b",
"routingPolicies": ["313de87c-3cb9-4fe0-a2cb-17f75ce7d0c7", "b4d2579f-1a0a-4a8b-9fd4-d42780003b36"],
"connection": "602d3700-28dd-4a6a-8b51-e4a663fe9ee6",
"workflows": ["b255e950-1dac-46dc-8f86-1238b2fbdf27", "f8c414cb-1f5d-42ef-9cc9-5696c3f0bda4"],
"tags": ["tag", "tag2"],
"properties": {
}
}
Create Credential
| Field | Optional | Default | Multiple | Notes | Example |
|---|---|---|---|---|---|
| type | No | - | No | The value must be "<connector>". | "<connector>" |
| description | No | - | No | Name of the credential object. | "<connector>Credential" |
| properties | No | - | No | Configuration object | |
Example
POST aspire/_api/credentials
{
"type": "<connector>",
"description": "<connector>Credential",
"properties": {
}
}
Update Credential
| Field | Optional | Default | Multiple | Notes | Example |
|---|---|---|---|---|---|
| id | No | - | No | Id of the credential to update. | "2f287669-d163-4e35-ad17-6bbfe9df3778" |
| description | No | - | No | Name of the credential object. | "<connector>Credential" |
| properties | No | - | No | Configuration object | |
Example
PUT aspire/_api/credentials/2a5ca234-e328-4d40-bb2a-2df3e550b065
{
"id": "2a5ca234-e328-4d40-bb2a-2df3e550b065",
"description": "<connector>Credential",
"properties": {
}
}
Overview
Content Tools
Copyright © 2024 Accenture
