POST api/Entity/BatchChangeStage

Validates stage constrains against a specific stage

Request Information

URI Parameters

None.

Body Parameters

Batch change stage model

WorkPoint365.WebAPI.Model.BatchChangeStageParameter

Name	Description	Type	Additional information
BusinessModuleId	The id of the entity list	globally unique identifier	Required
Entities	The id of the entity item	Collection of Object	Required
EntityItemIds		Collection of integer	None.
StageModelId	Stage Model ID	Object	Required
StageId	The id for the stage (content type) to change to	string	Required
SubStageTermId	The Term Id of the selected substage to change to	globally unique identifier	None.
FieldValues	Field values to be updated	Dictionary of string [key] and Object [value]	None.
RunProcessAs		WorkPoint365.WebAPI.Model.BatchChangeStageParameter+RunAs	Required

Request Formats

application/json, text/json

Sample:

{
  "BusinessModuleId": "6456d87a-4dbb-4e0f-aaca-046a124efcf2",
  "Entities": null,
  "EntityItemIds": [
    1,
    2
  ],
  "StageModelId": {},
  "StageId": "sample string 3",
  "SubStageTermId": "8c60ebe3-e6cb-43ad-bfb5-a4d409566464",
  "FieldValues": {
    "sample string 1": {},
    "sample string 3": {}
  },
  "RunProcessAs": 0
}

application/xml, text/xml

Sample:

<BatchChangeStageParameter xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WorkPoint365.WebAPI.Model">
  <BusinessModuleId>6456d87a-4dbb-4e0f-aaca-046a124efcf2</BusinessModuleId>
  <Entities xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
  <EntityItemIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </EntityItemIds>
  <FieldValues xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringanyType>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Value />
    </d2p1:KeyValueOfstringanyType>
    <d2p1:KeyValueOfstringanyType>
      <d2p1:Key>sample string 3</d2p1:Key>
      <d2p1:Value />
    </d2p1:KeyValueOfstringanyType>
  </FieldValues>
  <RunProcessAs>Synchronous</RunProcessAs>
  <StageId>sample string 3</StageId>
  <StageModelId />
  <SubStageTermId>8c60ebe3-e6cb-43ad-bfb5-a4d409566464</SubStageTermId>
</BatchChangeStageParameter>

Response Information

Resource Description

Returns a JSON of Stage Validation status

System.Web.Http.IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.