Policy export service v1.0

Resource: export_policies

http://{device}/api/npm.policies.export/1.0/policies

JSON

{
  "items": [ export_policy ]
}

{
  "items": [ export_policy ]
}

Property Name	Type	Description	Notes
export_policies	<object>		Required properties: [items];
export_policies.items	<array of <export_policy>>
export_policies.items[items]	<export_policy>	Exported policy

Links

export_policies: get

GET http://{device}/api/npm.policies.export/1.0/policies

Response Body

Returns an export_policies data object.

export_policies: set

POST http://{device}/api/npm.policies.export/1.0/policies

Request Body

Provide an export_policy data object.

Response Body

Returns an export_policy data object.

Resource: export_policy

Exported policy

http://{device}/api/npm.policies.export/1.0/policies/items/{id}

JSON

{
  "fh_profile_mapping": {
    "id": integer,
    "name": string
  },
  "filter_mappings": [ filter_mapping ],
  "policy": {
    <prop>: any
  },
  "recipient_mappings": recipients_list
}

{
  "fh_profile_mapping": {
    "id": integer,
    "name": string
  },
  "filter_mappings": [ filter_mapping ],
  "policy": {
    <prop>: any
  },
  "recipient_mappings": recipients_list
}

Property Name	Type	Description	Notes
export_policy	<object>	Exported policy	Required properties: [policy];
export_policy.fh_profile_mapping	<object>	Mapping of FH profile ID to name	Required properties: [id, name]; Optional;
export_policy.fh_profile_mapping.id	<integer>	FH Profile ID
export_policy.fh_profile_mapping.name	<string>	FH Profile name
export_policy.filter_mappings	<array of <filter_mapping>>	List of filter mappings	Optional;
export_policy.filter_mappings[items]	<filter_mapping>	A column ID and its value name/ID used in a policy filter
export_policy.policy	<object>	Original policy
export_policy.policy.<prop>	<any>		Optional;
export_policy.recipient_mappings	<recipients_list>	Abbreviated list of recipient names and their ids

Links

export_policy: get

GET http://{device}/api/npm.policies.export/1.0/policies/items/{id}

Response Body

Returns an export_policy data object.

export_policy: set

PUT http://{device}/api/npm.policies.export/1.0/policies/items/{id}

Request Body

Provide an export_policy data object.

Response Body

Returns an export_policy data object.

Type: filter_mapping

A column ID and its value name/ID used in a policy filter

JSON

{
  "column_id": string,
  "mappings": [
    {
      "item_id": integer,
      "item_value": string
    }
  ]
}

{
  "column_id": string,
  "mappings": [
    {
      "item_id": integer,
      "item_value": string
    }
  ]
}

Property Name	Type	Description	Notes
filter_mapping	<object>	A column ID and its value name/ID used in a policy filter	Required properties: [column_id, mappings];
filter_mapping.column_id	<string>	Column ID on which the filter applies
filter_mapping.mappings	<array of <object>>	Individual ID-to-Value mappings for the column
filter_mapping.mappings[items]	<object>		Required properties: [item_id, item_value];
filter_mapping.mappings[items].item_id	<integer>	ID of the mapping or enum
filter_mapping.mappings[items]. item_value	<string>	String value of the mapping or enum