SecurityCenter : Publishing Site

/pubSite

Methods
GET

Gets the list of Publishing Sites.

Fields Parameter
Expand

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

    ?fields=<field>,...

Allowed Fields

*id
**name
**description
type

uri
authType
cert
username
password
maxChunkSize
createdTime
modifiedTime

Session user role "1" (Administrator)

organizations

 

Legend

* = always comes back

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

None

Example Response
Expand
{
	"type" : "regular",
	"response" : [
		{
			"id" : "2",
			"name" : "test",
			"description" : "desc",
			"type" : "HTTP POST",
			"uri" : "http:\/\/192.168.1.1\/test",
			"authType" : "password",
			"cert" : "",
			"username" : "test",
			"password" : "SET",
			"maxChunkSize" : "0",
			"createdTime" : "1404245619",
			"modifiedTime" : "1404245619"
		}
	],
	"error_code" : 0,
	"error_msg" : "",
	"warnings" : [],
	"timestamp" : 1404247733
}

POST

Adds a Publishing Site.

Request Parameters
Expand
{
	"name" : <string>,
	"description" : <string> DEFAULT "",
	"type" : <string> "HTTP POST" | "CMRS",
	"maxChunkSize" : <number> DEFAULT 0,
	"uri" : <string>,
	"authType" : <string> "certificate" | "password",
	"organizations" : [
		{
			"id" : <number>
		}...
	]
...
}

authType "certificate"

...
	"cert" : <string>
...

 authType "password"

...
	"username" : <string>,
	"password" : <string>
...
Example Response
Expand
{
	"type" : "regular",
	"response" : [
		{
			"id" : "2",
			"name" : "test",
			"description" : "desc",
			"type" : "HTTP POST",
			"uri" : "http:\/\/192.168.1.1\/test",
			"authType" : "password",
			"cert" : "",
			"username" : "test",
			"password" : "SET",
			"maxChunkSize" : "0",
			"createdTime" : "1404245619",
			"modifiedTime" : "1404245619",
			"organizations":[]
		},
	],
	"error_code" : 0,
	"error_msg" : "",
	"warnings" : [],
	"timestamp" : 1404247733
}

 

 

/pubSite/{id}

Methods
GET

Gets the Publishing Site 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
**name
**description
type

uri
authType
cert
username
password
maxChunkSize
createdTime
modifiedTime

Session user role "1" (Administrator)

organizations

Legend

* = always comes back

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

None

Example Response
Expand
{
	"type" : "regular",
	"response" : {
		"id" : "2",
		"name" : "test",
		"description" : "desc",
		"type" : "HTTP POST",
		"uri" : "http:\/\/192.168.1.1\/test",
		"authType" : "password",
		"cert" : "",
		"username" : "test",
		"password" : "SET",
		"maxChunkSize" : "0",
		"createdTime" : "1404245619",
		"modifiedTime" : "1404245619"
	}, 
	"error_code" : 0,
	"error_msg" : "",
	"warnings" : [],
	"timestamp" : 1404247733
}

PATCH

Edits the Publishing Site associated with {id}, changing only the passed in fields.

Request Parameters

(All fields are optional)

See /PubSite::POST for parameters.

Example Response

See /PubSite/{id}::GET for example response.

DELETE

Deletes the Publishing Site associated with {id}, depending on access and permissions.

Request Parameters

None

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