Matching results

Label

Labels are useful to group entities which have something in common.

/api/v1/labels

Returns the list of existing labels for this company. It is possible to restrain results using criteria. More information about sorting here

Request

GET https://na.airvantage.net/api/v1/labels

Response
200 OK

HTTP/1.1 200 OK
Content-Type: application/json
...
{
   "items":    [
      "muret",
      "myApplications",
      "paris",
      "sierra"
   ],
   "count": 4,
   "size": 4,
   "offset": 0
}
Name Description Use Default Type Operand
name Find labels which name is like the specified string optional null string like
exactMatch The name criterion behaves as equals when this parameter is set to true optional false boolean
company Set the context company. optional caller's company uid =
HTTP Method GET
Requires Authentication Yes
Rate Limited Yes
Headers None
Permissions accountNetwork.labels.view
Order by name

/api/v1/labels

Creates a new label for the context company.

Request

POST https://na.airvantage.net/api/v1/labels?name=sierra

Response
200 OK

HTTP/1.1 200 OK
Content-Type: application/json
...
{
   "label": "sierra"
}
Name Description Use Default Type
name The label name. A label is unique for a given company. It must respect the following regexp [ \p{Alnum}[\p{Punct}&&[^/;]]]{2,32} required string
company Set the context company. optional caller's company uid
Name Description
label.missing.name A label must be provided.
label.bad.format.name A label must respect [ \p{Alnum}[\p{Punct}&&[^/;]]]{2,32}
label.exists A label with the same name already exist in this company.
HTTP Method POST
Requires Authentication Yes
Rate Limited Yes
Headers None
Permissions accountNetwork.labels.createEdit

/api/v1/labels/{name}

Deletes a label matching the specified name for the context company.

Request

DELETE https://na.airvantage.net/api/v1/labels/sierra

Response
200 OK

HTTP/1.1 200 OK
Content-Length: 0
    
Name Description Use Default Type
company Set the context company. optional caller's company uid
Name Description
label.unknown The specified 'name' does not match with any label.
HTTP Method DELETE
Requires Authentication Yes
Rate Limited Yes
Headers None
Permissions accountNetwork.labels.delete
TOP