27 lines
10 KiB
HTML
27 lines
10 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
|
|
<link href="../../rdx/css/rdx.css" rel="stylesheet" type="text/css" />
|
|
<link href="../../index.css" rel="stylesheet" type="text/css" />
|
|
<title>stylebooks</title>
|
|
</head>
|
|
<body class="ns_body">
|
|
<p class="ns_wp_header">stylebooks</p>
|
|
<P>Configuration for StyleBooks Configuration resource.</P>
|
|
<p class="heading">Read/write properties</p>
|
|
<p class="property_name">dependencies<span class="property_type"><String></span></p><p class="property_description">List of StyleBooks that uses this StyleBook.<br> Minimum length = 1<br> Maximum length = 32</p>
|
|
<p class="property_name">description<span class="property_type"><String></span></p><p class="property_description">Description of the StyleBook.<br> Minimum length = 1<br> Maximum length = 32</p>
|
|
<p class="property_name">version<span class="property_type"><String></span></p><p class="property_description">Version of the StyleBook.<br> Minimum length = 1<br> Maximum length = 32</p>
|
|
<p class="property_name">uses_builtin_namespaces<span class="property_type"><String></span></p><p class="property_description">Builtin namespaces that are used by the StyleBook.<br> Minimum length = 1<br> Maximum length = 32</p>
|
|
<p class="property_name">schema_version<span class="property_type"><String></span></p><p class="property_description">Schema version of the StyleBook parser.<br> Minimum length = 1<br> Maximum length = 32</p>
|
|
<p class="property_name">namespace<span class="property_type"><String></span></p><p class="property_description">Namespace of the StyleBook.<br> Minimum length = 1<br> Maximum length = 32</p>
|
|
<p class="property_name">display_name<span class="property_type"><String></span></p><p class="property_description">Display name of the StyleBook.<br> Minimum length = 1<br> Maximum length = 128</p>
|
|
<p class="property_name">imported_datetime<span class="property_type"><Boolean></span></p><p class="property_description">Date the StyleBook was imported.</p>
|
|
<p class="property_name">source<span class="property_type"><String></span></p><p class="property_description">Source definition of the StyleBook.<br> Minimum length = 1<br> Maximum length = 32</p>
|
|
<p class="property_name">name<span class="property_type"><String></span></p><p class="property_description">Name of the StyleBook.</p>
|
|
<p class="heading">Operations</p><p class="property_name">NOTE: In request payload, Mandatory parameters are marked red and bold.<br /><br />The following parameters can be used in the nitro request :</p>
|
|
<p class="property_name">onerror<span class=\"property_type\"> <String_value></span></p><p class="property_description"> Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.<br />Default value: EXIT<br />Possible values = EXIT, CONTINUE</p><a href="#add" class="operation">add</a><a href="#delete" class="operation">delete</a><a href="#get_all" class="operation">get (all)</a><a href="#get" class="operation">get</a><p class="heading"><a name="add">add</a></p><p class="key">URL:<span class="url_value">https://<MGMT-IP>/nitro/v2/config/stylebooks<p class="key">HTTPS Method:<span class="value">POST</span></p><p class="key">HTTPS Request Headers:</p><p class="key"><span class="value">Content-Type:<span class="value">application/json</span></span></p><p class="key"><span class="value">X-NITRO-USER:<span class="value">username_value<String></span></span></p><p class="key"><span class="value">X-NITRO-PASS:<span class="value">password_value<String></span></span></p><p class="key"><span class="value"><span class="value">or</span></span></p><p class="key"><span class="value">Cookie:<span class="value">NITRO_AUTH_TOKEN=token_value<String></span></span></p><p class="key">Request Payload:<span class="value">JSON</span></p><p class="payload">{"stylebook": {<br> "source":< property_value></font>}}</p><p class="key">Response:</p><p class="key"><span class="value">HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx <string> (for general HTTPS errors) or 5xx <string> (for NetScaler-MAS-specific errors). The response payload provides details of the error</span></p><p class="key">Response Payload:<span class="value">JSON</span></p><p class="payload">{ "stylebook":{<br> "namespace":< property_value></font><br> "version":< property_value></font><br> "name":< property_value></font>}}</p><p class="heading"><a name="delete">delete</a></p><p class="key">URL:<span class="url_value">https://<MGMT-IP>/nitro/v2/config/stylebooks/<version_value>/<namespace_value>/<name_value></span></p><p class="key">HTTPS Method:<span class="value">DELETE</span></p><p class="key">HTTPS Request Headers:</p><p class="key"><span class="value">X-NITRO-USER:<span class="value">username_value<String></span></span></p><p class="key"><span class="value">X-NITRO-PASS:<span class="value">password_value<String></span></span></p><p class="key"><span class="value"><span class="value">or</span></span></p><p class="key"><span class="value">Cookie:<span class="value">NITRO_AUTH_TOKEN=token_value<String></span></span></p><p class="key">Response:</p><p class="key"><span class="value">HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx <string> (for general HTTPS errors) or 5xx <string> (for NetScaler-MAS-specific errors). The response payload provides details of the error</span></p><p class="key">Response Payload:<span class="value">JSON</span></p><p class="payload">{ "stylebook":{<br> "namespace":< property_value></font><br> "version":< property_value></font><br> "name":< property_value></font>}}</p><p class="heading"><a name="get_all">get (all)</a></p><p class="key">URL:<span class="url_value">https://<MGMT-IP>/nitro/v2/config/stylebooks</span></p><p class="key">Query-parameters:<span class="url_value"></span></p><p class="key">HTTPS Method:<span class="value">GET</span></p><p class="key">HTTPS Request Headers:</p><p class="key"><span class="value">Accept:<span class="value">application/json</span></span></p><p class="key"><span class="value">X-NITRO-USER:<span class="value">username_value<String></span></span></p><p class="key"><span class="value">X-NITRO-PASS:<span class="value">password_value<String></span></span></p><p class="key"><span class="value"><span class="value">or</span></span></p><p class="key"><span class="value">Cookie:<span class="value">NITRO_AUTH_TOKEN=token_value<String></span></span></p><p class="key">Response:</p><p class="key"><span class="value">HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx <string> (for general HTTPS errors) or 5xx <string> (for NetScaler-MAS-specific errors). The response payload provides details of the error</span></p><p class="key">Response Headers:</p><p class="key"><span class="value">Content-Type:<span class="value">application/json</span></span></p><p class="key">Response Payload:<span class="value">JSON</span></p><p class="payload">{ "stylebooks":[{<br> "dependencies":<String_value></font>,<br> "description":<String_value></font>,<br> "version":<String_value></font>,<br> "uses_builtin_namespaces":<String_value></font>,<br> "schema_version":<String_value></font>,<br> "namespace":<String_value></font>,<br> "display_name":<String_value></font>,<br> "imported_datetime":<Boolean_value></font>,<br> "source":<String_value></font>,<br> "name":<String_value></font>}]}</p><p class="heading"><a name="get">get</a></p><p class="key">URL:<span class="url_value">https://<MGMT-IP>/nitro/v2/config/stylebooks/<version_value>/<namespace_value>/<name_value></span></p><p class="key">HTTPS Method:<span class="value">GET</span></p><p class="key">HTTPS Request Headers:</p><p class="key"><span class="value">Accept:<span class="value">application/json</span></span></p><p class="key"><span class="value">X-NITRO-USER:<span class="value">username_value<String></span></span></p><p class="key"><span class="value">X-NITRO-PASS:<span class="value">password_value<String></span></span></p><p class="key"><span class="value"><span class="value">or</span></span></p><p class="key"><span class="value">Cookie:<span class="value">NITRO_AUTH_TOKEN=token_value<String></span></span></p><p class="key">Response:</p><p class="key"><span class="value">HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx <string> (for general HTTPS errors) or 5xx <string> (for NetScaler-MAS-specific errors). The response payload provides details of the error</span></p><p class="key">Response Headers:</p><p class="key"><span class="value">Content-Type:<span class="value">application/json</span></span></p><p class="key">Response Payload:<span class="value">JSON</span></p><p class="payload">{ "stylebook":{<br> "dependencies":<String_value></font>,<br> "description":<String_value></font>,<br> "version":<String_value></font>,<br> "uses_builtin_namespaces":<String_value></font>,<br> "schema_version":<String_value></font>,<br> "namespace":<String_value></font>,<br> "display_name":<String_value></font>,<br> "imported_datetime":<Boolean_value></font>,<br> "source":<String_value></font>,<br> "name":<String_value></font>}}</p>
|
|
</body>
|
|
</html>
|