Select the tab
ESET PROTECT On-Prem – Table of Contents

POST Update policy assignment ranking

Relative path: /v2/policy-assignments/{assignmentUuid}:updateRanking

Move the policy assignment within ranks.

Body example


The rank value cannot be 0.
To update the rank value, a device must have more assigned policies.
Rank = policy order.

Request body

Display Schema instead of an Example or vice-versa

Type

Required

Example

Schema

application/json

Yes

{
  "rank": 0
}
{
  "$ref": "PolicyAssignmentsUpdatePolicyAssignmentRankingBody",
  "rank": {
    "type": "integer",
    "description": "The new ranking of the policy assignment. Cannot be 0; otherwise, 400 BAD REQUEST is thrown. Cannot be higher than the number of target's assignments; otherwise, 412 PRECONDITION-FAILED is thrown. After the successful update, all the other assignments are reordered with the given policy being ranked as desired.",
    "format": "int64"
  }
}

Parameters in path

Name

Type

Required

Description

assignmentUuid

string

Yes

Reference to the policy assignment to be updated.

type: PolicyAssignment



Responses

Display Schema+Headers instead of an Example or vice-versa

Code

Description and Example

Description, Schema and Headers

200

A successful response.

A successful response.


Response schema

{
  "$ref": "v2UpdatePolicyAssignmentRankingResponse",
  "title": "empty",
  "type": "object"
}

default

An unexpected error response.


Response example

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

An unexpected error response.


Response schema

{
  "$ref": "rpcStatus",
  "description": "The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.",
  "code": {
    "type": "integer",
    "description": "The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].",
    "format": "int32"
  },
  "message": {
    "type": "string",
    "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client."
  },
  "details": [
    {
      "$ref": "protobufAny",
      "description": "Any contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message. Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type. Example 1: Pack and unpack a message in C++. Foo foo = ...; Any any; any.PackFrom(foo); ... if (any.UnpackTo(&foo)) { ... } Example 2: Pack and unpack a message in Java. Foo foo = ...; Any any = Any.pack(foo); ... if (any.is(Foo.class)) { foo = any.unpack(Foo.class); } Example 3: Pack and unpack a message in Python. foo = Foo(...) any = Any() any.Pack(foo) ... if any.Is(Foo.DESCRIPTOR): any.Unpack(foo) ... The pack methods provided by protobuf library will by default use 'type.googleapis.com/full.type.name' as the type URL and the unpack methods only use the fully qualified type name after the last '/' in the type URL, for example 'foo.bar.com/x/y.z' will yield type name 'y.z'. JSON The JSON representation of an Any value uses the regular representation of the deserialized, embedded message, with an additional field @type which contains the type URL. Example: package google.profile; message Person { string first_name = 1; string last_name = 2; } { '@type': 'type.googleapis.com/google.profile.Person', 'firstName': <string>, 'lastName': <string> } If the embedded message type is well-known and has a custom JSON representation, that representation will be embedded adding a field value which holds the custom JSON in addition to the @type field. Example (for message [google.protobuf.Duration][]): { '@type': 'type.googleapis.com/google.protobuf.Duration', 'value': '1.212s' }",
      "@type": {
        "type": "string",
        "description": "A URL/resource name whose content describes the type of the serialized protocol buffer message. For URLs which use the scheme http, https, or no scheme, the following restrictions and interpretations apply: If no scheme is provided, https is assumed. The last segment of the URL's path must represent the fully qualified name of the type (as in path/google.protobuf.Duration). The name should be in a canonical form (e.g., leading '.' is not accepted). An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error. Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.) Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics."
      }
    }
  ]
}