GET /config/flow_sources/custom_properties/calculated_properties/{calculated_property_id}/dependents/disable

Retrieves the objects that depend on the flow calculated property.

Table 1. GET /config/flow_sources/custom_properties/calculated_properties/{calculated_property_id}/dependents/disable resource details
MIME Type
application/json

Table 2. GET /config/flow_sources/custom_properties/calculated_properties/{calculated_property_id}/dependents/disable request parameter details
Parameter	Type	Optionality	Data Type	MIME Type	Description
calculated_property_id	path	Required	String	text/plain	null
fields	query	Optional	String	text/plain	Optional - Use this parameter to specify which fields you would like to get back in the response. Fields that are not named are excluded. Specify subfields in brackets and multiple fields in the same object are separated by commas.

Table 3. GET /config/flow_sources/custom_properties/calculated_properties/{calculated_property_id}/dependents/disable response codes
HTTP Response Code	Unique Code	Description
202		The flow Calculated property dependents retrieval was accepted and is in progress.
403	1009	The user does not have the required authorization to start the task for finding dependents of CALCULATED flow property.
404	1002	The requested CALCULATED flow property cannot be found.
422	1005	One or more parameters are invalid in the request.
500	1020	An error occurred during the attempt to initiate the AQL flow property dependents retrieval task.

Response Description

A Dependents Task Status object and the location header set to the task status URL "/api/config/flow_sources/custom_properties/calculated_property_disabling_dependents_tasks/{task_id}". A Dependent Task Status object contains the following fields:

id - Long - The ID of the task.
message - String - The localized task message.
status - String - The current state of the task.
name - String - The name of the task.
created_by - String - The name of the user who started the task.
cancelled_by - String - The name of the user who requested to cancel the task.
created - Long - The time in milliseconds since epoch since the task was created.
started - Long - The time in milliseconds since epoch since the task was started.
modified - Long - The time in milliseconds since epoch since the task was modified.
completed - Long - The time in milliseconds since epoch since the task was completed.
number_of_dependents - Long - The number of dependents found. The value is null until the task completes.
maximum - Long - The maximum number of objects to check for dependency.
progress - Long - The number of objects that were checked for dependency.
task_components - Array - An array of task component objects. A task component object contains the following fields:
- message - String - The localized sub-task status message.
- status - String - The current state of the sub-task.
- sub_task_type - String - The type of the sub-task
- maximum - Long - The maximum number of objects to check for dependency.
- progress - Long - The number of objects that were checked for dependency.
- created - Long - The time in milliseconds since epoch since the sub-task was created.
- started - Long - The time in milliseconds since epoch since the sub-task was started.
- modified - Long - The time in milliseconds since epoch since the sub-task was modified.
- completed - Long - The time in milliseconds since epoch since the sub-task was completed.

Response Sample


{
    "cancelled_by": "String",
    "completed": 42,
    "created": 42,
    "created_by": "String",
    "id": 42,
    "maximum": 42,
    "message": "String",
    "modified": 42,
    "name": "String",
    "number_of_dependents": 42,
    "progress": 42,
    "started": 42,
    "status": "String <one of: CANCELLED, CANCELING, CANCEL_REQUESTED, COMPLETED, CONFLICT, EXCEPTION, INITIALIZING, INTERRUPTED, PAUSED, PROCESSING, QUEUED, RESUMING>",
    "task_components": [
        {
            "completed": 42,
            "created": 42,
            "maximum": 42,
            "message": "String",
            "modified": 42,
            "number_of_dependents": 42,
            "progress": 42,
            "started": 42,
            "status": "String <one of: CANCELLED, CANCELING, CANCEL_REQUESTED, COMPLETED, CONFLICT, EXCEPTION, INITIALIZING, INTERRUPTED, PAUSED, PROCESSING, QUEUED, RESUMING>",
            "task_sub_type": "String <one of: FIND_DEPENDENT_ARIEL_SAVED_SEARCHES, FIND_DEPENDENT_OFFENSE_SAVED_SEARCHES, FIND_DEPENDENT_ASSET_SAVED_SEARCHES, FIND_DEPENDENT_VULNERABILITY_SAVED_SEARCHES, FIND_DEPENDENT_ADE_RULES, FIND_DEPENDENT_RULES, FIND_DEPENDENT_CALCULATED_PROPERTIES, FIND_DEPENDENT_AQL_PROPERTIES, FIND_DEPENDENT_LOG_SOURCE_GROUPS, FIND_DEPENDENT_CUSTOM_PROPERTIES, FIND_DEPENDENT_REPORTS, FIND_DEPENDENT_DASHBOARDS, FIND_DEPENDENT_STORE_AND_FORWARD_POLOCIES, FIND_DEPENDENT_AUTHORIZED_SERVICES, FIND_DEPENDENT_OFFENSE_TYPES, FIND_DEPENDENT_ASSIGNED_OFFENSES, FIND_DEPENDENT_VULNERABILITIES, FIND_DEPENDENT_GROUPS, FIND_DEPENDENT_HISTORICAL_CORRELATION_PROFILES, FIND_DEPENDENT_SECURITY_PROFILES, FIND_DEPENDENT_ARIEL_INDEXING, FIND_DEPENDENT_DOMAIN, FIND_DEPENDENT_NAMED_SERVICES, FIND_DEPENDENT_FORWARDING_PROFILE>"
        }
    ]
}