PUT api/DisplayLabels/{id}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

globally unique identifier

Required

Body Parameters

PostDisplayLabel
NameDescriptionTypeAdditional information
Id

globally unique identifier

None.

Description

string

Required

String length: inclusive between 0 and 100

Comment

string

None.

Request Formats

application/json, text/json

Sample:
{
  "Id": "9045938d-0ea9-40e3-af7a-ff051dd0b8d9",
  "Description": "sample string 2",
  "Comment": "sample string 3"
}

application/xml, text/xml

Sample:
<PostDisplayLabel xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Id>9045938d-0ea9-40e3-af7a-ff051dd0b8d9</Id>
  <Description>sample string 2</Description>
  <Comment>sample string 3</Comment>
</PostDisplayLabel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

DisplayLabel
NameDescriptionTypeAdditional information
Id

globally unique identifier

None.

CompanyId

globally unique identifier

None.

CreatorUserId

string

None.

Description

string

Required

String length: inclusive between 0 and 250

Comment

string

None.

IsDefault

boolean

None.

Created

date

None.

LastModified

date

None.

Response Formats

application/json, text/json

Sample:
{
  "Id": "59c410b8-c679-4049-bc88-66859f9f611c",
  "CompanyId": "4712f733-fc24-4a13-bed0-6c75e5febe63",
  "CreatorUserId": "sample string 3",
  "Description": "sample string 4",
  "Comment": "sample string 5",
  "IsDefault": true,
  "Created": "2022-05-21T08:52:04.7812634+00:00",
  "LastModified": "2022-05-21T08:52:04.7812634+00:00"
}