POST {repositoryId}/Data/{id}/Receiving
Starts the receiving process of a Data resource.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
id |
ID of the Data resource. |
string |
Required |
repositoryId |
ID of the resource repository. |
string |
Default value is |
Body Parameters
Receiving parameters.
ReceivingParamsName | Description | Type | Additional information |
---|---|---|---|
Correspondent | NamedReference |
None. |
|
Address | NamedReference |
None. |
|
Carrier | NamedReference |
None. |
|
Transport | Transport |
None. |
|
TargetSendingStatus | SendingStatus |
None. |
Request Formats
application/json, text/json
Sample:
{ "Correspondent": { "Name": "sample string 1", "Url": "sample string 2", "Type": 0 }, "Address": { "Name": "sample string 1", "Url": "sample string 2", "Type": 0 }, "Carrier": { "Name": "sample string 1", "Url": "sample string 2", "Type": 0 }, "Transport": 0, "TargetSendingStatus": 0 }
application/xml, text/xml
Sample:
<ReceivingParams xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/openwork.JamioWebAPI.Models"> <_x003C_Address_x003E_k__BackingField xmlns:d2p1="http://www.openworkbpm.com/schema"> <d2p1:Type>Undefined</d2p1:Type> <d2p1:Url>sample string 2</d2p1:Url> <d2p1:Name>sample string 1</d2p1:Name> </_x003C_Address_x003E_k__BackingField> <_x003C_Carrier_x003E_k__BackingField xmlns:d2p1="http://www.openworkbpm.com/schema"> <d2p1:Type>Undefined</d2p1:Type> <d2p1:Url>sample string 2</d2p1:Url> <d2p1:Name>sample string 1</d2p1:Name> </_x003C_Carrier_x003E_k__BackingField> <_x003C_Correspondent_x003E_k__BackingField xmlns:d2p1="http://www.openworkbpm.com/schema"> <d2p1:Type>Undefined</d2p1:Type> <d2p1:Url>sample string 2</d2p1:Url> <d2p1:Name>sample string 1</d2p1:Name> </_x003C_Correspondent_x003E_k__BackingField> <_x003C_TargetSendingStatus_x003E_k__BackingField>None</_x003C_TargetSendingStatus_x003E_k__BackingField> <_x003C_Transport_x003E_k__BackingField>Unknown</_x003C_Transport_x003E_k__BackingField> </ReceivingParams>
application/x-www-form-urlencoded
Sample:
Response Information
Resource Description
HttpResponseMessageName | Description | Type | Additional information |
---|---|---|---|
Version | Version |
None. |
|
Content | HttpContent |
None. |
|
StatusCode | HttpStatusCode |
None. |
|
ReasonPhrase | string |
None. |
|
Headers | Collection of Object |
None. |
|
RequestMessage | HttpRequestMessage |
None. |
|
IsSuccessStatusCode | boolean |
None. |