SOAP API workflow service

The SOAP API workflow service setup

The SOAP 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

The SOAP API permission and role service available on the SOAP server

You can configure the settings of the SOAP API metadata service on its associated asset screens. The majority of these screens are similar to those for a standard page. They are described in the Asset screens documentation. This documentation will describe the Details screen, which is different for a SOAP API search service.

Details screen

The Details screen allows you to configure the interface functions for the SOAP API permission and role service. Read the Asset screens documentation for more information about the Status, Future status, Thumbnail, and Details sections.

Interface settings

This section allows you to control which functions the SOAP 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 figure.

The interface settings section on the SOAP API workflow service

In the function list, select enabled for the functions you want to make available on the API.

Operations

StartWorkflow

TheStartWorkflow operation will begin workflow for a specified asset by changing its status, for example: from Under construction to Pending approval. The parameters available for this operation are as follows:

StartWorkflowSoapInput (StartWorkflow)

Elements - Parameter [Param Type] Description Min Occurs Max Occurs Type

AssetID [string]

The asset ID of the asset to begin workflow on. This parameter is mandatory.

1

1

simple

Example 1. StartWorkflow 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:StartWorkflow>
      <AssetID>100</AssetID>
    </ns1:StartWorkflow>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

StartWorkflowSoapOutput (StartWorkflowResponse)

Elements - Parameter [Param Type] Min Occurs Max Occurs Type

StartWorkflowResult [boolean]

0

1

simple

Example 2. StartWorkflow 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:StartWorkflowResponse>
      <StartWorkflowResult>true</StartWorkflowResult>
    </ns1:StartWorkflowResponse>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

SafeEditAsset

The SafeEditAsset operation will change a specified asset’s status from Live to Safe edit. The parameters available for this operation are as follows:

SafeEditAssetSoapInput (SafeEditAsset)

Elements - Parameter [Param Type] Description Min Occurs Max Occurs Type

AssetID [string]

The asset ID of the asset whose status will be changed to Safe edit.

This asset must have Live status for this operation to work. This parameter is mandatory.

1

1

simple

Example 3. SafeEditAsset 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>

SafeEditAssetSoapOutput (SafeEditAssetResponse)

Elements - Parameter [Param Type] Min Occurs Max Occurs Type

SafeEditAssetResult [boolean]

0

1

simple

Example 4. SafeEditAsset 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:SafeEditAssetResponse>
      <SafeEditAssetResult>true</SafeEditAssetResult>
    </ns1:SafeEditAssetResponse>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

CancelWorkflow

The CancelWorkflow operation will cancel any workflow currently running for a specified asset. The parameters available for this operation are as follows:

CancelWorkflowSoapInput (CancelWorkflow)

Elements - Parameter [Param Type] Description Min Occurs Max Occurs Type

AssetID [string]

The asset ID of the asset to cancel workflow on. This parameter is mandatory.

1

1

simple

Example 5. CancelWorkflow 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:CancelWorkflow>
      <AssetID>100</AssetID>
    </ns1:CancelWorkflow>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

CancelWorkflowSoapOutput (CancelWorkflowResponse)

Elements - Parameter [Param Type] Min Occurs Max Occurs Type

CancelWorkflowResult [boolean]

0

1

simple

Example 6. CancelWorkflow 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:CancelWorkflowResponse>
      <CancelWorkflowResult>true</CancelWorkflowResult>
    </ns1:CancelWorkflowResponse>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

CompleteWorkflow

The CompleteWorkflow operation will complete any workflow currently running for a specified asset, making the asset Live if it is already in Approved, Live approved or Editing approved status. The parameters available for this operation are as follows:

CompleteWorkflowSoapInput (CompleteWorkflow)

Elements - Parameter [Param Type] Description Min Occurs Max Occurs Type

AssetID [string]

The asset ID of the asset to complete Workflow on. This parameter is mandatory.

1

1

simple

Example 7. CompleteWorkflow 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:CompleteWorkflow>
      <AssetID>100</AssetID>
    </ns1:CompleteWorkflow>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

CompleteWorkflowSoapOutput (CompleteWorkflowResponse)

Elements - Parameter [Param Type] Min Occurs Max Occurs Type

CompleteWorkflowResult [boolean]

0

1

simple

Example 8. CompleteWorkflow 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>true</CompleteWorkflowResult>
    </ns1:CompleteWorkflowResponse>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

SetWorkflowSchema

SetWorkflowSchemaSoapInput (SetWorkflowSchema)

Elements - Parameter [Param Type] Description Min Occurs Max Occurs Type

AssetID [string]

The asset ID of the asset where the workflow schema is set. This parameter is mandatory.

1

1

simple

SchemaID [string]

The asset ID of the workflow schema. This parameter is mandatory.

1

1

simple

Grant [Grant]

The grant that will determine how the workflow schema is implemented, for example Apply. This parameter is mandatory.

1

1

simple

AutoCascadeToNewChildren [boolean]

Indicates whether the workflow schema will be cascaded to all future child assets. The value for this parameter should be either TRUE or FALSE (or 1 or 0). The default value for this parameter is TRUE.

0

1

simple

Cascade [boolean]

Indicates whether the workflow schema will be cascaded to all current child assets. The value for this parameter should be either TRUE or FALSE (or 1 or 0). The default value for this parameter is TRUE.

0

1

simple

Example 9. SetWorkflowSchema 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:SetWorkflowSchema>
      <AssetID>100</AssetID>
      <SchemaID>150</SchemaID>
      <Grant>Apply</Grant>
      <AutoCascadeToNewChildren>FALSE</AutoCascadeToNewChildren>
      <Cascade>TRUE</Cascade>
    </ns1:SetWorkflowSchema>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

SetWorkflowSchemaSoapOutput (SetWorkflowSchemaResponse)

Elements - Parameter [Param Type] Min Occurs Max Occurs Type

SetWorkflowSchemaResult [boolean]

0

1

simple

Example 10. SetWorkflowSchema 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:SetWorkflowSchemaResponse>
      <SetWorkflowSchemaResult>true</SetWorkflowSchemaResult>
    </ns1:SetWorkflowSchemaResponse>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

ApproveAssetInWorkflow

The ApproveAssetInWorkflow operation will approve any workflow currently running for a specified asset, progressing the asset to the next workflow step.

You must have user permission to approve the workflow step for this operation to work.

The parameters available for this operation are as follows:

ApproveAssetInWorkflowSoapInput (ApproveAssetInWorkflow)

Elements - Parameter [Param Type] Description Min Occurs Max Occurs Type

AssetID [string]

The asset ID of the asset where workflow will be approved. This parameter is mandatory.

1

1

simple

WorkflowMessage [string]

The approval message for the approved workflow.

0

1

simple

Example 11. ApproveAssetInWorkflow 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:ApproveAssetInWorkflow>
      <AssetID>100</AssetID>
      <WorkflowMessage>Approval Message</WorkflowMessage>
    </ns1:ApproveAssetInWorkflow>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

ApproveAssetInWorkflowSoapOutput (ApproveAssetInWorkflowResponse)

Elements - Parameter [Param Type] Min Occurs Max Occurs Type

ApproveAssetInWorkflowResult [string]

0

1

simple

Example 12. ApproveAssetInWorkflow 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:ApproveAssetInWorkflowResponse>
      <ApproveAssetInWorkflowResult>1</ApproveAssetInWorkflowResult>
    </ns1:ApproveAssetInWorkflowResponse>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

© 2015- Squiz Pty Ltd