stylebooks

Configuration for StyleBooks Configuration resource.

Read/write properties

dependencies<String>

List of StyleBooks that uses this StyleBook.
Minimum length = 1
Maximum length = 32

description<String>

Description of the StyleBook.
Minimum length = 1
Maximum length = 32

version<String>

Version of the StyleBook.
Minimum length = 1
Maximum length = 32

uses_builtin_namespaces<String>

Builtin namespaces that are used by the StyleBook.
Minimum length = 1
Maximum length = 32

schema_version<String>

Schema version of the StyleBook parser.
Minimum length = 1
Maximum length = 32

namespace<String>

Namespace of the StyleBook.
Minimum length = 1
Maximum length = 32

display_name<String>

Display name of the StyleBook.
Minimum length = 1
Maximum length = 128

imported_datetime<Boolean>

Date the StyleBook was imported.

source<String>

Source definition of the StyleBook.
Minimum length = 1
Maximum length = 32

name<String>

Name of the StyleBook.

Operations

NOTE: In request payload, Mandatory parameters are marked red and bold.

The following parameters can be used in the nitro request :

onerror   <String_value>

Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.
Default value: EXIT
Possible values = EXIT, CONTINUE

add

URL:https://<MGMT-IP>/nitro/v2/config/stylebooks

HTTPS Method:POST

HTTPS Request Headers:

Content-Type:application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

or

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Request Payload:JSON

{"stylebook": {
      "source":< property_value>}}

Response:

HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error

Response Payload:JSON

{ "stylebook":{
      "namespace":< property_value>
      "version":< property_value>
      "name":< property_value>}}

delete

URL:https://<MGMT-IP>/nitro/v2/config/stylebooks/<version_value>/<namespace_value>/<name_value>

HTTPS Method:DELETE

HTTPS Request Headers:

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

or

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Response:

HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error

Response Payload:JSON

{ "stylebook":{
      "namespace":< property_value>
      "version":< property_value>
      "name":< property_value>}}

get (all)

URL:https://<MGMT-IP>/nitro/v2/config/stylebooks

Query-parameters:

HTTPS Method:GET

HTTPS Request Headers:

Accept:application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

or

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Response:

HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error

Response Headers:

Content-Type:application/json

Response Payload:JSON

{ "stylebooks":[{
      "dependencies":<String_value>,
      "description":<String_value>,
      "version":<String_value>,
      "uses_builtin_namespaces":<String_value>,
      "schema_version":<String_value>,
      "namespace":<String_value>,
      "display_name":<String_value>,
      "imported_datetime":<Boolean_value>,
      "source":<String_value>,
      "name":<String_value>}]}

get

URL:https://<MGMT-IP>/nitro/v2/config/stylebooks/<version_value>/<namespace_value>/<name_value>

HTTPS Method:GET

HTTPS Request Headers:

Accept:application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

or

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Response:

HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error

Response Headers:

Content-Type:application/json

Response Payload:JSON

{ "stylebook":{
      "dependencies":<String_value>,
      "description":<String_value>,
      "version":<String_value>,
      "uses_builtin_namespaces":<String_value>,
      "schema_version":<String_value>,
      "namespace":<String_value>,
      "display_name":<String_value>,
      "imported_datetime":<Boolean_value>,
      "source":<String_value>,
      "name":<String_value>}}