field_descriptor#

Autogenerated API

argus_api.lib.cases.v2.field.field_descriptor.add_field_policy(name: str = None, domain: str = None, customer: str = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Define new field policy. (INTERNAL)

Parameters

  • name (str) – Name of policy to add. => [sw\{\}\$\-\(\).\[\]”'_/\,\*\+\#:@!?;=]*

  • domain (str) – Name or ID of domain to create this policy in.

  • customer (str) – Name or ID of customer to create this policy for (optional).

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.cases.v2.field.field_descriptor.add_field_to_policy(policy: str, domain: str = None, field: str = None, displayName: str = None, fieldPolicy: str = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Bind a field to a policy (INTERNAL)

Parameters

  • policy (str) – ID or name of policy to bind field to

  • domain (str) – Domain to look for policy in (when using policy name for ID). Defaults to the current users domain.

  • field (str) – ID or field name of field to add to policy.

  • displayName (str) – Display name for field. Default is field name. => [a-zA-Z0-9_:\-.]*

  • fieldPolicy (str) – FieldPolicy for this field. If the field is requiredOnCreate, a case cannot be created without this field, unless a defaultValue is set in the field fieldPolicy.If the field is requiredOnClose, the case cannot be closed before this field has been set. Default fieldPolicy is optional.

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.cases.v2.field.field_descriptor.create_field_descriptor(shortName: str = None, name: str = None, localizedNames: dict = None, localizedDescriptions: dict = None, domain: str = None, customer: str = None, valueType: str = None, multiValue: bool = None, defaultValue: str = None, validator: dict = None, valueSource: dict = None, rendererOptions: dict = None, readRole: str = None, writeRole: str = None, hidden: bool = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Define new field descriptor. (INTERNAL)

Parameters

  • shortName (str) – Shortname of field to add. If not specified, it will be set to a lowercase, concatenated shortname based on the name. => [a-zA-Z0-9_:\-.]*

  • name (str) – Name of field to add. => [sw\{\}\$\-\(\).\[\]”'_/\,\*\+\#:@!?;=]*

  • localizedNames (dict) – Localized names. If not set, locales will fallback to main name. => [sw\{\}\$\-\(\).\[\]”'_/\,\*\+\#:@!?;=]*

  • localizedDescriptions (dict) – Localized descriptions. If not set, localizedDescription will return null. => [sw\{\}\$\-\(\).\[\]”'_/\,\*\+\#:@!?;=]*

  • domain (str) – Name or ID of domain to create this field in.

  • customer (str) – Name or ID of customer to create this field for (optional).

  • valueType (str) – Value type for the field.The field will only accept values that can be safely converted to this value type. If the field uses an autocompleter, the autocompleter should convert user input to valid values of this type. Default type is stringType.

  • multiValue (bool) – If multiValue is enabled, this field will accept multiple values of the specified type (optional).

  • defaultValue (str) – The default value to populate this field with. (optional, default is not set).

  • validator (dict) –

  • valueSource (dict) –

  • rendererOptions (dict) – Renderer options. Only for use by the Argus frontend application (optional).

  • readRole (str) – Required service role to read this field. Default is ‘user’, meaning that any user with read access to the case, can also read this field.

  • writeRole (str) – Required service role to set/update this field. Default is ‘user’, meaning that any user with write access to the case, can also write to this field.

  • hidden (bool) – Mark this field as hidden. Hidden fields will not be displayed in the UI. (default false)

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.cases.v2.field.field_descriptor.delete_field_descriptor(field: str, domain: str = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Delete a field descriptor. (INTERNAL)

Parameters

  • field (str) – ID or name of descriptor to delete

  • domain (str) – Domain to look for field in (when using field name for ID). Defaults to the current users domain.

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.cases.v2.field.field_descriptor.delete_field_policy(policy: str, domain: str = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Delete a field policy (INTERNAL)

Parameters

  • policy (str) – ID or name of policy to delete

  • domain (str) – Domain to look for policy in (when using policy name for ID). Defaults to the current users domain.

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.cases.v2.field.field_descriptor.get_field_descriptor(field: str, domain: str = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Fetch field descriptor (INTERNAL)

Parameters

  • field (str) – ID or name of descriptor to fetch

  • domain (str) – Domain to look for field in (when using field name for ID). Defaults to the current users domain.

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.cases.v2.field.field_descriptor.get_field_policy_by_id(policy: str, domain: str = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Fetch policy descriptor by ID. (INTERNAL)

Parameters

  • policy (str) – ID or name of policy to fetch

  • domain (str) – Domain to look for policy in (when using policy name for ID). Defaults to the current users domain.

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.cases.v2.field.field_descriptor.list_field_descriptors(customerID: int = None, domain: str = None, valueType: str = None, field: str = None, policy: str = None, keywords: str = None, sortBy: str = None, limit: int = 25, offset: int = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

List field descriptors. (INTERNAL)

Parameters

  • customerID (list) – Limit result to fields bound to one of these customer IDs

  • domain (list) – Limit result to fields bound to one of these domains (by ID or name)

  • valueType (list) – Limit result to fields with one of these valueTypes

  • field (list) – Limit result to one of these fields (by ID or name)

  • policy (list) – Limit result to fields bound to one of these field policies (by ID or name)

  • keywords (list) – Limit result to fields matching one of these keywords

  • sortBy (list) – Sort order (see /cases/v2/field/descriptor/search documentation for details)

  • limit (int) – Maximum number of returned results

  • offset (int) – Skip a number of results

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.cases.v2.field.field_descriptor.list_field_policies(customerID: int = None, domain: str = None, keywords: str = None, sortBy: str = None, limit: int = 25, offset: int = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

List field policies (INTERNAL)

Parameters

  • customerID (list) – Limit result to fields bound to one of these customer IDs

  • domain (list) – Limit result to fields bound to one of these domains (ID or name)

  • keywords (list) – Limit result to fields matching one of these keywords

  • sortBy (list) – Sort order (see /cases/v2/field/policy/search documentation for details)

  • limit (int) – Maximum number of returned results

  • offset (int) – Skip a number of results

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.cases.v2.field.field_descriptor.list_field_source_values(field: str, caseID: int = None, service: str = None, customer: str = None, domain: str = None, keywords: str = None, limit: int = 25, offset: int = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

List define source values for a field. Fields may have a defined value source for available values, which can be used to select valid values to set on the field. This endpoint returns and filters the values from the defined data source. (INTERNAL)

Parameters

  • field (str) – ID or name of field to fetch values for

  • caseID (int) – ID for case to list field values for

  • service (str) – ID or shortname of service to list field values for

  • customer (str) – ID or shortname of customer to list field values for

  • domain (str) – ID or name of domain for looking up service and customer. Defaults to the current users domain

  • keywords (list) – Keyword to filter returned values by

  • limit (int) – Maximum number of returned results

  • offset (int) – Skip a number of results

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.cases.v2.field.field_descriptor.remove_field_from_policy(policy: str, field: str, domain: str = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Unbind a field from a policy. (INTERNAL)

Parameters

  • policy (str) – ID or name of policy to bind field to

  • field (str) – ID or name of field to unbind

  • domain (str) – Domain to look for policy in (when using policy name for ID). Defaults to the current users domain.

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.cases.v2.field.field_descriptor.search_field_descriptors(limit: int = None, offset: int = None, includeDeleted: bool = None, subCriteria: dict = None, exclude: bool = None, required: bool = None, customerID: int = None, field: str = None, domain: str = None, service: str = None, policy: str = None, availableForCaseID: int = None, valueType: str = None, startTimestamp: int = None, endTimestamp: int = None, keywords: str = None, timeFieldStrategy: str = None, timeMatchStrategy: str = None, keywordFieldStrategy: str = None, keywordMatchStrategy: str = None, user: str = None, userID: int = None, userFieldStrategy: str = None, sortBy: str = None, includeFlags: str = None, excludeFlags: str = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Search field descriptors. (INTERNAL)

Parameters

  • limit (int) – Max number of results.

  • offset (int) – Skip the first (offset) objects. By default, return result from first object.

  • includeDeleted (bool) – Set to true to include deleted objects. By default, exclude deleted objects.

  • subCriteria (list) – Set additional criterias which are applied using a logical OR.

  • exclude (bool) – Only relevant for subcriteria. If set to true, objects matching this subcriteria object will be excluded.

  • required (bool) – Only relevant for subcriteria. If set to true, objects matching this subcriteria are required (AND-ed together with parent criteria).

  • customerID (list) – Restrict search to data belonging to specified customers.

  • field (list) – Restrict search to specific fields (by name or ID).

  • domain (list) – Restrict search to fields bound to one of these domains.

  • service (list) – Restrict search to fields wich are in use in one of the specified services (service ID or shortname).

  • policy (list) – Restrict search to fields which are in use in one of the specified policies (by policy ID or name)

  • availableForCaseID (int) – Restrict search to fields which are available for specified case (by ID)

  • valueType (list) – Restrict search to entries of one of these value types.

  • startTimestamp (int) – Restrict search to a time frame based on the set TimeFieldStrategy (start timestamp).

  • endTimestamp (int) – Restrict search to a time frame based on the set TimeFieldStrategy (end timestamp).

  • keywords (list) – Search for keywords.

  • timeFieldStrategy (list) – Defines which timestamps will be included in the search (default lastUpdatedTimestamp).

  • timeMatchStrategy (str) – Defines how strict to match against different timestamps (all/any) using start and end timestamp (default any)

  • keywordFieldStrategy (list) – Defines which fields will be searched by keywords (default all supported fields).

  • keywordMatchStrategy (str) – Defines the MatchStrategy for keywords (default match all keywords).

  • user (list) – Restrict search to fields created or updated by specified users (by id or shortname, selected by userFieldStrategy).

  • userID (list) – This field is deprecated. Use field ‘user’ instead.

  • userFieldStrategy (list) – Defines which user fields will be searched (default match all user fields).

  • sortBy (list) – List of properties to sort by (prefix with “-” to sort descending).

  • includeFlags (list) – Only include objects which have includeFlags set.

  • excludeFlags (list) – Exclude objects which have excludeFlags set.

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.cases.v2.field.field_descriptor.search_field_policies(limit: int = None, offset: int = None, includeDeleted: bool = None, includeFlags: int = None, excludeFlags: int = None, subCriteria: dict = None, exclude: bool = None, required: bool = None, customerID: int = None, domain: str = None, keywords: str = None, keywordMatchStrategy: str = None, keywordFieldStrategy: str = None, startTimestamp: int = None, endTimestamp: int = None, timeFieldStrategy: str = None, timeMatchStrategy: str = None, user: str = None, userID: int = None, userFieldStrategy: str = None, field: str = None, policy: str = None, sortBy: str = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Search field policies (INTERNAL)

Parameters

  • limit (int) – Max number of results.

  • offset (int) – Skip the first (offset) objects. By default, return result from first object.

  • includeDeleted (bool) – Set to true to include deleted objects. By default, exclude deleted objects.

  • includeFlags (int) – Only include objects which have includeFlags set.

  • excludeFlags (int) – Exclude objects which have excludeFlags set.

  • subCriteria (list) – Set additional criterias which are applied using a logical OR.

  • exclude (bool) – Only relevant for subcriteria. If set to true, objects matching this subcriteria object will be excluded.

  • required (bool) – Only relevant for subcriteria. If set to true, objects matching this subcriteria are required (AND-ed together with parent criteria).

  • customerID (list) – Restrict search to data belonging to specified customers.

  • domain (list) – Search by domain (ID or name).

  • keywords (list) – Search for keywords.

  • keywordMatchStrategy (str) – Defines the MatchStrategy for keywords (default match all keywords).

  • keywordFieldStrategy (list) – Defines which fields will be searched by keywords (default all supported fields).

  • startTimestamp (int) – Restrict search to a time frame based on the set TimeFieldStrategy (start timestamp).

  • endTimestamp (int) – Restrict search to a time frame based on the set TimeFieldStrategy (end timestamp).

  • timeFieldStrategy (list) – Defines which timestamps will be included in the search (default lastUpdatedTimestamp).

  • timeMatchStrategy (str) – Defines how strict to match against different timestamps (all/any) using start and end timestamp (default any)

  • user (list) – Restrict search to policies created or updated by specified users (by id or shortname, selected by userFieldStrategy).

  • userID (list) – This field is deprecated. Use field ‘user’ instead.

  • userFieldStrategy (list) – Defines which user fields will be searched (default match all user fields).

  • field (list) – Search for policies bound to specific fields (by field UUID or name).

  • policy (list) – Search for policies with specified id (UUID or name).

  • sortBy (list) – List of properties to sort by (prefix with “-” to sort descending).

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.cases.v2.field.field_descriptor.update_field_descriptor(field: str, domain: str = None, name: str = None, shortName: str = None, localizedNames: dict = None, localizedDescriptions: dict = None, valueType: str = None, multiValue: bool = None, hidden: bool = None, defaultValue: str = None, validator: dict = None, valueSource: dict = None, rendererOptions: dict = None, readRole: str = None, writeRole: str = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Update a field descriptor. (INTERNAL)

Parameters

  • field (str) – ID or name of descriptor to update

  • domain (str) – Domain to look for field in (when using field name for ID). Defaults to the current users domain.

  • name (str) – If set, change the name of the field. => [sw\{\}\$\-\(\).\[\]”'_/\,\*\+\#:@!?;=]*

  • shortName (str) – If set, change the shortname of the field. => [a-zA-Z0-9_:\-.]*

  • localizedNames (dict) – If set, update the localized names. => [sw\{\}\$\-\(\).\[\]”'_/\,\*\+\#:@!?;=]*

  • localizedDescriptions (dict) – If set, update the localized descriptions. => [sw\{\}\$\-\(\).\[\]”'_/\,\*\+\#:@!?;=]*

  • valueType (str) – If set, change the value type for the field.The field will only accept values that can be safely converted to this value type. If the field uses an autocompleter, the autocompleter should convert user input to valid values of this type.

  • multiValue (bool) – If set, change the multivalue parameter of this field. This will not affect existing cases with this field set.

  • hidden (bool) – If set, change the hidden parameter of this field.

  • defaultValue (str) – If set, change the default value to populate this field with.

  • validator (dict) –

  • valueSource (dict) –

  • rendererOptions (dict) – Renderer options. Only for use by the Argus frontend application.

  • readRole (str) – If set, update the required service role to read this field.

  • writeRole (str) – If set, update the required service role to write this field.

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.cases.v2.field.field_descriptor.update_field_policy(policy: str, domain: str = None, name: str = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Update a field policy. (INTERNAL)

Parameters

  • policy (str) – ID or name of policy to update

  • domain (str) – Domain to look for policy in (when using policy name for ID). Defaults to the current users domain.

  • name (str) – If set, change the name of this policy. => [sw\{\}\$\-\(\).\[\]”'_/\,\*\+\#:@!?;=]*

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON