SecurityCenter API: Attribute Set

/attributeSet

Methods
GET

Gets the list of Attribute Sets

Fields Parameter
Expand

The fields parameter should be specified along the query string, and it takes the syntax

    ?fields=<field>,...

Allowed Fields

*id
**type
**name
description**
creator
createdTime
modifiedTime
attributes

Legend

* = always comes back

** = comes back if fields list not specified on GET all
Request Attribute Set Parameters

None

Example Response
Expand
{
	"type" : "regular",
	"response" : [
		{
			"id" : "1",
			"type" : "arf",
			"name" : "name",
			"description" : "description",
			"creatorID" : "1",
			"createdTime" : "1404335179",
			"modifiedTime" : "1404335179"
		}
		...
	],
	"error_code" : 0,
	"error_msg" : "",
	"warnings" : [],
	"timestamp" : 1404410691
}

POST

Adds an Attribute Set

Request Parameters
Expand
{
	"name" : <string>,
	"description" : <string> DEFAULT "",
	"type" : <string> "arf" | "lasr",
	"attributes" : {
		<name:string> : <value:string>...
 
		type "arf", name is "por_managed"
		---------------------------------
		"por_managed" : <string> "true" : "false"
	}
}

See /attributeSet/types::GET for useful attribute name/value parameters.

Example Response
Expand
{
	"type" : "regular",
	"response" : {
		"attributeSet" : {
			"id" : "1",
			"type" : "arf",
			"name" : "name",
			"description" : "description",
			"creatorID" : "1",
			"createdTime" : "1404413984",
			"modifiedTime" : "1404413984"
		}
	},
	"error_code" : 0,
	"error_msg" : "",
	"warnings" : [],
	"timestamp" : 1404413984
}

/attributeSet/{id}

Methods
GET

Gets the Attribute Set associated with {id}.

Fields Parameter
Expand

The fields parameter should be specified along the query string, and it takes the syntax

    ?fields=<field>,...

Allowed Fields

*id
**type
**name
description**
creator
createdTime
modifiedTime
attributes

Legend

* = always comes back

** = comes back if fields list not specified on GET all

Request Parameters

None

Example Response
Expand
{
	"type" : "regular",
	"response" : {
		"id" : "1",
		"type" : "arf",
		"name" : "name",
		"description" : "description",
		"creatorID" : "1",
		"createdTime" : "1404335179",
		"modifiedTime" : "1404335179"
	},
	"error_code" : 0,
	"error_msg" : "",
	"warnings" : [],
	"timestamp" : 1404414568
}

PATCH

Edits the Attribute Set associated with {id}, changing only the passed in fields.

Request Parameters

(All fields are optional)

See /attributeSet::POST for parameters.

Example Response
See /attributeSet/{id}::GET

DELETE

Deletes the Attribute Set associated with {id}, depending on access and permissions.

Request Parameters

None

Example Response
Expand
{
    "type" : "regular",
    "response" : "",
    "error_code" : 0,
    "error_msg" : "",
    "warnings" : [],
    "timestamp" : 1403100582
}

/attributeSet/types

Methods
GET

Gets the list of Attribute Set Types.

Request Parameters

None

Example Response
Expand
{
	"type" : "regular",
	"response" : {
		"attributes" : {
			"arf" : [
				"owning_unit\ame",
				"owning_service\ame",
				"current_aor",
				"region",
				"administration_unit\ame",
				"administration_poc\/full_name\/first_name",
				"administration_poc\/full_name\/last_name",
				"administration_poc\/full_name\/middle_initial",
				"administration_poc\/full_name\/generational_qualifier",
				"administration_poc\/rank_or_title",
				"administration_poc\/e-mail",
				"administration_poc\/position",
				"cnd_service_provider\ame",
				"por_managed",
				"system_affiliation",
				"Location\/room_identifier",
				"Location\/building_number",
				"Location\/street_address",
				"Location\/city",
				"Location\/state",
				"Location\/postal_code",
				"Location\/country",
				"Location\/latitude",
				"Location\/longitude",
			],
			"lasr" : [
				"ReportingComponent",
				"ComponentBureau",
				"Enclaves",
			]
		}
	},
	"error_code" : 0,
	"error_msg" : "",
	"warnings" : [],
	"timestamp" : 1404415504
}