Process_Close - Process_Close - Content Composer - Web Services - Content-Composer/Web-Services/Foundation-24.1/Content-Composer-Web-Services/WS-Process/Functions/Process_Close - Foundation 24.1 - Foundation 24.1

Content Composer Web Services

Platform
Content Composer
Product
Web Services
Release
Foundation 24.1
License
ft:lastPublication
2024-12-09T09:10:54.777000
ft:locale
en-US

Closes a process with the passed in status.

Syntax

Process_Close(string sessionId,string processId,int status,string options,out string xmlResult)
Parameter Description

sessionId

Valid session identifier (SessionId)

processId

ID of the process to be closed.

status

Status to be set

0: Save process. Handling of processes with status 0 can be resumed.

1: The process is currently being edited. The value 1 is used internally and should not be passed in, as it causes an error.

2: The process was completed successfully. The service MWS_Assistant automatically deletes processes saved with the status 2.

3: The process was faulty, for example, user abort. Defective or faulty processes are not automatically deleted by the service MWS_Assistant. The Client explicitly deletes the processes aborted by a user.

Other values: Process is closed.

options

Options XML for closing a process with specification of title and description.

Example XML for setting title and description:

<?xml version="1.0" encoding="utf-16"?>
<mws>
   <process>
      <title>My Title</title>
      <description>My description</description>
   </process>
</mws>

xmlResult

Empty when okay

Return Value

Value Description
0 OK
<>0

Error

See Error Codes.