Jump to

• Request
• Response
• Examples

Update Crawl Configuration

put

/api/20210901/system/searchIndex/actions/updateCrawlConfig

Update crawl configuration properties using a valid key and value. Currently, Oracle Analytics Cloud supports a single configuration property: DatamodelCrawlUser.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

An object representing the update payload for the crawl configuration.

Show Source

• items: array items

{
    "type":"object",
    "description":"An object representing the update payload for the crawl configuration.",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CrawlConfigItem"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object CrawlConfigItem
  An object which represents a crawl configuration property.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/CrawlConfigItem"
    }
}

Nested Schema : CrawlConfigItem

Type: object

An object which represents a crawl configuration property.

Show Source

• description: string
  A description of the key property.
• displayName(required): string
  The display name for the key property. For example, if the key is DatamodelCrawlUser, this is the display name of the user account that runs the data model crawl.
• key(required): string
  Allowed Values: [ "DatamodelCrawlUser" ]

  The search crawl configuration property to update. For example, DatamodelCrawlUser.
• value(required): string
  The value for the key property. For example, if the key is DatamodelCrawlUser, this is the user identifier used to run the data model crawl.

{
    "description":"An object which represents a crawl configuration property.",
    "type":"object",
    "properties":{
        "key":{
            "type":"string",
            "description":"The search crawl configuration property to update. For example, DatamodelCrawlUser.",
            "enum":[
                "DatamodelCrawlUser"
            ]
        },
        "value":{
            "type":"string",
            "description":"The value for the key property. For example, if the key is DatamodelCrawlUser, this is the user identifier used to run the data model crawl."
        },
        "displayName":{
            "type":"string",
            "description":"The display name for the key property. For example, if the key is DatamodelCrawlUser, this is the display name of the user account that runs the data model crawl."
        },
        "description":{
            "type":"string",
            "description":"A description of the key property."
        }
    },
    "required":[
        "key",
        "value",
        "displayName"
    ]
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Crawl configuration update complete. Response contains the success or failure status for each item.

Body ()

Root Schema : CrawlConfigUpdateResponse

Type: object

Show Source

• results: array results

{
    "type":"object",
    "properties":{
        "results":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "key":{
                        "type":"string"
                    },
                    "status":{
                        "type":"string"
                    }
                }
            }
        }
    }
}

Nested Schema : results

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "key":{
                "type":"string"
            },
            "status":{
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• key: string
• status: string

{
    "type":"object",
    "properties":{
        "key":{
            "type":"string"
        },
        "status":{
            "type":"string"
        }
    }
}

400 Response

Bad Request (invalid query parameters, malformed headers, and so on).

Body ()

Root Schema : Error

Type: object

Show Source

• code(required): string
  Short error code that defines the error, meant for programmatic parsing.
• message(required): string
  Human-readable error string.

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Short error code that defines the error, meant for programmatic parsing.\n"
        },
        "message":{
            "type":"string",
            "description":"Human-readable error string.\n"
        }
    },
    "required":[
        "code",
        "message"
    ]
}

401 Response

Unauthorized (missing or expired credentials, and so on).

Body ()

Root Schema : Error

Type: object

Show Source

• code(required): string
  Short error code that defines the error, meant for programmatic parsing.
• message(required): string
  Human-readable error string.

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Short error code that defines the error, meant for programmatic parsing.\n"
        },
        "message":{
            "type":"string",
            "description":"Human-readable error string.\n"
        }
    },
    "required":[
        "code",
        "message"
    ]
}

403 Response

Forbidden (missing permissions for operation, request denied for unspecified reason, and so on).

Body ()

Root Schema : Error

Type: object

Show Source

• code(required): string
  Short error code that defines the error, meant for programmatic parsing.
• message(required): string
  Human-readable error string.

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Short error code that defines the error, meant for programmatic parsing.\n"
        },
        "message":{
            "type":"string",
            "description":"Human-readable error string.\n"
        }
    },
    "required":[
        "code",
        "message"
    ]
}

409 Response

Conflict (operation results in constraint violation, the operation is incompatible with the current state, and so on).

Body ()

Root Schema : Error

Type: object

Show Source

• code(required): string
  Short error code that defines the error, meant for programmatic parsing.
• message(required): string
  Human-readable error string.

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Short error code that defines the error, meant for programmatic parsing.\n"
        },
        "message":{
            "type":"string",
            "description":"Human-readable error string.\n"
        }
    },
    "required":[
        "code",
        "message"
    ]
}

500 Response

Internal Server Error. The server encountered an unexpected condition preventing fulfilment of the request.

Body ()

Root Schema : Error

Type: object

Show Source

• code(required): string
  Short error code that defines the error, meant for programmatic parsing.
• message(required): string
  Human-readable error string.

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Short error code that defines the error, meant for programmatic parsing.\n"
        },
        "message":{
            "type":"string",
            "description":"Human-readable error string.\n"
        }
    },
    "required":[
        "code",
        "message"
    ]
}

Back to Top

Examples

In this example, you update the user account that crawls the data model. The crawl configuration key is DatamodelCrawlUser.

cURL Example:

curl -i \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --request PUT \
  --data '{
    "items": [
      {
        "key": "DatamodelCrawlUser",
        "value": "[e-mail]",
        "displayName": "Jane Doe",
        "description": "User account used to crawl the data model."
      }
    ]
  }' \
  'https://<hostname>/api/20210901/system/searchIndex/actions/updateCrawlConfig'

Example of Request Body

{
  "items": [
    {
      "key": "DatamodelCrawlUser",
      "value": "[e-mail]",
      "displayName": "Jane Doe",
      "description": "User account used to crawl the data model."
    }
  ]
}

Example of Request Header

Not applicable.

Example of Response Body

{
  "results": [
    {
      "key": "DatamodelCrawlUser",
      "status": "SUCCESS"
    }
  ]
}

Back to Top