Field | Required | Default | Multiple | Notes | Example |
---|---|---|---|---|---|
type | Yes | - | No | The value must be "group-expansion". | "group-expansion" |
description | Yes | - | No | Name of the connection object. | "MyGroupExpansionConnection" |
throttlePolicy | No | - | No | Id of the throttle policy that applies to this connection object. | "f5587cee-9116-4011-b3a9-6b235b333a1b" |
routingPolicies | No | [ ] | Yes | The ids of the routing policies that this connection will use. | ["313de87c-3cb9-4fe0-a2cb-17f75ce7d0c7", "b4d2579f-1a0a-4a8b-9fd4-d42780003b36"] |
Code Block | ||||
---|---|---|---|---|
| ||||
{ "type": "group-expansion", "description": "MyGroupExpansionConnection", } |
Field | Required | Default | Multiple | Notes | Example |
---|---|---|---|---|---|
id | Yes | - | No | Id of the connection to update | "89d6632a-a296-426c-adb0-d442adcab4b0", |
description | Yes | - | No | Name of the connection object. | "MyGroupExpansionConnection" |
throttlePolicy | No | - | No | Id of the throttle policy that applies to this connection object. | "f5587cee-9116-4011-b3a9-6b235b333a1b" |
routingPolicies | No | [ ] | Yes | The ids of the routing policies that this connection will use. | ["313de87c-3cb9-4fe0-a2cb-17f75ce7d0c7", "b4d2579f-1a0a-4a8b-9fd4-d42780003b36"] |
Code Block | ||||
---|---|---|---|---|
| ||||
{ "id": "89d6632a-a296-426c-adb0-d442adcab4b0", "description": "MyGroupExpansionConnection", } |
Field |
---|
Required | Default | Multiple | Notes | Example |
---|---|---|---|---|
seed |
Yes | - | No | Put a placeholder here | "seed_placeholder" |
type |
Yes | - | No | The value must be "group-expansion". | "group-expansion" |
description |
Yes | - | No | Name of the seed object. | "MyGroupExpansionSeed" |
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 |
No | [ ] | Yes | The ids of the workflows that will be executed for the documents crawled. | ["f8c414cb-1f5d-42ef-9cc9-5696c3f0bda4"] |
throttlePolicy |
No | - | No | Id of the throttle policy that applies to this seed object. | "f5587cee-9116-4011-b3a9-6b235b333a1b" |
routingPolicies |
No | [ ] | Yes | The ids of the routing policies that this seed will use. | ["313de87c-3cb9-4fe0-a2cb-17f75ce7d0c7", "b4d2579f-1a0a-4a8b-9fd4-d42780003b36"] |
tags |
No | [ ] | Yes | The tags of the seed. These can be used to filter the seed | ["tag1", "tag2"] |
properties |
---|
No | - | No | Configuration object | |
---|---|---|---|---|
seedsIncluded |
No | - | yes | Those seeds will be included in crawling identities | ["5b9f4074-01a3-4d86-8642-32a6f27179d4"] |
seedsExcluded |
No | - | yes | Those seeds will be excluded from crawling identities | ["5b9f4074-01a3-4d86-8642-32a6f27179d4"] |
seedsIdentities local |
---|
No | - | yes | Custom mapping local | |
---|---|---|---|---|
id |
Yes | - | no | The seed id for the mapping | "5b9f4074-01a3-4d86-8642-32a6f27179d4" |
identityKeyType |
Yes | - | no | The value must be "local" | "local" |
identityKeyAttr |
Yes | - | no | The name of the mapping attribute | "someAttributeName" |
seedsIdentities external |
---|
No | - | yes | Custom mapping external | |
---|---|---|---|---|
id |
Yes | - | no | The seed id for the mapping | "5b9f4074-01a3-4d86-8642-32a6f27179d4" |
identityKeyType |
Yes | - | no | The value must be "external" | "external" |
identityKeyAttr |
Yes | - | no | The name of the mapping attribute in external seed | "someAttributeName" |
externalSeed |
Yes | - | no | The external seed id | "5b9f4074-01a3-4d86-8642-32a6f27179d4" |
externalLookupAttribute |
Yes | - | no | The external lookup attribute name | "externalLookupAttrName" |
Code Block | ||||
---|---|---|---|---|
| ||||
{ "type": "group-expansion", "seed": "seed_placeholder", "connector": "82f7f0a4-8d28-47ce-8c9d-e3ca414b0d31", "description": "GroupExpansion_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": { "seedsIncluded": [ "5b9f4074-01a3-4d86-8642-32a6f27179d4" ], "seedsExcluded": [], "seedsIdentities": [ { "id": "5b9f4074-01a3-4d86-8642-32a6f27179d4", "identityKeyType": "local", "identityKeyAttr": "someAttrName" } ] } } |
Field | OptionalRequired | Default | Multiple | Notes | Example |
---|---|---|---|---|---|
id | NoYes | - | No | Id of the seed to update | "2f287669-d163-4e35-ad17-6bbfe9df3778" |
(see the "Create seed" for other fields) |
Code Block | ||||
---|---|---|---|---|
| ||||
{ "id": "2f287669-d163-4e35-ad17-6bbfe9df3778", "connector": "82f7f0a4-8d28-47ce-8c9d-e3ca414b0d31", "description": "FileSystem_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": { "seedsIncluded": [ "5b9f4074-01a3-4d86-8642-32a6f27179d4" ], "seedsExcluded": [], "seedsIdentities": [ { "id": "5b9f4074-01a3-4d86-8642-32a6f27179d4", "identityKeyType": "local", "identityKeyAttr": "someAttrName" } ] } } |
...