Create Credential
We support these authentication types of crawled repositories:
- Basic - see here
- Bearer - see here
- API Token - can be used as an alternative for Bearer. It is about sending configured header field as a part of each request
- None
| Field | Required | Default | Multiple | Notes | Example |
|---|---|---|---|---|---|
| type | Yes | - | No | The value must be "rest-api". | "rest-api" |
| description | Yes | - | No | Name of the credential object. | "My REST Credential" |
| properties | Yes | - | No | Configuration object | |
| type | yes | - | No | Authentication type: basic, apiToken, bearer, none, | basic |
| type: basic | |||||
| loginAccount | Yes | - | No | User name. | "admin" |
| password | Yes | - | No | Password (can be encrypted in Aspire fashion) | "adminPassword" |
| type: apiToken | |||||
| headerName | yes | - | No | The name of HTTP header field to be sent with a request | "tokenName1" |
| headerValue | yes | - | No | The value of the "headerName" field | "tokenValue1" |
| type: bearer | |||||
| preExpirationLimitInMs | Yes | 0 | No | Pre expiration limit. The time (in ms) used for calculating when to ask for the new accessToken | 5000 |
| query | yes | - | No | JSON object representing the query to be sent for getting the accessToken | |
| urlTemplate | yes | - | No | The context path of the URL | "/login" |
| method | yes | - | No | HTTP method. Must be POST in this version | "POST" |
| body | yes | - | No | The query body. Fields ${loginAccount}, ${password} are expected to be used as a part of the body. | "{"username" : "${loginAccount}","password" : "${password}"}" |
| queryType | yes | - | No | Use the value "metadataExtraction" here | "metadataExtraction" |
| resultField | yes | - | No | The field in the response with the access token | "accessToken" |
| loginAccount | Yes | - | No | User name. Used as a value for ${loginAccount} query body field | "admin" |
| password | Yes | - | No | Password. Used as a value for ${password} query body field | "adminPassword" |
Example
POST aspire/_api/credentials
{
"type": "rest-api",
"description": "My credential",
"properties": {
"type": "bearer",
"query": {
"urlTemplate": "/login",
"method": "POST",
"body": "{\"username\" : \"${username}\",\"password\" : \"${password}\"}",
"queryType": "metadataExtraction",
"resultField": "accessToken"
"username": "admin",
"password": "encrypted:xxxxx",
}
}
}
Create Connection
| Field | Required | Default | Multiple | Notes | Example |
|---|---|---|---|---|---|
| type | Yes | - | No | The value must be "rest-api". | "rest-api" |
| description | Yes | - | No | Name of the connection object. | "My REST Connection" |
| throttlePolicy | No | - | No | Id of the throttle policy that applies to this connection object. | "6b235b333a1b" |
| routingPolicies | No | [ ] | Yes | The ids of the routing policies that this connection will use. | ["17f75ce7d0c7", "d42780003b36"] |
| credential | Yes | - | No | Id of the credential | "6b235b333a1b" |
| properties | Yes | - | No | Configuration object | |
| baseUrl | Yes | - | No | Your rest service API url | "https://your-service/api/v2/" |
| trustAllCertificates | Yes | false | No | If selected, no HTTPS certificate validation will be done. | true |
Example
POST aspire/_api/connections
{
"type": "rest-api",
"description": "Rest conn 3",
"credential": "0b6fd9c8-d722-4874-aca1-e57c6eff2089",
"properties": {
"baseUrl": "http://aspire_manager:50443/aspire/_api"
}
}
Update Connection
| Field | Required | Default | Multiple | Notes | Example |
|---|---|---|---|---|---|
| id | Yes | - | No | Id of the connection to update | "d442adcab4b0", |
| description | No | - | No | Name of the connection object. | "My REST Connection" |
| throttlePolicy | No | - | No | Id of the throttle policy that applies to this connection object. | "b3a9-6b235b333a1b" |
| routingPolicies | No | [ ] | Yes | The ids of the routing policies that this connection will use. | ["17f75ce7d0c7", "d42780003b36"] |
| credential | No | - | No | Id of the credential | "6b235b333a1b" |
| properties | No | - | No | Configuration object | |
| (see create connection) |
Example
PUT aspire/_api/connections/89d6632a-a296-426c-adb0-d442adcab4b0
{
"id": "89d6632a-a296-426c-adb0-d442adcab4b0",
"description": "REST connection",
"properties": {
"baseUrl": "http://aspire_manager:50443/aspire/_api"
}
}
Create Seed
| Field | Required | Default | Multiple | Notes | Example |
|---|---|---|---|---|---|
| seed | Yes | - | No | The name of the database. It will replace the marker {DATABASE} used in the field jdbcUrl of connection object | "test_db" |
| type | Yes | - | No | The value must be "rdb-snapshot". | "rdb-snapshot" |
| description | Yes | - | No | Name of the seed object. | "My RDB Seed" |
| connector | Yes | - | No | The id of the connector to be used with this seed. The connector type must match the seed type. | "e3ca414b0d31" |
| connection | Yes | - | No | The id of the connection to be used with this seed. The connection type must match the seed type. | "e4a663fe9ee6" |
| workflows | No | [ ] | Yes | The ids of the workflows that will be executed for the documents crawled. | ["5696c3f0bda4"] |
| throttlePolicy | No | - | No | Id of the throttle policy that applies to this seed object. | "6b235b333a1b" |
| routingPolicies | No | [ ] | Yes | The ids of the routing policies that this seed will use. | ["17f75ce7d0c7", "d42780003b36"] |
| tags | No | [ ] | Yes | The tags of the seed. These can be used to filter the seed | ["tag1", "tag2"] |
| properties | Yes | - | No | Configuration object | |
| fullSQL | Yes (this or discoverySQL + extractionSQL) | - | No | The "SELECT" query to be run to retrieve all documents. This query is used for full or incremental scans. The "WHERE" clause can be used to specify any required condition for crawling the desired documents. Any change to any column selected in this SQL will cause the document to be re-indexed. For example "SELECT idCol, col1, col2, col3 FROM data_table" When slicing is enabled, add a "WHERE" clause containing "{SLICES}". For example "SELECT idCol, col1, col2, col3 FROM data_table WHERE {SLICES}" . | "SELECT * FROM table" |
| discoverySQL | Yes (this or fullSQL) | - | No | The "SELECT" query to run for discovering documents. This query is used for full or incremental scans. A "WHERE" clause can be used to specify any required condition for crawling the desired documents. A change to any column selected in this SQL will cause the document to be re-indexed. For example: "SELECT idCol, lastModifiedDate FROM data_table". When slicing is enabled, add a "WHERE" clause containing "{SLICES}". For example: "SELECT idCol, col1 FROM data_table WHERE {SLICES} | "SELECT id, lastModified FROM table" |
| extractionSQL | Yes (this or fullSQL) | - | No | "SELECT" query for extracting all data for each document found in the Discovery SQL. At the least, you MUST include a "WHERE" clause containing the expression "idColumnName IN {IDS}", where idColumnName corresponds to a unique key field name. {IDS} is replaced automatically by the connector with the corresponding unique key values. For example: "SELECT col1, col2, col3 FROM data_table WHERE idCol in {IDS}" You must not include the {SLICES} condition here. | "SELECT * FROM table WHERE id IN {IDS}" |
| idColumn | Yes | - | No | The column name that holds the unique key. The default name of the column which holds the value to use as the document id. This column must be present in both discoverySQL and extractionSQL. SQL aliases are NOT supported. | "id" |
| stringIdColumn | No | false | No | Check if the unique key is a string value | true |
| quoteId | No | doNotQuote | No | Quote id column - use if you have a name clashing with RDBMS keywords. You can use one of the values: doNotQuote, `, " | doNotQuote |
| ACL | |||||
| aclColumn | Yes (aclColumn or aclSQL) | - | No | The column name that holds the ACLs. Each ACL must be separated by semi-colons and must follow this format: my-domain\userOrGroup@NT | "acl" |
| aclSQL | Yes (aclColumn or aclSQL) | - | No | The query to use for extracting and building ACLs. This query depends of the Database engine, so the syntax could vary. For example on Oracle: SELECT 'my-domain\\' || user || '@NT;' FROM myTable | "SELECT * FROM table_acl" |
Example
POST aspire/_api/seeds
{
"seed":"test_db",
"type":"rdb-snapshot",
"description" : "RDB_TEST",
"properties" : {
"idColumn" : "film_id",
"stringIdColumn" : false,
"aclSQL" : null,
"aclColumn" : "acl",
"quoteId" : "doNotQuote",
"discoverySQL" : "SELECT film_id, title FROM film",
"extractionSQL" : "SELECT * FROM film WHERE film_id IN {IDS}",
"fullSQL" : null"
}
}
Update Seed
| Field | Required | Default | Multiple | Notes | Example |
|---|---|---|---|---|---|
| id | Yes | - | No | Id of the seed to update | "2f287669-d163-4e35-ad17-6bbfe9df3778" |
| (see the "Create seed" for other fields) |
Example
PUT aspire/_api/seeds/2f287669-d163-4e35-ad17-6bbfe9df3778
{
"id": "2f287669-d163-4e35-ad17-6bbfe9df3778",
"seed":"test_db",
"description" : "RDB_TEST",
"properties" : {
"idColumn" : "film_id",
"stringIdColumn" : false,
"aclSQL" : null,
"aclColumn" : "acl",
"quoteId" : "doNotQuote",
"discoverySQL" : "SELECT film_id, title FROM film",
"extractionSQL" : "SELECT * FROM film WHERE film_id IN {IDS}",
"fullSQL" : null"
}
}
Overview
Content Tools
Copyright © 2024 Accenture
