Alias purpose

list

request
GET /api/v2/general/alias-purposes/list HTTP/1.1
Parameter Description

name

String to search by name. EX: ?name=test

pageable

Pageable description

response
{
  "content" : [ ],
  "pageable" : {
    "pageNumber" : 0,
    "pageSize" : 20,
    "sort" : {
      "empty" : true,
      "sorted" : false,
      "unsorted" : true
    },
    "offset" : 0,
    "paged" : true,
    "unpaged" : false
  },
  "last" : true,
  "totalElements" : 0,
  "totalPages" : 0,
  "first" : true,
  "size" : 20,
  "number" : 0,
  "sort" : {
    "empty" : true,
    "sorted" : false,
    "unsorted" : true
  },
  "numberOfElements" : 0,
  "empty" : true
}
Table 563. response description
Path Type Description

name

String

alias purpose name

deleted

Boolean

is alias purpose deleted?

create

request
POST /api/v2/general/alias-purposes HTTP/1.1

{
  "name" : "Test",
  "deleted" : false
}
Table 564. request description
Path Type Description Constraints

name

String

alias purpose name

Must not be blank.
Size must be between 0 and 50 inclusive

deleted

Boolean

is alias purpose deleted?

Must not be null

response
{
  "name" : "Test",
  "deleted" : false
}
Table 565. response description
Path Type Description

name

String

alias purpose name

deleted

Boolean

is alias purpose deleted?

get

request
GET /api/v2/general/alias-purposes?name=Test HTTP/1.1
Table 566. request description
Parameter Description

name

alias purpose name

response
{
  "name" : "Test",
  "deleted" : false
}
Table 567. response description
Path Type Description

name

String

alias purpose name

deleted

Boolean

is alias purpose deleted?

update

request
PUT /api/v2/general/alias-purposes?name=Test HTTP/1.1

{
  "name" : "Test",
  "deleted" : false
}
Table 568. request description
Path Type Description Constraints

name

String

alias purpose name

Must not be blank.
Size must be between 0 and 50 inclusive

deleted

Boolean

is alias purpose deleted?

Must not be null

Parameter Description

name

alias purpose name

response
HTTP/1.1 200 OK

delete

request
DELETE /api/v2/general/alias-purposes?name=Test HTTP/1.1
Table 569. request description
Parameter Description

name

alias purpose name

response
HTTP/1.1 200 OK