POST DisplayStates/Rename

Renames the display state.

Request Information

URI Parameters

None.

Body Parameters

The parameter.

RenameDisplayStateParams
NameDescriptionTypeAdditional information
DisplayStateName

Gets or sets the displaystate name.

string

None.

DisplayStateUuid

Gets or sets the display state UUID.

string

None.

UserLogin

Gets or sets the user login.

string

None.

ContextUid

Gets or sets the context uid for multi data source support.

string

None.

Request Formats

application/json, text/json

Sample:
{
  "DisplayStateName": "sample string 1",
  "DisplayStateUuid": "sample string 2",
  "UserLogin": "sample string 3",
  "ContextUid": "sample string 4"
}

application/xml, text/xml

Sample:
<RenameDisplayStateParams xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Fujifilm.Synapse.Workflow.Engine.Models.DisplayStates">
  <ContextUid>sample string 4</ContextUid>
  <DisplayStateName>sample string 1</DisplayStateName>
  <DisplayStateUuid>sample string 2</DisplayStateUuid>
  <UserLogin>sample string 3</UserLogin>
</RenameDisplayStateParams>

Response Information

Resource Description

DisplayStateResult
NameDescriptionTypeAdditional information
Succeeded

Denotes whether the display states process request has been successful or not.

boolean

None.

Remarks

Gets or sets the remarks.

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Succeeded": true,
  "Remarks": "sample string 2"
}

application/xml, text/xml

Sample:
<DisplayStateResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Fujifilm.Synapse.Workflow.Engine.Models.DisplayStates">
  <Remarks>sample string 2</Remarks>
  <Succeeded>true</Succeeded>
</DisplayStateResult>