PUT api/v1/articles/{articleId}
Updates the specified article identifier.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| articleId |
The article identifier. |
globally unique identifier |
Required |
Body Parameters
The article details.
ArticleDetails| Name | Description | Type | Additional information |
|---|---|---|---|
| ArticleId | globally unique identifier |
None. |
|
| ArticleNumber | string |
Required String length: inclusive between 0 and 50 |
|
| ArticleName | string |
Required String length: inclusive between 0 and 250 |
|
| ArticleInfo | string |
String length: inclusive between 0 and 250 |
|
| Description | string |
None. |
|
| IsActive | boolean |
Required |
|
| Id | globally unique identifier |
None. |
|
| CanUpdateRecord | boolean |
None. |
|
| CanDeleteRecord | boolean |
None. |
Request Formats
application/json, text/json
Sample:
{
"ArticleId": "8ec88109-334f-4970-b537-40ac9df6248d",
"ArticleNumber": "sample string 2",
"ArticleName": "sample string 3",
"ArticleInfo": "sample string 4",
"Description": "sample string 5",
"IsActive": true,
"Id": "8ec88109-334f-4970-b537-40ac9df6248d",
"CanUpdateRecord": true,
"CanDeleteRecord": true
}
text/html
Sample:
{"ArticleId":"8ec88109-334f-4970-b537-40ac9df6248d","ArticleNumber":"sample string 2","ArticleName":"sample string 3","ArticleInfo":"sample string 4","Description":"sample string 5","IsActive":true,"Id":"8ec88109-334f-4970-b537-40ac9df6248d","CanUpdateRecord":true,"CanDeleteRecord":true}
application/xml, text/xml
Sample:
<ArticleDetails xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FLS.Data.WebApi.Articles"> <CanDeleteRecord xmlns="http://schemas.datacontract.org/2004/07/FLS.Data.WebApi">true</CanDeleteRecord> <CanUpdateRecord xmlns="http://schemas.datacontract.org/2004/07/FLS.Data.WebApi">true</CanUpdateRecord> <Id xmlns="http://schemas.datacontract.org/2004/07/FLS.Data.WebApi">8ec88109-334f-4970-b537-40ac9df6248d</Id> <ArticleId>8ec88109-334f-4970-b537-40ac9df6248d</ArticleId> <ArticleInfo>sample string 4</ArticleInfo> <ArticleName>sample string 3</ArticleName> <ArticleNumber>sample string 2</ArticleNumber> <Description>sample string 5</Description> <IsActive>true</IsActive> </ArticleDetails>
application/x-www-form-urlencoded
Sample:
Response Information
Resource Description
ArticleDetails| Name | Description | Type | Additional information |
|---|---|---|---|
| ArticleId | globally unique identifier |
None. |
|
| ArticleNumber | string |
Required String length: inclusive between 0 and 50 |
|
| ArticleName | string |
Required String length: inclusive between 0 and 250 |
|
| ArticleInfo | string |
String length: inclusive between 0 and 250 |
|
| Description | string |
None. |
|
| IsActive | boolean |
Required |
|
| Id | globally unique identifier |
None. |
|
| CanUpdateRecord | boolean |
None. |
|
| CanDeleteRecord | boolean |
None. |
Response Formats
application/json, text/json
Sample:
{
"ArticleId": "f732bb66-f677-405b-98f3-f918fe9b2d3d",
"ArticleNumber": "sample string 2",
"ArticleName": "sample string 3",
"ArticleInfo": "sample string 4",
"Description": "sample string 5",
"IsActive": true,
"Id": "f732bb66-f677-405b-98f3-f918fe9b2d3d",
"CanUpdateRecord": true,
"CanDeleteRecord": true
}
text/html
Sample:
{"ArticleId":"f732bb66-f677-405b-98f3-f918fe9b2d3d","ArticleNumber":"sample string 2","ArticleName":"sample string 3","ArticleInfo":"sample string 4","Description":"sample string 5","IsActive":true,"Id":"f732bb66-f677-405b-98f3-f918fe9b2d3d","CanUpdateRecord":true,"CanDeleteRecord":true}
application/xml, text/xml
Sample:
<ArticleDetails xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FLS.Data.WebApi.Articles"> <CanDeleteRecord xmlns="http://schemas.datacontract.org/2004/07/FLS.Data.WebApi">true</CanDeleteRecord> <CanUpdateRecord xmlns="http://schemas.datacontract.org/2004/07/FLS.Data.WebApi">true</CanUpdateRecord> <Id xmlns="http://schemas.datacontract.org/2004/07/FLS.Data.WebApi">f732bb66-f677-405b-98f3-f918fe9b2d3d</Id> <ArticleId>f732bb66-f677-405b-98f3-f918fe9b2d3d</ArticleId> <ArticleInfo>sample string 4</ArticleInfo> <ArticleName>sample string 3</ArticleName> <ArticleNumber>sample string 2</ArticleNumber> <Description>sample string 5</Description> <IsActive>true</IsActive> </ArticleDetails>