POST api/APIAuthenticate/SaveUserModuleApiEntity
Add APIs/entities to an existing user module (step 2 of 2-step process).
Request Information
URI Parameters
None.
Body Parameters
User module API/entity request model
SaveUserModuleApiEntityRequestModel| Name | Description | Type | Additional information |
|---|---|---|---|
| UserModuleID | integer |
Required |
|
| APIs | Collection of UserModuleApiModel |
None. |
|
| Entities | Collection of UserModuleEntityModel |
None. |
Request Formats
application/json, text/json, text/plain, text/html
Sample:
{
"userModuleID": 1,
"apIs": [
{
"apiurl": "sample string 1"
},
{
"apiurl": "sample string 1"
}
],
"entities": [
{
"obj": "sample string 1",
"w": true,
"r": true,
"d": true
},
{
"obj": "sample string 1",
"w": true,
"r": true,
"d": true
}
]
}
application/xml, text/xml
Sample:
<SaveUserModuleApiEntityRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ArrowCMMS.Core.RequestModel.UserModule">
<APIs>
<UserModuleApiModel>
<apiurl>sample string 1</apiurl>
</UserModuleApiModel>
<UserModuleApiModel>
<apiurl>sample string 1</apiurl>
</UserModuleApiModel>
</APIs>
<Entities>
<UserModuleEntityModel>
<D>true</D>
<Obj>sample string 1</Obj>
<R>true</R>
<W>true</W>
</UserModuleEntityModel>
<UserModuleEntityModel>
<D>true</D>
<Obj>sample string 1</Obj>
<R>true</R>
<W>true</W>
</UserModuleEntityModel>
</Entities>
<UserModuleID>1</UserModuleID>
</SaveUserModuleApiEntityRequestModel>
multipart/form-data
Sample:
<SaveUserModuleApiEntityRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ArrowCMMS.Core.RequestModel.UserModule"><APIs><UserModuleApiModel><apiurl>sample string 1</apiurl></UserModuleApiModel><UserModuleApiModel><apiurl>sample string 1</apiurl></UserModuleApiModel></APIs><Entities><UserModuleEntityModel><D>true</D><Obj>sample string 1</Obj><R>true</R><W>true</W></UserModuleEntityModel><UserModuleEntityModel><D>true</D><Obj>sample string 1</Obj><R>true</R><W>true</W></UserModuleEntityModel></Entities><UserModuleID>1</UserModuleID></SaveUserModuleApiEntityRequestModel>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
CommonResponseDataModel with result
CommonResponseDataModel| Name | Description | Type | Additional information |
|---|---|---|---|
| ReturnID | integer |
Required |
|
| Message | string |
Required |
|
| Successful | boolean |
Required |
|
| Code | integer |
None. |
|
| TotalRecord | integer |
None. |
Response Formats
application/json, text/json, text/plain, text/html
Sample:
{
"returnID": 1,
"message": "sample string 2",
"successful": true,
"code": 4,
"totalRecord": 5
}
application/xml, text/xml
Sample:
<CommonResponseDataModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Arrow.Core.DataModel"> <Code>4</Code> <Message>sample string 2</Message> <ReturnID>1</ReturnID> <Successful>true</Successful> <TotalRecord>5</TotalRecord> </CommonResponseDataModel>
multipart/form-data
Sample:
<CommonResponseDataModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Arrow.Core.DataModel"><Code>4</Code><Message>sample string 2</Message><ReturnID>1</ReturnID><Successful>true</Successful><TotalRecord>5</TotalRecord></CommonResponseDataModel>