What Is The Workflow Of Soap Service
The Lather setup
The Lather API Workflow Service asset manages the Workflow functions of the SOAP Server including approving an asset in workflow and starting workflow.
To add a SOAP API Workflow Service, go to Web Services -> SOAP API Workflow Service. For the API to piece of work, information technology must be created under a Lather Server within the Web Services folder, equally shown in the figure to the right. The API volition then be bachelor to enable on the Details screen of the Lather Server, as shown in the figure beneath.
The SOAP API Permission And Role Service available on the SOAP Server
Yous can configure the settings of the Lather API Metadata Service on its associated nugget screens. The bulk of these screens are the same or similar to those for a Standard Page and are described in the Asset Screens transmission. In this affiliate nosotros will describe the Details screen, which is different for a Lather API Search Service.
Bookmarks to the headings on this page:
- Details Screen
- Operations
Details Screen
The Details screen allows you to configure the interface functions for the Lather API Permission and Function Service. For more information about the Status, Future Status, Thumbnail and Details sections,refer to the Details Screen chapter in the Nugget Screens manual.
Interface Settings
This department allows you to control which functions the Lather API Workflow Service will be able to provide when enabled on a SOAP Server. The Interface Settings section of the Details screen is shown in the effigy below.
The Interface Settings section of the Details screen
In the Function List, select Enabled for the functions you desire to make available on the API. For a full explanation of these functions, come across the Operations section below.
Operations
The operations that are managed by the Lather API Workflow Service are as follows:
- StartWorkflow
- SafeEditAsset
- CancelWorkflow
- CompleteWorkflow
- SetWorkflowSchema
- ApproveAssetInWorkflow
Come across the sections beneath for more information on each of the operations bachelor on this API.
StartWorkflow
| Elements - Parameter [Param Type ] | Min Occurs | Max Occurs | Type | |
|---|---|---|---|---|
| StartWorkflowSoapInput StartWorkflow | AssetID [string] | 1 | 1 | uncomplicated |
| StartWorkflowSoapOutput StartWorkflowResponse | StartWorkflowResult [boolean] | 0 | 1 | simple |
TheStartWorkflow performance will begin workflow for a specified nugget by changing its condition, for example: from Nether Construction to Pending Approval. The parameters bachelor for this operation are equally follows:
- AssetID: the asset ID of the asset to begin workflow on. This parameter is mandatory.
Instance Request
<Lather-ENV:Envelope xmlns:Lather-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="http://SYSTEM_ROOT_URL/_web_services/soap-server">
<SOAP-ENV:Trunk>
<ns1:StartWorkflow>
<AssetID>100</AssetID>
</ns1:StartWorkflow>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Instance Response
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/lather/envelope/" xmlns:ns1="http://SYSTEM_ROOT_URL/_web_services/soap-server">
<SOAP-ENV:Trunk>
<ns1:StartWorkflowResponse>
<StartWorkflowResult>true</StartWorkflowResult>
</ns1:StartWorkflowResponse>
</SOAP-ENV:Trunk>
</SOAP-ENV:Envelope>
SafeEditAsset
| Elements - Parameter [Param Type ] | Min Occurs | Max Occurs | Type | |
|---|---|---|---|---|
| SafeEditAssetSoapInput SafeEditAsset | AssetID [string] | one | 1 | simple |
| SafeEditAssetSoapOutput SafeEditAssetResponse | SafeEditAssetResult [boolean] | 0 | 1 | elementary |
The SafeEditAsset operation will alter a specified asset's status from Live to Prophylactic Edit. The parameters available for this operation are every bit follows:
- AssetID: the nugget ID of the asset whose status will be changed to Condom Edit. Please note that this nugget must have Alive condition for this functioning to work. This parameter is mandatory.
Example Request
<SOAP-ENV:Envelope xmlns:Soap-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="http://SYSTEM_ROOT_URL/_web_services/soap-server">
<SOAP-ENV:Body>
<ns1:SafeEditAsset>
<AssetID>100</AssetID>
</ns1:SafeEditAsset>
</SOAP-ENV:Body>
</Soap-ENV:Envelope>
Example Response
<SOAP-ENV:Envelope xmlns:Lather-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="http://SYSTEM_ROOT_URL/_web_services/soap-server">
<SOAP-ENV:Body>
<ns1:SafeEditAssetResponse>
<SafeEditAssetResult>true</SafeEditAssetResult>
</ns1:SafeEditAssetResponse>
</Lather-ENV:Body>
</SOAP-ENV:Envelope>
CancelWorkflow
| Elements - Parameter [Param Type ] | Min Occurs | Max Occurs | Blazon | |
|---|---|---|---|---|
| CancelWorkflowSoapInput CancelWorkflow | AssetID [string] | 1 | one | elementary |
| CancelWorkflowSoapOutput CancelWorkflowResponse | CancelWorkflowResult [boolean] | 0 | 1 | simple |
The CancelWorkflow performance will cancel any workflow currently running for a specified nugget. The parameters available for this operation are as follows:
- AssetID: the asset ID of the asset to cancel workflow on. This parameter is mandatory.
Example Request
<Soap-ENV:Envelope xmlns:Lather-ENV="http://schemas.xmlsoap.org/lather/envelope/" xmlns:ns1="http://SYSTEM_ROOT_URL/_web_services/soap-server">
<SOAP-ENV:Torso>
<ns1:CancelWorkflow>
<AssetID>100</AssetID>
</ns1:CancelWorkflow>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Example Response
<Soap-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="http://SYSTEM_ROOT_URL/_web_services/lather-server">
<Lather-ENV:Trunk>
<ns1:CancelWorkflowResponse>
<CancelWorkflowResult>true</CancelWorkflowResult>
</ns1:CancelWorkflowResponse>
</SOAP-ENV:Torso>
</SOAP-ENV:Envelope>
CompleteWorkflow
| Elements - Parameter [Param Blazon ] | Min Occurs | Max Occurs | Type | |
|---|---|---|---|---|
| CompleteWorkflowSoapInput CompleteWorkflow | AssetID [string] | 1 | 1 | uncomplicated |
| CompleteWorkflowSoapOutput CompleteWorkflowResponse | CompleteWorkflowResult [boolean] | 0 | ane | uncomplicated |
The CompleteWorkflow operation will complete whatever workflow currently running for a specified asset, making the nugget Live if it is already in Approved, Live Canonical or Editing Canonical status. The parameters available for this performance are as follows:
- AssetID: the asset ID of the asset to complete Workflow on. This parameter is mandatory.
Example Request
<SOAP-ENV:Envelope xmlns:Lather-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="http://SYSTEM_ROOT_URL/_web_services/soap-server">
<Lather-ENV:Body>
<ns1:CompleteWorkflow>
<AssetID>100</AssetID>
</ns1:CompleteWorkflow>
</Lather-ENV:Body>
</Soap-ENV:Envelope>
Example Response
<Soap-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="http://SYSTEM_ROOT_URL/_web_services/soap-server">
<SOAP-ENV:Body>
<ns1:CompleteWorkflowResponse>
<CompleteWorkflowResult>truthful</CompleteWorkflowResult>
</ns1:CompleteWorkflowResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
SetWorkflowSchema
| Elements - Parameter [Param Type ] | Min Occurs | Max Occurs | Blazon | |
|---|---|---|---|---|
| SetWorkflowSchemaSoapInput SetWorkflowSchema | AssetID [string] SchemaID [cord] Grant [Grant] AutoCascadeToNewChildren [boolean] Cascade [boolean] | 1 1 1 0 0 | i 1 1 1 i | simple unproblematic uncomplicated uncomplicated elementary |
| SetWorkflowSchemaSoapOutput SetWorkflowSchemaResponse | SetWorkflowSchemaResult [boolean] | 0 | ane | simple |
The SetWorkflowSchema operation will utilise, deny or revoke (delete the schema from the specified asset) a Workflow Schema on a specified asset. The parameters available for this functioning are equally follows:
- AssetID: the asset ID of the asset where the Workflow Schema is set. This parameter is mandatory.
- SchemaID: the asset ID of the Workflow Schema. This parameter is mandatory.
- Grant: the grant that will make up one's mind how the Workflow Schema is implemented, for example Apply. This parameter is mandatory.
- AutoCascadeToNewChildren: indicates whether the Workflow Schema will exist cascaded to all future child assets. The value for this parameter should be either Truthful or Fake (or 1 or 0). The default value for this parameter is TRUE.
- Pour: indicates whether the Workflow Schema will be cascaded to all current kid avails. The value for this parameter should exist either Truthful or Faux (or 1 or 0). The default value for this parameter is TRUE.
Example Request
<SOAP-ENV:Envelope xmlns:Lather-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="http://SYSTEM_ROOT_URL/_web_services/soap-server">
<Lather-ENV:Body>
<ns1:SetWorkflowSchema>
<AssetID>100</AssetID>
<SchemaID>150</SchemaID>
<Grant>Apply</Grant>
<AutoCascadeToNewChildren>False</AutoCascadeToNewChildren>
<Pour>True</Pour>
</ns1:SetWorkflowSchema>
</Soap-ENV:Body>
</SOAP-ENV:Envelope>
Example Response
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/lather/envelope/" xmlns:ns1="http://SYSTEM_ROOT_URL/_web_services/soap-server">
<Soap-ENV:Body>
<ns1:SetWorkflowSchemaResponse>
<SetWorkflowSchemaResult>true</SetWorkflowSchemaResult>
</ns1:SetWorkflowSchemaResponse>
</SOAP-ENV:Trunk>
</SOAP-ENV:Envelope>
ApproveAssetInWorkflow
| Elements - Parameter [Param Type ] | Min Occurs | Max Occurs | Type | |
|---|---|---|---|---|
| ApproveAssetInWorkflowSoapInput ApproveAssetInWorkflow | AssetID [string] WorkflowMessage [string] | 1 0 | 1 1 | unproblematic elementary |
| ApproveAssetInWorkflowSoapOutput ApproveAssetInWorkflowResponse | ApproveAssetInWorkflowResult [cord] | 0 | 1 | simple |
The ApproveAssetInWorkflow operation will corroborate any workflow currently running for a specified asset, progressing the asset to the next workflow step. Please notation that you must have user permission to approve the workflow footstep for this performance to work. The parameters bachelor for this operation are as follows:
- AssetID: the nugget ID of the asset where workflow will be approved. This parameter is mandatory.
- WorkflowMessage: the approval message for the approved workflow.
Example Request
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/lather/envelope/" xmlns:ns1="http://SYSTEM_ROOT_URL/_web_services/soap-server">
<SOAP-ENV:Torso>
<ns1:ApproveAssetInWorkflow>
<AssetID>100</AssetID>
<WorkflowMessage>Approving Message</WorkflowMessage>
</ns1:ApproveAssetInWorkflow>
</Soap-ENV:Trunk>
</SOAP-ENV:Envelope>
Example Response
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="http://SYSTEM_ROOT_URL/_web_services/lather-server">
<SOAP-ENV:Trunk>
<ns1:ApproveAssetInWorkflowResponse>
<ApproveAssetInWorkflowResult>1</ApproveAssetInWorkflowResult>
</ns1:ApproveAssetInWorkflowResponse>
</Lather-ENV:Trunk>
</Lather-ENV:Envelope>
What Is The Workflow Of Soap Service,
Source: https://matrix.squiz.net/manuals/web-services/chapters/soap-api-workflow-service
Posted by: sandershunne1994.blogspot.com
0 Response to "What Is The Workflow Of Soap Service"
Post a Comment