Workflow Manager API

Jobs

addAttachments

Add an attachment to a job

Add an attachment to a job to provide additional or support information related to the job. The **jobUpdateAttachments** privilege is required to add an attachment to a job.


/workflow/{itemId}/jobs/{jobId}/attachments

Usage and SDK Samples

curl -X POST\
 -H "Accept: application/json"\
 -H "Content-Type: multipart/form-data"\
 "http://localhost/workflow/{itemId}/jobs/{jobId}/attachments"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.JobsApi;

import java.io.File;
import java.util.*;

public class JobsApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        JobsApi apiInstance = new JobsApi();
        String jobId = jobId_example; // String | 
        String itemId = itemId_example; // String | 
        String token = token_example; // String | 
        File attachment = BINARY_DATA_HERE; // File | The file to be uploaded and attached to the job.
        String alias = alias_example; // String | Display name for the attachment.
        String folder = folder_example; // String | Folder under which the attachment will be stored.
        
        try {
            inline_response_200_13 result = apiInstance.addAttachments(jobId, itemId, token, attachment, alias, folder);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobsApi#addAttachments");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.JobsApi;

public class JobsApiExample {
    public static void main(String[] args) {
        JobsApi apiInstance = new JobsApi();
        String jobId = jobId_example; // String | 
        String itemId = itemId_example; // String | 
        String token = token_example; // String | 
        File attachment = BINARY_DATA_HERE; // File | The file to be uploaded and attached to the job.
        String alias = alias_example; // String | Display name for the attachment.
        String folder = folder_example; // String | Folder under which the attachment will be stored.
        
        try {
            inline_response_200_13 result = apiInstance.addAttachments(jobId, itemId, token, attachment, alias, folder);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobsApi#addAttachments");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
JobsApi *apiInstance = [[JobsApi alloc] init];
String *jobId = jobId_example; //  (default to null)
String *itemId = itemId_example; //  (default to null)
String *token = token_example; //  (default to null)
File *attachment = BINARY_DATA_HERE; // The file to be uploaded and attached to the job. (default to null)
String *alias = alias_example; // Display name for the attachment. (optional) (default to null)
String *folder = folder_example; // Folder under which the attachment will be stored. (optional) (default to null)

// Add an attachment to a job
[apiInstance addAttachmentsWith:jobId
    itemId:itemId
    token:token
    attachment:attachment
    alias:alias
    folder:folder
              completionHandler: ^(inline_response_200_13 output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var WorkflowManagerApi = require('workflow_manager_api');

// Create an instance of the API class
var api = new WorkflowManagerApi.JobsApi()
var jobId = jobId_example; // {String} 
var itemId = itemId_example; // {String} 
var token = token_example; // {String} 
var attachment = BINARY_DATA_HERE; // {File} The file to be uploaded and attached to the job.
var opts = {
  'alias': alias_example, // {String} Display name for the attachment.
  'folder': folder_example // {String} Folder under which the attachment will be stored.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.addAttachments(jobId, itemId, token, attachment, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class addAttachmentsExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new JobsApi();
            var jobId = jobId_example;  // String |  (default to null)
            var itemId = itemId_example;  // String |  (default to null)
            var token = token_example;  // String |  (default to null)
            var attachment = BINARY_DATA_HERE;  // File | The file to be uploaded and attached to the job. (default to null)
            var alias = alias_example;  // String | Display name for the attachment. (optional)  (default to null)
            var folder = folder_example;  // String | Folder under which the attachment will be stored. (optional)  (default to null)

            try {
                // Add an attachment to a job
                inline_response_200_13 result = apiInstance.addAttachments(jobId, itemId, token, attachment, alias, folder);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling JobsApi.addAttachments: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\JobsApi();
$jobId = jobId_example; // String | 
$itemId = itemId_example; // String | 
$token = token_example; // String | 
$attachment = BINARY_DATA_HERE; // File | The file to be uploaded and attached to the job.
$alias = alias_example; // String | Display name for the attachment.
$folder = folder_example; // String | Folder under which the attachment will be stored.

try {
    $result = $api_instance->addAttachments($jobId, $itemId, $token, $attachment, $alias, $folder);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling JobsApi->addAttachments: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::JobsApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::JobsApi->new();
my $jobId = jobId_example; # String | 
my $itemId = itemId_example; # String | 
my $token = token_example; # String | 
my $attachment = BINARY_DATA_HERE; # File | The file to be uploaded and attached to the job.
my $alias = alias_example; # String | Display name for the attachment.
my $folder = folder_example; # String | Folder under which the attachment will be stored.

eval { 
    my $result = $api_instance->addAttachments(jobId => $jobId, itemId => $itemId, token => $token, attachment => $attachment, alias => $alias, folder => $folder);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling JobsApi->addAttachments: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.JobsApi()
jobId = jobId_example # String |  (default to null)
itemId = itemId_example # String |  (default to null)
token = token_example # String |  (default to null)
attachment = BINARY_DATA_HERE # File | The file to be uploaded and attached to the job. (default to null)
alias = alias_example # String | Display name for the attachment. (optional) (default to null)
folder = folder_example # String | Folder under which the attachment will be stored. (optional) (default to null)

try: 
    # Add an attachment to a job
    api_response = api_instance.add_attachments(jobId, itemId, token, attachment, alias=alias, folder=folder)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling JobsApi->addAttachments: %s\n" % e)
extern crate JobsApi;

pub fn main() {
    let jobId = jobId_example; // String
    let itemId = itemId_example; // String
    let token = token_example; // String
    let attachment = BINARY_DATA_HERE; // File
    let alias = alias_example; // String
    let folder = folder_example; // String

    let mut context = JobsApi::Context::default();
    let result = client.addAttachments(jobId, itemId, token, attachment, alias, folder, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
jobId*
String
Required
itemId*
String
Required
Form parameters
Name Description
token*
String
Required
attachment*
File (binary)
The file to be uploaded and attached to the job.
Required
alias
String
Display name for the attachment.
folder
String
Folder under which the attachment will be stored.

Responses


addAttachmentsLinked

Add linked attachments to a job

Add linked attachments to a job to provide additional or support information related to the job. Linked attachments can be links to a file on a local or shared file system or a URL. The **jobUpdateAttachments** privilege is required to add an attachment to a job.


/workflow/{itemId}/jobs/{jobId}/attachmentslinked

Usage and SDK Samples

curl -X POST\
 -H "Accept: application/json"\
 -H "Content-Type: application/json"\
 "http://localhost/workflow/{itemId}/jobs/{jobId}/attachmentslinked?token="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.JobsApi;

import java.io.File;
import java.util.*;

public class JobsApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        JobsApi apiInstance = new JobsApi();
        String jobId = jobId_example; // String | 
        String itemId = itemId_example; // String | 
        String token = token_example; // String | 
        EsriWorkflowModelsRestJobAttachmentLinkedBody body = ; // EsriWorkflowModelsRestJobAttachmentLinkedBody | 
        
        try {
            inline_response_200_14 result = apiInstance.addAttachmentsLinked(jobId, itemId, token, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobsApi#addAttachmentsLinked");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.JobsApi;

public class JobsApiExample {
    public static void main(String[] args) {
        JobsApi apiInstance = new JobsApi();
        String jobId = jobId_example; // String | 
        String itemId = itemId_example; // String | 
        String token = token_example; // String | 
        EsriWorkflowModelsRestJobAttachmentLinkedBody body = ; // EsriWorkflowModelsRestJobAttachmentLinkedBody | 
        
        try {
            inline_response_200_14 result = apiInstance.addAttachmentsLinked(jobId, itemId, token, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobsApi#addAttachmentsLinked");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
JobsApi *apiInstance = [[JobsApi alloc] init];
String *jobId = jobId_example; //  (default to null)
String *itemId = itemId_example; //  (default to null)
String *token = token_example; //  (optional) (default to null)
EsriWorkflowModelsRestJobAttachmentLinkedBody *body = ; //  (optional)

// Add linked attachments to a job
[apiInstance addAttachmentsLinkedWith:jobId
    itemId:itemId
    token:token
    body:body
              completionHandler: ^(inline_response_200_14 output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var WorkflowManagerApi = require('workflow_manager_api');

// Create an instance of the API class
var api = new WorkflowManagerApi.JobsApi()
var jobId = jobId_example; // {String} 
var itemId = itemId_example; // {String} 
var opts = {
  'token': token_example, // {String} 
  'body':  // {EsriWorkflowModelsRestJobAttachmentLinkedBody} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.addAttachmentsLinked(jobId, itemId, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class addAttachmentsLinkedExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new JobsApi();
            var jobId = jobId_example;  // String |  (default to null)
            var itemId = itemId_example;  // String |  (default to null)
            var token = token_example;  // String |  (optional)  (default to null)
            var body = new EsriWorkflowModelsRestJobAttachmentLinkedBody(); // EsriWorkflowModelsRestJobAttachmentLinkedBody |  (optional) 

            try {
                // Add linked attachments to a job
                inline_response_200_14 result = apiInstance.addAttachmentsLinked(jobId, itemId, token, body);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling JobsApi.addAttachmentsLinked: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\JobsApi();
$jobId = jobId_example; // String | 
$itemId = itemId_example; // String | 
$token = token_example; // String | 
$body = ; // EsriWorkflowModelsRestJobAttachmentLinkedBody | 

try {
    $result = $api_instance->addAttachmentsLinked($jobId, $itemId, $token, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling JobsApi->addAttachmentsLinked: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::JobsApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::JobsApi->new();
my $jobId = jobId_example; # String | 
my $itemId = itemId_example; # String | 
my $token = token_example; # String | 
my $body = WWW::OPenAPIClient::Object::EsriWorkflowModelsRestJobAttachmentLinkedBody->new(); # EsriWorkflowModelsRestJobAttachmentLinkedBody | 

eval { 
    my $result = $api_instance->addAttachmentsLinked(jobId => $jobId, itemId => $itemId, token => $token, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling JobsApi->addAttachmentsLinked: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.JobsApi()
jobId = jobId_example # String |  (default to null)
itemId = itemId_example # String |  (default to null)
token = token_example # String |  (optional) (default to null)
body =  # EsriWorkflowModelsRestJobAttachmentLinkedBody |  (optional)

try: 
    # Add linked attachments to a job
    api_response = api_instance.add_attachments_linked(jobId, itemId, token=token, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling JobsApi->addAttachmentsLinked: %s\n" % e)
extern crate JobsApi;

pub fn main() {
    let jobId = jobId_example; // String
    let itemId = itemId_example; // String
    let token = token_example; // String
    let body = ; // EsriWorkflowModelsRestJobAttachmentLinkedBody

    let mut context = JobsApi::Context::default();
    let result = client.addAttachmentsLinked(jobId, itemId, token, body, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
jobId*
String
Required
itemId*
String
Required
Body parameters
Name Description
body

Array of linked attachments to assoicate with the job

Query parameters
Name Description
token
String

Responses


addJobComment

Create a job comment

Adds a comment to a job. Job comments are associated to a specific job using the jobId. Users must have the job's associated job template shared with them to add a job comment. **Job Comment Parameters:** | Parameter | Description | Data Type | | ----------- | ----------- | --------- | | comment | Required. The contents of the comment | String |


/workflow/{itemId}/jobs/{jobId}/comments

Usage and SDK Samples

curl -X POST\
 -H "Accept: application/json"\
 -H "Content-Type: application/json"\
 "http://localhost/workflow/{itemId}/jobs/{jobId}/comments?token="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.JobsApi;

import java.io.File;
import java.util.*;

public class JobsApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        JobsApi apiInstance = new JobsApi();
        String jobId = jobId_example; // String | 
        String itemId = itemId_example; // String | 
        String token = token_example; // String | 
        JobComment body = ; // JobComment | 
        
        try {
            inline_response_200_16 result = apiInstance.addJobComment(jobId, itemId, token, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobsApi#addJobComment");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.JobsApi;

public class JobsApiExample {
    public static void main(String[] args) {
        JobsApi apiInstance = new JobsApi();
        String jobId = jobId_example; // String | 
        String itemId = itemId_example; // String | 
        String token = token_example; // String | 
        JobComment body = ; // JobComment | 
        
        try {
            inline_response_200_16 result = apiInstance.addJobComment(jobId, itemId, token, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobsApi#addJobComment");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
JobsApi *apiInstance = [[JobsApi alloc] init];
String *jobId = jobId_example; //  (default to null)
String *itemId = itemId_example; //  (default to null)
String *token = token_example; //  (optional) (default to null)
JobComment *body = ; //  (optional)

// Create a job comment
[apiInstance addJobCommentWith:jobId
    itemId:itemId
    token:token
    body:body
              completionHandler: ^(inline_response_200_16 output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var WorkflowManagerApi = require('workflow_manager_api');

// Create an instance of the API class
var api = new WorkflowManagerApi.JobsApi()
var jobId = jobId_example; // {String} 
var itemId = itemId_example; // {String} 
var opts = {
  'token': token_example, // {String} 
  'body':  // {JobComment} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.addJobComment(jobId, itemId, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class addJobCommentExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new JobsApi();
            var jobId = jobId_example;  // String |  (default to null)
            var itemId = itemId_example;  // String |  (default to null)
            var token = token_example;  // String |  (optional)  (default to null)
            var body = new JobComment(); // JobComment |  (optional) 

            try {
                // Create a job comment
                inline_response_200_16 result = apiInstance.addJobComment(jobId, itemId, token, body);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling JobsApi.addJobComment: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\JobsApi();
$jobId = jobId_example; // String | 
$itemId = itemId_example; // String | 
$token = token_example; // String | 
$body = ; // JobComment | 

try {
    $result = $api_instance->addJobComment($jobId, $itemId, $token, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling JobsApi->addJobComment: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::JobsApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::JobsApi->new();
my $jobId = jobId_example; # String | 
my $itemId = itemId_example; # String | 
my $token = token_example; # String | 
my $body = WWW::OPenAPIClient::Object::JobComment->new(); # JobComment | 

eval { 
    my $result = $api_instance->addJobComment(jobId => $jobId, itemId => $itemId, token => $token, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling JobsApi->addJobComment: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.JobsApi()
jobId = jobId_example # String |  (default to null)
itemId = itemId_example # String |  (default to null)
token = token_example # String |  (optional) (default to null)
body =  # JobComment |  (optional)

try: 
    # Create a job comment
    api_response = api_instance.add_job_comment(jobId, itemId, token=token, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling JobsApi->addJobComment: %s\n" % e)
extern crate JobsApi;

pub fn main() {
    let jobId = jobId_example; // String
    let itemId = itemId_example; // String
    let token = token_example; // String
    let body = ; // JobComment

    let mut context = JobsApi::Context::default();
    let result = client.addJobComment(jobId, itemId, token, body, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
jobId*
String
Required
itemId*
String
Required
Body parameters
Name Description
body

a job comment object defining the comment

Query parameters
Name Description
token
String

Responses


assignStep

Update the assignment of the current step on a job

Update the assignment of the current step in a job based on the current user's Workflow Manager assignment privileges. Updating a step assignment creates a new job progress document for it with the new assignment and a notification is sent to apps listening to it. The different privileges provide different levels of access for changing assignments. The behavior for each privilege is detailed in help topic for Privileges(insert link here when available). If you have more than one privilege, you get access based on your highest privilege level. Jobs can be unassigned and unassigned jobs can be assigned to users or groups as per the privilege level. A step can be assigned without specifying the ``stepId`` and instead ``currentStep`` can be used to denote the current step. The assignment is not updated in the following cases: * If the step is not the current step on the job. * If the job is closed. * If the step is currently executing. * If the group is not associated with Workflow Manager role. * If the group is a private group that the current user is not associated with. * If a value is not provided for user or group. * If the value provided for user or group doesn't exist. * If the job does not have a diagram associated with it.


/workflow/{itemId}/jobs/{jobId}/{stepId}

Usage and SDK Samples

curl -X POST\
 -H "Accept: application/json"\
 -H "Content-Type: application/json"\
 "http://localhost/workflow/{itemId}/jobs/{jobId}/{stepId}?token="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.JobsApi;

import java.io.File;
import java.util.*;

public class JobsApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        JobsApi apiInstance = new JobsApi();
        String jobId = jobId_example; // String | 
        String stepId = stepId_example; // String | 
        String itemId = itemId_example; // String | 
        String token = token_example; // String | 
        EsriWorkflowModelsRestAssignmentBody body = ; // EsriWorkflowModelsRestAssignmentBody | 
        
        try {
            Success result = apiInstance.assignStep(jobId, stepId, itemId, token, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobsApi#assignStep");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.JobsApi;

public class JobsApiExample {
    public static void main(String[] args) {
        JobsApi apiInstance = new JobsApi();
        String jobId = jobId_example; // String | 
        String stepId = stepId_example; // String | 
        String itemId = itemId_example; // String | 
        String token = token_example; // String | 
        EsriWorkflowModelsRestAssignmentBody body = ; // EsriWorkflowModelsRestAssignmentBody | 
        
        try {
            Success result = apiInstance.assignStep(jobId, stepId, itemId, token, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobsApi#assignStep");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
JobsApi *apiInstance = [[JobsApi alloc] init];
String *jobId = jobId_example; //  (default to null)
String *stepId = stepId_example; //  (default to null)
String *itemId = itemId_example; //  (default to null)
String *token = token_example; //  (optional) (default to null)
EsriWorkflowModelsRestAssignmentBody *body = ; //  (optional)

// Update the assignment of the current step on a job
[apiInstance assignStepWith:jobId
    stepId:stepId
    itemId:itemId
    token:token
    body:body
              completionHandler: ^(Success output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var WorkflowManagerApi = require('workflow_manager_api');

// Create an instance of the API class
var api = new WorkflowManagerApi.JobsApi()
var jobId = jobId_example; // {String} 
var stepId = stepId_example; // {String} 
var itemId = itemId_example; // {String} 
var opts = {
  'token': token_example, // {String} 
  'body':  // {EsriWorkflowModelsRestAssignmentBody} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.assignStep(jobId, stepId, itemId, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class assignStepExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new JobsApi();
            var jobId = jobId_example;  // String |  (default to null)
            var stepId = stepId_example;  // String |  (default to null)
            var itemId = itemId_example;  // String |  (default to null)
            var token = token_example;  // String |  (optional)  (default to null)
            var body = new EsriWorkflowModelsRestAssignmentBody(); // EsriWorkflowModelsRestAssignmentBody |  (optional) 

            try {
                // Update the assignment of the current step on a job
                Success result = apiInstance.assignStep(jobId, stepId, itemId, token, body);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling JobsApi.assignStep: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\JobsApi();
$jobId = jobId_example; // String | 
$stepId = stepId_example; // String | 
$itemId = itemId_example; // String | 
$token = token_example; // String | 
$body = ; // EsriWorkflowModelsRestAssignmentBody | 

try {
    $result = $api_instance->assignStep($jobId, $stepId, $itemId, $token, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling JobsApi->assignStep: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::JobsApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::JobsApi->new();
my $jobId = jobId_example; # String | 
my $stepId = stepId_example; # String | 
my $itemId = itemId_example; # String | 
my $token = token_example; # String | 
my $body = WWW::OPenAPIClient::Object::EsriWorkflowModelsRestAssignmentBody->new(); # EsriWorkflowModelsRestAssignmentBody | 

eval { 
    my $result = $api_instance->assignStep(jobId => $jobId, stepId => $stepId, itemId => $itemId, token => $token, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling JobsApi->assignStep: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.JobsApi()
jobId = jobId_example # String |  (default to null)
stepId = stepId_example # String |  (default to null)
itemId = itemId_example # String |  (default to null)
token = token_example # String |  (optional) (default to null)
body =  # EsriWorkflowModelsRestAssignmentBody |  (optional)

try: 
    # Update the assignment of the current step on a job
    api_response = api_instance.assign_step(jobId, stepId, itemId, token=token, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling JobsApi->assignStep: %s\n" % e)
extern crate JobsApi;

pub fn main() {
    let jobId = jobId_example; // String
    let stepId = stepId_example; // String
    let itemId = itemId_example; // String
    let token = token_example; // String
    let body = ; // EsriWorkflowModelsRestAssignmentBody

    let mut context = JobsApi::Context::default();
    let result = client.assignStep(jobId, stepId, itemId, token, body, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
jobId*
String
Required
stepId*
String
Required
itemId*
String
Required
Body parameters
Name Description
body

Assignment values to be applied to the step

Query parameters
Name Description
token
String

Responses


deleteAttachment

Delete an embedded or a linked attachment on a job

Deletes an attachment associated with a job. The **jobUpdateAttachments** privilege is required to delete attachments on a job.


/workflow/{itemId}/jobs/{jobId}/attachments/{attachmentId}

Usage and SDK Samples

curl -X DELETE\
 -H "Accept: application/json"\
 "http://localhost/workflow/{itemId}/jobs/{jobId}/attachments/{attachmentId}?token="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.JobsApi;

import java.io.File;
import java.util.*;

public class JobsApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        JobsApi apiInstance = new JobsApi();
        String jobId = jobId_example; // String | 
        String attachmentId = attachmentId_example; // String | 
        String itemId = itemId_example; // String | 
        String token = token_example; // String | 
        
        try {
            Success result = apiInstance.deleteAttachment(jobId, attachmentId, itemId, token);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobsApi#deleteAttachment");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.JobsApi;

public class JobsApiExample {
    public static void main(String[] args) {
        JobsApi apiInstance = new JobsApi();
        String jobId = jobId_example; // String | 
        String attachmentId = attachmentId_example; // String | 
        String itemId = itemId_example; // String | 
        String token = token_example; // String | 
        
        try {
            Success result = apiInstance.deleteAttachment(jobId, attachmentId, itemId, token);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobsApi#deleteAttachment");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
JobsApi *apiInstance = [[JobsApi alloc] init];
String *jobId = jobId_example; //  (default to null)
String *attachmentId = attachmentId_example; //  (default to null)
String *itemId = itemId_example; //  (default to null)
String *token = token_example; //  (optional) (default to null)

// Delete an embedded or a linked attachment on a job
[apiInstance deleteAttachmentWith:jobId
    attachmentId:attachmentId
    itemId:itemId
    token:token
              completionHandler: ^(Success output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var WorkflowManagerApi = require('workflow_manager_api');

// Create an instance of the API class
var api = new WorkflowManagerApi.JobsApi()
var jobId = jobId_example; // {String} 
var attachmentId = attachmentId_example; // {String} 
var itemId = itemId_example; // {String} 
var opts = {
  'token': token_example // {String} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteAttachment(jobId, attachmentId, itemId, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class deleteAttachmentExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new JobsApi();
            var jobId = jobId_example;  // String |  (default to null)
            var attachmentId = attachmentId_example;  // String |  (default to null)
            var itemId = itemId_example;  // String |  (default to null)
            var token = token_example;  // String |  (optional)  (default to null)

            try {
                // Delete an embedded or a linked attachment on a job
                Success result = apiInstance.deleteAttachment(jobId, attachmentId, itemId, token);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling JobsApi.deleteAttachment: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\JobsApi();
$jobId = jobId_example; // String | 
$attachmentId = attachmentId_example; // String | 
$itemId = itemId_example; // String | 
$token = token_example; // String | 

try {
    $result = $api_instance->deleteAttachment($jobId, $attachmentId, $itemId, $token);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling JobsApi->deleteAttachment: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::JobsApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::JobsApi->new();
my $jobId = jobId_example; # String | 
my $attachmentId = attachmentId_example; # String | 
my $itemId = itemId_example; # String | 
my $token = token_example; # String | 

eval { 
    my $result = $api_instance->deleteAttachment(jobId => $jobId, attachmentId => $attachmentId, itemId => $itemId, token => $token);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling JobsApi->deleteAttachment: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.JobsApi()
jobId = jobId_example # String |  (default to null)
attachmentId = attachmentId_example # String |  (default to null)
itemId = itemId_example # String |  (default to null)
token = token_example # String |  (optional) (default to null)

try: 
    # Delete an embedded or a linked attachment on a job
    api_response = api_instance.delete_attachment(jobId, attachmentId, itemId, token=token)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling JobsApi->deleteAttachment: %s\n" % e)
extern crate JobsApi;

pub fn main() {
    let jobId = jobId_example; // String
    let attachmentId = attachmentId_example; // String
    let itemId = itemId_example; // String
    let token = token_example; // String

    let mut context = JobsApi::Context::default();
    let result = client.deleteAttachment(jobId, attachmentId, itemId, token, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
jobId*
String
Required
attachmentId*
String
Required
itemId*
String
Required
Query parameters
Name Description
token
String

Responses


getAttachment

Retrieve embedded job attachment

Retrieves an embedded attachment associated with a job.


/workflow/{itemId}/jobs/{jobId}/attachments/{attachmentId}

Usage and SDK Samples

curl -X GET\
 -H "Accept: application/json"\
 "http://localhost/workflow/{itemId}/jobs/{jobId}/attachments/{attachmentId}?token="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.JobsApi;

import java.io.File;
import java.util.*;

public class JobsApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        JobsApi apiInstance = new JobsApi();
        String jobId = jobId_example; // String | 
        String attachmentId = attachmentId_example; // String | 
        String itemId = itemId_example; // String | 
        String token = token_example; // String | 
        
        try {
            File result = apiInstance.getAttachment(jobId, attachmentId, itemId, token);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobsApi#getAttachment");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.JobsApi;

public class JobsApiExample {
    public static void main(String[] args) {
        JobsApi apiInstance = new JobsApi();
        String jobId = jobId_example; // String | 
        String attachmentId = attachmentId_example; // String | 
        String itemId = itemId_example; // String | 
        String token = token_example; // String | 
        
        try {
            File result = apiInstance.getAttachment(jobId, attachmentId, itemId, token);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobsApi#getAttachment");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
JobsApi *apiInstance = [[JobsApi alloc] init];
String *jobId = jobId_example; //  (default to null)
String *attachmentId = attachmentId_example; //  (default to null)
String *itemId = itemId_example; //  (default to null)
String *token = token_example; //  (optional) (default to null)

// Retrieve embedded job attachment
[apiInstance getAttachmentWith:jobId
    attachmentId:attachmentId
    itemId:itemId
    token:token
              completionHandler: ^(File output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var WorkflowManagerApi = require('workflow_manager_api');

// Create an instance of the API class
var api = new WorkflowManagerApi.JobsApi()
var jobId = jobId_example; // {String} 
var attachmentId = attachmentId_example; // {String} 
var itemId = itemId_example; // {String} 
var opts = {
  'token': token_example // {String} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAttachment(jobId, attachmentId, itemId, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getAttachmentExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new JobsApi();
            var jobId = jobId_example;  // String |  (default to null)
            var attachmentId = attachmentId_example;  // String |  (default to null)
            var itemId = itemId_example;  // String |  (default to null)
            var token = token_example;  // String |  (optional)  (default to null)

            try {
                // Retrieve embedded job attachment
                File result = apiInstance.getAttachment(jobId, attachmentId, itemId, token);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling JobsApi.getAttachment: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\JobsApi();
$jobId = jobId_example; // String | 
$attachmentId = attachmentId_example; // String | 
$itemId = itemId_example; // String | 
$token = token_example; // String | 

try {
    $result = $api_instance->getAttachment($jobId, $attachmentId, $itemId, $token);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling JobsApi->getAttachment: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::JobsApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::JobsApi->new();
my $jobId = jobId_example; # String | 
my $attachmentId = attachmentId_example; # String | 
my $itemId = itemId_example; # String | 
my $token = token_example; # String | 

eval { 
    my $result = $api_instance->getAttachment(jobId => $jobId, attachmentId => $attachmentId, itemId => $itemId, token => $token);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling JobsApi->getAttachment: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.JobsApi()
jobId = jobId_example # String |  (default to null)
attachmentId = attachmentId_example # String |  (default to null)
itemId = itemId_example # String |  (default to null)
token = token_example # String |  (optional) (default to null)

try: 
    # Retrieve embedded job attachment
    api_response = api_instance.get_attachment(jobId, attachmentId, itemId, token=token)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling JobsApi->getAttachment: %s\n" % e)
extern crate JobsApi;

pub fn main() {
    let jobId = jobId_example; // String
    let attachmentId = attachmentId_example; // String
    let itemId = itemId_example; // String
    let token = token_example; // String

    let mut context = JobsApi::Context::default();
    let result = client.getAttachment(jobId, attachmentId, itemId, token, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
jobId*
String
Required
attachmentId*
String
Required
itemId*
String
Required
Query parameters
Name Description
token
String

Responses


getAttachments

Retrieve job attachments

Retrieves the list of attachments associated with a job. If the job contains attachments, they are returned in an ``attachments`` array with the following information: * id: Attachment id for the attachment associated with a job. * alias: Display name for the attachment. * folder: The folder in which the attachment is saved. Folder name can be blank. * url: Link for the attachment that consists of the jobId and the attachmentId. * lastModifiedBy: Username for the user who added or updated the attachment on the job. * lastModified: Date and time stamp for when the attachment was created or updated on the job. This field will not be modified if only the alias or the folder name for the attachment have been updated.


/workflow/{itemId}/jobs/{jobId}/attachments

Usage and SDK Samples

curl -X GET\
 -H "Accept: application/json"\
 "http://localhost/workflow/{itemId}/jobs/{jobId}/attachments?token="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.JobsApi;

import java.io.File;
import java.util.*;

public class JobsApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        JobsApi apiInstance = new JobsApi();
        String jobId = jobId_example; // String | 
        String itemId = itemId_example; // String | 
        String token = token_example; // String | 
        
        try {
            inline_response_200_12 result = apiInstance.getAttachments(jobId, itemId, token);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobsApi#getAttachments");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.JobsApi;

public class JobsApiExample {
    public static void main(String[] args) {
        JobsApi apiInstance = new JobsApi();
        String jobId = jobId_example; // String | 
        String itemId = itemId_example; // String | 
        String token = token_example; // String | 
        
        try {
            inline_response_200_12 result = apiInstance.getAttachments(jobId, itemId, token);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobsApi#getAttachments");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
JobsApi *apiInstance = [[JobsApi alloc] init];
String *jobId = jobId_example; //  (default to null)
String *itemId = itemId_example; //  (default to null)
String *token = token_example; //  (optional) (default to null)

// Retrieve job attachments
[apiInstance getAttachmentsWith:jobId
    itemId:itemId
    token:token
              completionHandler: ^(inline_response_200_12 output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var WorkflowManagerApi = require('workflow_manager_api');

// Create an instance of the API class
var api = new WorkflowManagerApi.JobsApi()
var jobId = jobId_example; // {String} 
var itemId = itemId_example; // {String} 
var opts = {
  'token': token_example // {String} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAttachments(jobId, itemId, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getAttachmentsExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new JobsApi();
            var jobId = jobId_example;  // String |  (default to null)
            var itemId = itemId_example;  // String |  (default to null)
            var token = token_example;  // String |  (optional)  (default to null)

            try {
                // Retrieve job attachments
                inline_response_200_12 result = apiInstance.getAttachments(jobId, itemId, token);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling JobsApi.getAttachments: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\JobsApi();
$jobId = jobId_example; // String | 
$itemId = itemId_example; // String | 
$token = token_example; // String | 

try {
    $result = $api_instance->getAttachments($jobId, $itemId, $token);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling JobsApi->getAttachments: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::JobsApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::JobsApi->new();
my $jobId = jobId_example; # String | 
my $itemId = itemId_example; # String | 
my $token = token_example; # String | 

eval { 
    my $result = $api_instance->getAttachments(jobId => $jobId, itemId => $itemId, token => $token);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling JobsApi->getAttachments: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.JobsApi()
jobId = jobId_example # String |  (default to null)
itemId = itemId_example # String |  (default to null)
token = token_example # String |  (optional) (default to null)

try: 
    # Retrieve job attachments
    api_response = api_instance.get_attachments(jobId, itemId, token=token)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling JobsApi->getAttachments: %s\n" % e)
extern crate JobsApi;

pub fn main() {
    let jobId = jobId_example; // String
    let itemId = itemId_example; // String
    let token = token_example; // String

    let mut context = JobsApi::Context::default();
    let result = client.getAttachments(jobId, itemId, token, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
jobId*
String
Required
itemId*
String
Required
Query parameters
Name Description
token
String

Responses


getJob

Get a job by jobId

Get the details of a job by jobId. If the job contains active versions, they are returned in an ``activeVersions`` array with the following information: * name: The name of the version. * url: The feature service URL. * layerItemId: The portal item ID of the source feature layer. * versionID: The GUID for the version in version management server. If the job contains extended properties and ``extProps`` is set to true, they are returned in an ``extendedProperties`` array with the following information: * tableName: The name of the extended property table. * featureServiceProperties: Available when a job contains feature service extended properties. * properties: The array of the properties in the extended property table, includes ``propertyName`` and ``value``. If the job contains feature service extended properties and ``extProps`` is set to true, they are returned within ``extendedProperties`` as a ``featureServiceProperties`` object with the following information: * itemId: ItemId for the feature service in Portal or AGOL. * layerid: LayerId for the layer in the Feature service. * portalType: Specifies where the feature service is located. ``Current`` for feature services available on the same portal as Workflow Manager, ``ArcGISOnline`` for feature services available on AGOL and ``Other`` for public feature services available on a different portal. * featureServiceUniqueId: The field from the feature service as linked field stored in the extended property table. * portalUrl: Portal url for the feature service. This field is specified only for portalType. * secure: Specifies whether the feature service is secure or not. If the job contains attachments, they are returned in an ``attachments`` array with the following information: * id: Attachment id for the attachment associated with a job. * alias: Display name for the attachment. * folder: The folder in which the attachment is saved. Folder name can be blank. * url: Link for the attachment that consists of the jobId and the attachmentId. * lastModifiedBy: Username for the user who added or updated the attachment to the job. * lastModified: Date and time stamp for when the attachment was created or updated on the job. This field will not be modified if only the alias or the folder name for the attachment have been updated. If the job contains a hold or dependency, it is returned in the corresponding current step in the ``currentSteps`` array with the following information: * manualHold: If the step is on manual hold * dependencies: If the step has dependencies on another job * holdScheduledRelease: Date and time stamp the scheduled hold is released Jobs that have a current or past hold will return the following information in the ``holds`` array if ``holds`` is set to true: * jobId: JobId for the job containing a hold * stepId: StepId for the step on hold * holdId: HoldId for the hold * setBy: Username for the user who added the hold * setDate: Date and time stamp for when the hold was added * scheduledRelease: If the step has a current hold, date and time stamp for when the hold is scheduled to be released * releasedBy: If the step has a past hold, the username for the user who released the hold * releasedDate: If the step has a past hold, date and time stamp for when the hold was released Jobs that contain a dependency will return the following infrormation in the ``holds`` array if ``holds`` is set to true: * dependentJobId: JobId for the job dependent on the current or past hold * dependentStepId: StepId for the step dependent on the current or past hold If the job is a parent job, a unique ID for the job is returned: * parentJobRefId: Unique ID for the parent job


/workflow/{itemId}/jobs/{jobId}

Usage and SDK Samples

curl -X GET\
 -H "Accept: application/json"\
 "http://localhost/workflow/{itemId}/jobs/{jobId}?extProps=&holds=&token="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.JobsApi;

import java.io.File;
import java.util.*;

public class JobsApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        JobsApi apiInstance = new JobsApi();
        String jobId = jobId_example; // String | 
        String itemId = itemId_example; // String | 
        Boolean extProps = true; // Boolean | 
        Boolean holds = true; // Boolean | 
        String token = token_example; // String | 
        
        try {
            esri.workflow.models.rest.Job result = apiInstance.getJob(jobId, itemId, extProps, holds, token);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobsApi#getJob");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.JobsApi;

public class JobsApiExample {
    public static void main(String[] args) {
        JobsApi apiInstance = new JobsApi();
        String jobId = jobId_example; // String | 
        String itemId = itemId_example; // String | 
        Boolean extProps = true; // Boolean | 
        Boolean holds = true; // Boolean | 
        String token = token_example; // String | 
        
        try {
            esri.workflow.models.rest.Job result = apiInstance.getJob(jobId, itemId, extProps, holds, token);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobsApi#getJob");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
JobsApi *apiInstance = [[JobsApi alloc] init];
String *jobId = jobId_example; //  (default to null)
String *itemId = itemId_example; //  (default to null)
Boolean *extProps = true; //  (optional) (default to null)
Boolean *holds = true; //  (optional) (default to null)
String *token = token_example; //  (optional) (default to null)

// Get a job by jobId
[apiInstance getJobWith:jobId
    itemId:itemId
    extProps:extProps
    holds:holds
    token:token
              completionHandler: ^(esri.workflow.models.rest.Job output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var WorkflowManagerApi = require('workflow_manager_api');

// Create an instance of the API class
var api = new WorkflowManagerApi.JobsApi()
var jobId = jobId_example; // {String} 
var itemId = itemId_example; // {String} 
var opts = {
  'extProps': true, // {Boolean} 
  'holds': true, // {Boolean} 
  'token': token_example // {String} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getJob(jobId, itemId, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getJobExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new JobsApi();
            var jobId = jobId_example;  // String |  (default to null)
            var itemId = itemId_example;  // String |  (default to null)
            var extProps = true;  // Boolean |  (optional)  (default to null)
            var holds = true;  // Boolean |  (optional)  (default to null)
            var token = token_example;  // String |  (optional)  (default to null)

            try {
                // Get a job by jobId
                esri.workflow.models.rest.Job result = apiInstance.getJob(jobId, itemId, extProps, holds, token);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling JobsApi.getJob: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\JobsApi();
$jobId = jobId_example; // String | 
$itemId = itemId_example; // String | 
$extProps = true; // Boolean | 
$holds = true; // Boolean | 
$token = token_example; // String | 

try {
    $result = $api_instance->getJob($jobId, $itemId, $extProps, $holds, $token);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling JobsApi->getJob: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::JobsApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::JobsApi->new();
my $jobId = jobId_example; # String | 
my $itemId = itemId_example; # String | 
my $extProps = true; # Boolean | 
my $holds = true; # Boolean | 
my $token = token_example; # String | 

eval { 
    my $result = $api_instance->getJob(jobId => $jobId, itemId => $itemId, extProps => $extProps, holds => $holds, token => $token);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling JobsApi->getJob: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.JobsApi()
jobId = jobId_example # String |  (default to null)
itemId = itemId_example # String |  (default to null)
extProps = true # Boolean |  (optional) (default to null)
holds = true # Boolean |  (optional) (default to null)
token = token_example # String |  (optional) (default to null)

try: 
    # Get a job by jobId
    api_response = api_instance.get_job(jobId, itemId, extProps=extProps, holds=holds, token=token)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling JobsApi->getJob: %s\n" % e)
extern crate JobsApi;

pub fn main() {
    let jobId = jobId_example; // String
    let itemId = itemId_example; // String
    let extProps = true; // Boolean
    let holds = true; // Boolean
    let token = token_example; // String

    let mut context = JobsApi::Context::default();
    let result = client.getJob(jobId, itemId, extProps, holds, token, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
jobId*
String
Required
itemId*
String
Required
Query parameters
Name Description
extProps
Boolean
holds
Boolean
token
String

Responses


getJobComments

Get the comments for a job

Gets all comments associated with a job. Returns a list of all comments associated with a job which includes the following fields: ``jobId``, ``comment``, ``commentId``, ``lastModifiedBy``, ``lastModified``. Users must have the job's associated job template shared with them to get job comments.


/workflow/{itemId}/jobs/{jobId}/comments

Usage and SDK Samples

curl -X GET\
 -H "Accept: application/json"\
 "http://localhost/workflow/{itemId}/jobs/{jobId}/comments?token="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.JobsApi;

import java.io.File;
import java.util.*;

public class JobsApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        JobsApi apiInstance = new JobsApi();
        String jobId = jobId_example; // String | 
        String itemId = itemId_example; // String | 
        String token = token_example; // String | 
        
        try {
            inline_response_200_15 result = apiInstance.getJobComments(jobId, itemId, token);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobsApi#getJobComments");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.JobsApi;

public class JobsApiExample {
    public static void main(String[] args) {
        JobsApi apiInstance = new JobsApi();
        String jobId = jobId_example; // String | 
        String itemId = itemId_example; // String | 
        String token = token_example; // String | 
        
        try {
            inline_response_200_15 result = apiInstance.getJobComments(jobId, itemId, token);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobsApi#getJobComments");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
JobsApi *apiInstance = [[JobsApi alloc] init];
String *jobId = jobId_example; //  (default to null)
String *itemId = itemId_example; //  (default to null)
String *token = token_example; //  (optional) (default to null)

// Get the comments for a job
[apiInstance getJobCommentsWith:jobId
    itemId:itemId
    token:token
              completionHandler: ^(inline_response_200_15 output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var WorkflowManagerApi = require('workflow_manager_api');

// Create an instance of the API class
var api = new WorkflowManagerApi.JobsApi()
var jobId = jobId_example; // {String} 
var itemId = itemId_example; // {String} 
var opts = {
  'token': token_example // {String} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getJobComments(jobId, itemId, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getJobCommentsExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new JobsApi();
            var jobId = jobId_example;  // String |  (default to null)
            var itemId = itemId_example;  // String |  (default to null)
            var token = token_example;  // String |  (optional)  (default to null)

            try {
                // Get the comments for a job
                inline_response_200_15 result = apiInstance.getJobComments(jobId, itemId, token);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling JobsApi.getJobComments: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\JobsApi();
$jobId = jobId_example; // String | 
$itemId = itemId_example; // String | 
$token = token_example; // String | 

try {
    $result = $api_instance->getJobComments($jobId, $itemId, $token);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling JobsApi->getJobComments: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::JobsApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::JobsApi->new();
my $jobId = jobId_example; # String | 
my $itemId = itemId_example; # String | 
my $token = token_example; # String | 

eval { 
    my $result = $api_instance->getJobComments(jobId => $jobId, itemId => $itemId, token => $token);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling JobsApi->getJobComments: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.JobsApi()
jobId = jobId_example # String |  (default to null)
itemId = itemId_example # String |  (default to null)
token = token_example # String |  (optional) (default to null)

try: 
    # Get the comments for a job
    api_response = api_instance.get_job_comments(jobId, itemId, token=token)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling JobsApi->getJobComments: %s\n" % e)
extern crate JobsApi;

pub fn main() {
    let jobId = jobId_example; // String
    let itemId = itemId_example; // String
    let token = token_example; // String

    let mut context = JobsApi::Context::default();
    let result = client.getJobComments(jobId, itemId, token, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
jobId*
String
Required
itemId*
String
Required
Query parameters
Name Description
token
String

Responses


getJobDiagram

Get a job diagram by jobId


/workflow/{itemId}/jobs/{jobId}/diagram

Usage and SDK Samples

curl -X GET\
 -H "Accept: application/json"\
 "http://localhost/workflow/{itemId}/jobs/{jobId}/diagram?token="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.JobsApi;

import java.io.File;
import java.util.*;

public class JobsApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        JobsApi apiInstance = new JobsApi();
        String jobId = jobId_example; // String | 
        String itemId = itemId_example; // String | 
        String token = token_example; // String | 
        
        try {
            esri.workflow.models.rest.diagram.Diagram result = apiInstance.getJobDiagram(jobId, itemId, token);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobsApi#getJobDiagram");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.JobsApi;

public class JobsApiExample {
    public static void main(String[] args) {
        JobsApi apiInstance = new JobsApi();
        String jobId = jobId_example; // String | 
        String itemId = itemId_example; // String | 
        String token = token_example; // String | 
        
        try {
            esri.workflow.models.rest.diagram.Diagram result = apiInstance.getJobDiagram(jobId, itemId, token);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobsApi#getJobDiagram");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
JobsApi *apiInstance = [[JobsApi alloc] init];
String *jobId = jobId_example; //  (default to null)
String *itemId = itemId_example; //  (default to null)
String *token = token_example; //  (optional) (default to null)

// Get a job diagram by jobId
[apiInstance getJobDiagramWith:jobId
    itemId:itemId
    token:token
              completionHandler: ^(esri.workflow.models.rest.diagram.Diagram output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var WorkflowManagerApi = require('workflow_manager_api');

// Create an instance of the API class
var api = new WorkflowManagerApi.JobsApi()
var jobId = jobId_example; // {String} 
var itemId = itemId_example; // {String} 
var opts = {
  'token': token_example // {String} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getJobDiagram(jobId, itemId, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getJobDiagramExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new JobsApi();
            var jobId = jobId_example;  // String |  (default to null)
            var itemId = itemId_example;  // String |  (default to null)
            var token = token_example;  // String |  (optional)  (default to null)

            try {
                // Get a job diagram by jobId
                esri.workflow.models.rest.diagram.Diagram result = apiInstance.getJobDiagram(jobId, itemId, token);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling JobsApi.getJobDiagram: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\JobsApi();
$jobId = jobId_example; // String | 
$itemId = itemId_example; // String | 
$token = token_example; // String | 

try {
    $result = $api_instance->getJobDiagram($jobId, $itemId, $token);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling JobsApi->getJobDiagram: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::JobsApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::JobsApi->new();
my $jobId = jobId_example; # String | 
my $itemId = itemId_example; # String | 
my $token = token_example; # String | 

eval { 
    my $result = $api_instance->getJobDiagram(jobId => $jobId, itemId => $itemId, token => $token);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling JobsApi->getJobDiagram: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.JobsApi()
jobId = jobId_example # String |  (default to null)
itemId = itemId_example # String |  (default to null)
token = token_example # String |  (optional) (default to null)

try: 
    # Get a job diagram by jobId
    api_response = api_instance.get_job_diagram(jobId, itemId, token=token)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling JobsApi->getJobDiagram: %s\n" % e)
extern crate JobsApi;

pub fn main() {
    let jobId = jobId_example; // String
    let itemId = itemId_example; // String
    let token = token_example; // String

    let mut context = JobsApi::Context::default();
    let result = client.getJobDiagram(jobId, itemId, token, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
jobId*
String
Required
itemId*
String
Required
Query parameters
Name Description
token
String

Responses


getJobHistory

Get job history by jobId

Get job history by jobId. It returns the log of job actions such as running steps, managing job attachments and properties.


/workflow/{itemId}/jobs/{jobId}/history

Usage and SDK Samples

curl -X GET\
 -H "Accept: application/json"\
 "http://localhost/workflow/{itemId}/jobs/{jobId}/history?token="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.JobsApi;

import java.io.File;
import java.util.*;

public class JobsApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        JobsApi apiInstance = new JobsApi();
        String jobId = jobId_example; // String | 
        String itemId = itemId_example; // String | 
        String token = token_example; // String | 
        
        try {
            inline_response_200_17 result = apiInstance.getJobHistory(jobId, itemId, token);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobsApi#getJobHistory");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.JobsApi;

public class JobsApiExample {
    public static void main(String[] args) {
        JobsApi apiInstance = new JobsApi();
        String jobId = jobId_example; // String | 
        String itemId = itemId_example; // String | 
        String token = token_example; // String | 
        
        try {
            inline_response_200_17 result = apiInstance.getJobHistory(jobId, itemId, token);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobsApi#getJobHistory");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
JobsApi *apiInstance = [[JobsApi alloc] init];
String *jobId = jobId_example; //  (default to null)
String *itemId = itemId_example; //  (default to null)
String *token = token_example; //  (optional) (default to null)

// Get job history by jobId
[apiInstance getJobHistoryWith:jobId
    itemId:itemId
    token:token
              completionHandler: ^(inline_response_200_17 output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var WorkflowManagerApi = require('workflow_manager_api');

// Create an instance of the API class
var api = new WorkflowManagerApi.JobsApi()
var jobId = jobId_example; // {String} 
var itemId = itemId_example; // {String} 
var opts = {
  'token': token_example // {String} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getJobHistory(jobId, itemId, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getJobHistoryExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new JobsApi();
            var jobId = jobId_example;  // String |  (default to null)
            var itemId = itemId_example;  // String |  (default to null)
            var token = token_example;  // String |  (optional)  (default to null)

            try {
                // Get job history by jobId
                inline_response_200_17 result = apiInstance.getJobHistory(jobId, itemId, token);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling JobsApi.getJobHistory: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\JobsApi();
$jobId = jobId_example; // String | 
$itemId = itemId_example; // String | 
$token = token_example; // String | 

try {
    $result = $api_instance->getJobHistory($jobId, $itemId, $token);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling JobsApi->getJobHistory: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::JobsApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::JobsApi->new();
my $jobId = jobId_example; # String | 
my $itemId = itemId_example; # String | 
my $token = token_example; # String | 

eval { 
    my $result = $api_instance->getJobHistory(jobId => $jobId, itemId => $itemId, token => $token);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling JobsApi->getJobHistory: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.JobsApi()
jobId = jobId_example # String |  (default to null)
itemId = itemId_example # String |  (default to null)
token = token_example # String |  (optional) (default to null)

try: 
    # Get job history by jobId
    api_response = api_instance.get_job_history(jobId, itemId, token=token)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling JobsApi->getJobHistory: %s\n" % e)
extern crate JobsApi;

pub fn main() {
    let jobId = jobId_example; // String
    let itemId = itemId_example; // String
    let token = token_example; // String

    let mut context = JobsApi::Context::default();
    let result = client.getJobHistory(jobId, itemId, token, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
jobId*
String
Required
itemId*
String
Required
Query parameters
Name Description
token
String

Responses


getJobLocation

Get a job location by jobId

Get a location of work for an exisiting job. The geometry for the job location is returned in the ArcGIS REST API geometry JSON format. Job locations are returned using the WGS 1984 Web Mercator (Auxiliary Sphere) coordinate system (spatial reference 3857). Supported geometry types are **Multipoint**, **Polyline**, and **Polygon**.


/workflow/{itemId}/jobs/{jobId}/location

Usage and SDK Samples

curl -X GET\
 -H "Accept: application/json"\
 "http://localhost/workflow/{itemId}/jobs/{jobId}/location?token="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.JobsApi;

import java.io.File;
import java.util.*;

public class JobsApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        JobsApi apiInstance = new JobsApi();
        String jobId = jobId_example; // String | 
        String itemId = itemId_example; // String | 
        String token = token_example; // String | 
        
        try {
            esri.workflow.models.rest.Location result = apiInstance.getJobLocation(jobId, itemId, token);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobsApi#getJobLocation");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.JobsApi;

public class JobsApiExample {
    public static void main(String[] args) {
        JobsApi apiInstance = new JobsApi();
        String jobId = jobId_example; // String | 
        String itemId = itemId_example; // String | 
        String token = token_example; // String | 
        
        try {
            esri.workflow.models.rest.Location result = apiInstance.getJobLocation(jobId, itemId, token);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobsApi#getJobLocation");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
JobsApi *apiInstance = [[JobsApi alloc] init];
String *jobId = jobId_example; //  (default to null)
String *itemId = itemId_example; //  (default to null)
String *token = token_example; //  (optional) (default to null)

// Get a job location by jobId
[apiInstance getJobLocationWith:jobId
    itemId:itemId
    token:token
              completionHandler: ^(esri.workflow.models.rest.Location output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var WorkflowManagerApi = require('workflow_manager_api');

// Create an instance of the API class
var api = new WorkflowManagerApi.JobsApi()
var jobId = jobId_example; // {String} 
var itemId = itemId_example; // {String} 
var opts = {
  'token': token_example // {String} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getJobLocation(jobId, itemId, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getJobLocationExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new JobsApi();
            var jobId = jobId_example;  // String |  (default to null)
            var itemId = itemId_example;  // String |  (default to null)
            var token = token_example;  // String |  (optional)  (default to null)

            try {
                // Get a job location by jobId
                esri.workflow.models.rest.Location result = apiInstance.getJobLocation(jobId, itemId, token);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling JobsApi.getJobLocation: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\JobsApi();
$jobId = jobId_example; // String | 
$itemId = itemId_example; // String | 
$token = token_example; // String | 

try {
    $result = $api_instance->getJobLocation($jobId, $itemId, $token);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling JobsApi->getJobLocation: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::JobsApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::JobsApi->new();
my $jobId = jobId_example; # String | 
my $itemId = itemId_example; # String | 
my $token = token_example; # String | 

eval { 
    my $result = $api_instance->getJobLocation(jobId => $jobId, itemId => $itemId, token => $token);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling JobsApi->getJobLocation: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.JobsApi()
jobId = jobId_example # String |  (default to null)
itemId = itemId_example # String |  (default to null)
token = token_example # String |  (optional) (default to null)

try: 
    # Get a job location by jobId
    api_response = api_instance.get_job_location(jobId, itemId, token=token)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling JobsApi->getJobLocation: %s\n" % e)
extern crate JobsApi;

pub fn main() {
    let jobId = jobId_example; // String
    let itemId = itemId_example; // String
    let token = token_example; // String

    let mut context = JobsApi::Context::default();
    let result = client.getJobLocation(jobId, itemId, token, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
jobId*
String
Required
itemId*
String
Required
Query parameters
Name Description
token
String

Responses


jobAction

Job actions

Executes single or multiple steps based on the action enum provided. If no stepId is provided, the current step(s) will be executed. The action enum can be as follows: * Run : Starts running a step. Running a step marks it as finished, if the step is set to proceed to next. * Finish : Finishes running a step, and proceeds to the next step. * Stop : Stops running a step, then the step can be **Run** again or **Finish** can be used to complete it. In case of GP step and question step, the processing of the step is cancelled. In case of manual and open app step, the step is paused. * SetCurrentStep: Sets a single step to be the active step on the job. The ability to set a step as current is controlled by the **workflowSetStepCurrent** privilege. * Hold : Applies a hold or a dependency to a step. This prevents the **Run** and **Finish** actions from being performed on the step until the **ReleaseHold** action is run or the **holdScheduledReleased** has expired. Cannot be applied if the step is already running or job is closed. * ReleaseHold : Releases a hold from a step, allowing the **Run** and **Finish** actions to be once again performed on the step. * RefreshStatus : Refreshes the step status. Only the users with **adminBasic** or **adminAdvanced** privilege or job assigned user can refresh the status for the step. The step will not be started, stopped, finished or set as current step under the following conditions: * Not assigned to the current user * No active step is defined * The job is closed * A step that cannot be skipped and has not been started or has been cancelled, will not be finished * A step cannot be set current if the job is running. **Hold Parameters:** | Parameter | Description | Data Type | | ---------- | ----------- | --------- | | Type | Required. The action enum is **Hold**.| String | | stepIds | Optional. The array of steps put on hold when adding a dependency hold. If not specified, the dependency hold is applied to all the active steps in the job.| Array | | holdScheduledRelease | Optional. The release timestamp for scheduled hold.| String | | dependentJobId | Optional. A job that the current job is dependent on from being performed step actions including **Run** and **Finish**.| String | | dependentStepId | Optional. The step in the job that the current job is dependent on from being performed step actions including **Run** and **Finish**.| String | **ReleaseHold Parameters:** | Parameter | Description | Data Type | | ---------- | ----------- | --------- | | Type | Required. The action enum is **ReleaseHold**.| String | | stepIds | Optional. The array of steps on hold to be released. If not specified the release is applied to all the steps on hold.| Array | | dependentJobId | Optional. The manual hold can be released without specifying dependentJobId. The dependency hold must be released by specifying the dependent job ID.| String | | dependentStepId | Optional. The manual hold can be released without specifying dependentStepId. The dependency hold must be released by specifying the dependent step ID.| String |


/workflow/{itemId}/jobs/{jobId}/action

Usage and SDK Samples

curl -X POST\
 -H "Accept: application/json"\
 -H "Content-Type: application/json"\
 "http://localhost/workflow/{itemId}/jobs/{jobId}/action?token="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.JobsApi;

import java.io.File;
import java.util.*;

public class JobsApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        JobsApi apiInstance = new JobsApi();
        String jobId = jobId_example; // String | 
        String itemId = itemId_example; // String | 
        String token = token_example; // String | 
        EsriWorkflowModelsRestJobActionBody body = ; // EsriWorkflowModelsRestJobActionBody | 
        
        try {
            esri.workflow.models.rest.JobActionResponse result = apiInstance.jobAction(jobId, itemId, token, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobsApi#jobAction");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.JobsApi;

public class JobsApiExample {
    public static void main(String[] args) {
        JobsApi apiInstance = new JobsApi();
        String jobId = jobId_example; // String | 
        String itemId = itemId_example; // String | 
        String token = token_example; // String | 
        EsriWorkflowModelsRestJobActionBody body = ; // EsriWorkflowModelsRestJobActionBody | 
        
        try {
            esri.workflow.models.rest.JobActionResponse result = apiInstance.jobAction(jobId, itemId, token, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobsApi#jobAction");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
JobsApi *apiInstance = [[JobsApi alloc] init];
String *jobId = jobId_example; //  (default to null)
String *itemId = itemId_example; //  (default to null)
String *token = token_example; //  (optional) (default to null)
EsriWorkflowModelsRestJobActionBody *body = ; //  (optional)

// Job actions
[apiInstance jobActionWith:jobId
    itemId:itemId
    token:token
    body:body
              completionHandler: ^(esri.workflow.models.rest.JobActionResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var WorkflowManagerApi = require('workflow_manager_api');

// Create an instance of the API class
var api = new WorkflowManagerApi.JobsApi()
var jobId = jobId_example; // {String} 
var itemId = itemId_example; // {String} 
var opts = {
  'token': token_example, // {String} 
  'body':  // {EsriWorkflowModelsRestJobActionBody} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.jobAction(jobId, itemId, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class jobActionExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new JobsApi();
            var jobId = jobId_example;  // String |  (default to null)
            var itemId = itemId_example;  // String |  (default to null)
            var token = token_example;  // String |  (optional)  (default to null)
            var body = new EsriWorkflowModelsRestJobActionBody(); // EsriWorkflowModelsRestJobActionBody |  (optional) 

            try {
                // Job actions
                esri.workflow.models.rest.JobActionResponse result = apiInstance.jobAction(jobId, itemId, token, body);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling JobsApi.jobAction: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\JobsApi();
$jobId = jobId_example; // String | 
$itemId = itemId_example; // String | 
$token = token_example; // String | 
$body = ; // EsriWorkflowModelsRestJobActionBody | 

try {
    $result = $api_instance->jobAction($jobId, $itemId, $token, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling JobsApi->jobAction: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::JobsApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::JobsApi->new();
my $jobId = jobId_example; # String | 
my $itemId = itemId_example; # String | 
my $token = token_example; # String | 
my $body = WWW::OPenAPIClient::Object::EsriWorkflowModelsRestJobActionBody->new(); # EsriWorkflowModelsRestJobActionBody | 

eval { 
    my $result = $api_instance->jobAction(jobId => $jobId, itemId => $itemId, token => $token, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling JobsApi->jobAction: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.JobsApi()
jobId = jobId_example # String |  (default to null)
itemId = itemId_example # String |  (default to null)
token = token_example # String |  (optional) (default to null)
body =  # EsriWorkflowModelsRestJobActionBody |  (optional)

try: 
    # Job actions
    api_response = api_instance.job_action(jobId, itemId, token=token, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling JobsApi->jobAction: %s\n" % e)
extern crate JobsApi;

pub fn main() {
    let jobId = jobId_example; // String
    let itemId = itemId_example; // String
    let token = token_example; // String
    let body = ; // EsriWorkflowModelsRestJobActionBody

    let mut context = JobsApi::Context::default();
    let result = client.jobAction(jobId, itemId, token, body, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
jobId*
String
Required
itemId*
String
Required
Body parameters
Name Description
body

Action to be taken on step(s)

Query parameters
Name Description
token
String

Responses


jobStatistics

Count of total records that match the query results

Returns the count of total records that match the query results provided in the input. **Search syntax details** * q - the query for the search you want total number of records for. * search - the match criteria for a simple search * groupBy - Optional. The field that is used to separate counts by value. * spatialExtent - Optional. Spatial extent string to filter jobs by their locations * hasLocation - Optional. Whether or not jobs with defined location in jobLocation are returned **Result syntax details** * total - The number of total results returned for the search


/workflow/{itemId}/jobs/statistics

Usage and SDK Samples

curl -X POST\
 -H "Accept: application/json"\
 -H "Content-Type: application/json"\
 "http://localhost/workflow/{itemId}/jobs/statistics?token="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.JobsApi;

import java.io.File;
import java.util.*;

public class JobsApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        JobsApi apiInstance = new JobsApi();
        String itemId = itemId_example; // String | 
        String token = token_example; // String | 
        EsriWorkflowModelsRestJobStatisticsQuery body = ; // EsriWorkflowModelsRestJobStatisticsQuery | 
        
        try {
            esri.workflow.models.rest.JobStatistics result = apiInstance.jobStatistics(itemId, token, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobsApi#jobStatistics");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.JobsApi;

public class JobsApiExample {
    public static void main(String[] args) {
        JobsApi apiInstance = new JobsApi();
        String itemId = itemId_example; // String | 
        String token = token_example; // String | 
        EsriWorkflowModelsRestJobStatisticsQuery body = ; // EsriWorkflowModelsRestJobStatisticsQuery | 
        
        try {
            esri.workflow.models.rest.JobStatistics result = apiInstance.jobStatistics(itemId, token, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobsApi#jobStatistics");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
JobsApi *apiInstance = [[JobsApi alloc] init];
String *itemId = itemId_example; //  (default to null)
String *token = token_example; //  (optional) (default to null)
EsriWorkflowModelsRestJobStatisticsQuery *body = ; //  (optional)

// Count of total records that match the query results
[apiInstance jobStatisticsWith:itemId
    token:token
    body:body
              completionHandler: ^(esri.workflow.models.rest.JobStatistics output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var WorkflowManagerApi = require('workflow_manager_api');

// Create an instance of the API class
var api = new WorkflowManagerApi.JobsApi()
var itemId = itemId_example; // {String} 
var opts = {
  'token': token_example, // {String} 
  'body':  // {EsriWorkflowModelsRestJobStatisticsQuery} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.jobStatistics(itemId, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class jobStatisticsExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new JobsApi();
            var itemId = itemId_example;  // String |  (default to null)
            var token = token_example;  // String |  (optional)  (default to null)
            var body = new EsriWorkflowModelsRestJobStatisticsQuery(); // EsriWorkflowModelsRestJobStatisticsQuery |  (optional) 

            try {
                // Count of total records that match the query results
                esri.workflow.models.rest.JobStatistics result = apiInstance.jobStatistics(itemId, token, body);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling JobsApi.jobStatistics: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\JobsApi();
$itemId = itemId_example; // String | 
$token = token_example; // String | 
$body = ; // EsriWorkflowModelsRestJobStatisticsQuery | 

try {
    $result = $api_instance->jobStatistics($itemId, $token, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling JobsApi->jobStatistics: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::JobsApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::JobsApi->new();
my $itemId = itemId_example; # String | 
my $token = token_example; # String | 
my $body = WWW::OPenAPIClient::Object::EsriWorkflowModelsRestJobStatisticsQuery->new(); # EsriWorkflowModelsRestJobStatisticsQuery | 

eval { 
    my $result = $api_instance->jobStatistics(itemId => $itemId, token => $token, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling JobsApi->jobStatistics: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.JobsApi()
itemId = itemId_example # String |  (default to null)
token = token_example # String |  (optional) (default to null)
body =  # EsriWorkflowModelsRestJobStatisticsQuery |  (optional)

try: 
    # Count of total records that match the query results
    api_response = api_instance.job_statistics(itemId, token=token, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling JobsApi->jobStatistics: %s\n" % e)
extern crate JobsApi;

pub fn main() {
    let itemId = itemId_example; // String
    let token = token_example; // String
    let body = ; // EsriWorkflowModelsRestJobStatisticsQuery

    let mut context = JobsApi::Context::default();
    let result = client.jobStatistics(itemId, token, body, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
itemId*
String
Required
Body parameters
Name Description
body

The statistics request

Query parameters
Name Description
token
String

Responses


manageJobs

Manage a single or multiple jobs

Manage a single or multiple jobs with specified jobIds. Valid enum values for manage are **Upgrade**, **Close**, **Reopen**, and **Delete**. **Upgrade** Upgrade will upgrade the existing job(s) to the latest active diagram version. The **jobUpgrade** privilege is required to upgrade a job. A job will not be upgraded if: * You have insufficient privileges * The job is closed * The job is currently running * The current step on the job does not exist on the diagram **Close** Close will close open job(s). The **jobClose** privilege is required to close a job. A job will not be closed if: * You have insufficient privileges * The job is currently running **Reopen** Reopen will reopen a single or multiple jobs. The **jobReopenClosed** privilege is required to reopen a job. A job will not be reopened if: * You have insufficient privileges * The job is currently open **Delete** Delete a single or multiple jobs. The attachments, extended properties and locations associated with the job are also deleted. The **jobDelete** privilege is required to delete a job. A job will not be deleted if: * You have insufficient privileges * The job is currently running


/workflow/{itemId}/jobs/manage

Usage and SDK Samples

curl -X POST\
 -H "Accept: application/json"\
 -H "Content-Type: application/json"\
 "http://localhost/workflow/{itemId}/jobs/manage?token="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.JobsApi;

import java.io.File;
import java.util.*;

public class JobsApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        JobsApi apiInstance = new JobsApi();
        String itemId = itemId_example; // String | 
        String token = token_example; // String | 
        EsriWorkflowModelsRestJobManageBody body = ; // EsriWorkflowModelsRestJobManageBody | 
        
        try {
            Success result = apiInstance.manageJobs(itemId, token, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobsApi#manageJobs");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.JobsApi;

public class JobsApiExample {
    public static void main(String[] args) {
        JobsApi apiInstance = new JobsApi();
        String itemId = itemId_example; // String | 
        String token = token_example; // String | 
        EsriWorkflowModelsRestJobManageBody body = ; // EsriWorkflowModelsRestJobManageBody | 
        
        try {
            Success result = apiInstance.manageJobs(itemId, token, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobsApi#manageJobs");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
JobsApi *apiInstance = [[JobsApi alloc] init];
String *itemId = itemId_example; //  (default to null)
String *token = token_example; //  (optional) (default to null)
EsriWorkflowModelsRestJobManageBody *body = ; //  (optional)

// Manage a single or multiple jobs
[apiInstance manageJobsWith:itemId
    token:token
    body:body
              completionHandler: ^(Success output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var WorkflowManagerApi = require('workflow_manager_api');

// Create an instance of the API class
var api = new WorkflowManagerApi.JobsApi()
var itemId = itemId_example; // {String} 
var opts = {
  'token': token_example, // {String} 
  'body':  // {EsriWorkflowModelsRestJobManageBody} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.manageJobs(itemId, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class manageJobsExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new JobsApi();
            var itemId = itemId_example;  // String |  (default to null)
            var token = token_example;  // String |  (optional)  (default to null)
            var body = new EsriWorkflowModelsRestJobManageBody(); // EsriWorkflowModelsRestJobManageBody |  (optional) 

            try {
                // Manage a single or multiple jobs
                Success result = apiInstance.manageJobs(itemId, token, body);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling JobsApi.manageJobs: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\JobsApi();
$itemId = itemId_example; // String | 
$token = token_example; // String | 
$body = ; // EsriWorkflowModelsRestJobManageBody | 

try {
    $result = $api_instance->manageJobs($itemId, $token, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling JobsApi->manageJobs: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::JobsApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::JobsApi->new();
my $itemId = itemId_example; # String | 
my $token = token_example; # String | 
my $body = WWW::OPenAPIClient::Object::EsriWorkflowModelsRestJobManageBody->new(); # EsriWorkflowModelsRestJobManageBody | 

eval { 
    my $result = $api_instance->manageJobs(itemId => $itemId, token => $token, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling JobsApi->manageJobs: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.JobsApi()
itemId = itemId_example # String |  (default to null)
token = token_example # String |  (optional) (default to null)
body =  # EsriWorkflowModelsRestJobManageBody |  (optional)

try: 
    # Manage a single or multiple jobs
    api_response = api_instance.manage_jobs(itemId, token=token, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling JobsApi->manageJobs: %s\n" % e)
extern crate JobsApi;

pub fn main() {
    let itemId = itemId_example; // String
    let token = token_example; // String
    let body = ; // EsriWorkflowModelsRestJobManageBody

    let mut context = JobsApi::Context::default();
    let result = client.manageJobs(itemId, token, body, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
itemId*
String
Required
Body parameters
Name Description
body

Manage action to be taken on jobs(s)

Query parameters
Name Description
token
String

Responses


searchJobs

Search for jobs in the system

Search the jobs in the system using keywords matching the fields in the jobs. Information about the fields that can be searched can be found in /workflow/{itemId}/jobs/{jobId} endpoint about getting a job. Arcade expressions will also be evaluated at run time. For details, see **Arcade expression evaluator** **Search syntax details** * q - the query for the search you are performing * search - the match criteria for a simple search * fields - an array of fields whose value you want to return in the search result. If no fields are defined in the search query, jobName, priority, dueDate and currentStep fields are returned * displayNames - an array of display names for the fields, stored as part of saved searches * sortFields - the field based on which you want to sort the results and whether you want to sort the results in ascending or descending order * start - The index of the results from which you want to start the list of results * num - The number of results to return in the page * spatialExtent - Optional. Spatial extent string to filter jobs by their locations * hasLocation - Optional. Whether or not jobs with defined location in jobLocation are returned Search can be performed by defining the match criteria with or without field names in the search terms. For example, ``"search": "High priority"`` will search for strings High and priority in the jobId, jobName, description, parentName, notes, ownedBy, createdBy, jobPriority, jobStatus, diagramId, jobTemplateId, activeVersions, jobTemplateName, currentStepID, currentStep, assignedType and assignedTo fields. Whereas ``"q": "priority='High'"`` will search for string High in the priority field. These can be combined using logical operators like so: ``"search":"edits","q":"AND priority='High'"``. To conduct a simple search on multiple terms as one match criteria without field names, enclose them in single quotes such as 'High Priority'. When searching based on names in the assignedTo, createdBy and ownedBy the search criteria is based on the username while the value returned in the fields and sorting is based on the Full Name of the user. Searches by assignment, with currentStep or currentStepId field names in the search terms will filter current steps to ones that match the search criteria, both for users and group. For example, ``"q": "assignedTo='wmxuser'", "fields":["jobId","currentStep","currentStepId"]`` will return all jobs with current steps assigned to the wmxuser, and only include those steps. Any steps assigned to other users will be excluded from the results. **Search Operators** The results for the same search string can vary based on the operator used, the operator ``like`` will return the results that **should** match the string whereas, the operator ``=`` will return results that **must** match the search criteria. For example, ``"q": "currentStep like '%Edit%' or currentStep like '%Data%'"`` will return all jobs whose currentStep has either string **Edit** and **Data**. However, ``"q": "currentStep='Edit Data'"`` will return all jobs whose currentStep has exact string **Edit Data**, in this case any job which has only **Edit** or **Data** will not be returned. To get all the jobs in the system use ``"q": "1=1"`` **Searching Dates** When searching based on dates, the search criteria must include the time zone to get correct results. For example, to get results based on Pacific Standard Time (UTC - 7 hrs) the criteria would be similar to ``"q": "dueDate>='2017-05-05T00:00:00-7:00'"`` All operators for greater than, smaller than, equal are supported for searching dates. **Searching Extended Job Properties** When searching extended job properties, the search criteria must include the table name and property name. For example, to get results based on the value of the field **employeeid** in the table **employees** the criteria would be similar to ``"q": "employees.employeeid = '101'"``. **Searching Groups** When searching jobs based on assigned groups, the search criteria must use ``groupID``. The returned job assignment will be group name. **Results pagination** The query results can be paginated by pre-defining the number of records to be returned in one page. For example, ``"num": 10`` will return 10 results on the page and ``"start": 5`` will start at the index 6 of the results. **Result syntax details** * q - the query for the search performed * fields - the fields whose value is returned in the search result along with their field type. If returning extended job properties, it will follow the same format as the search criteria. * results - an array of results, with value of fields defined in the search criteria returned for each result * start - The index of the results from which the list of results start on this page * nextStart - The index of the results from which the list of results will start on next page. If there are no more results, it returns -1. * num - The number of results returned in the page


/workflow/{itemId}/jobs/search

Usage and SDK Samples

curl -X POST\
 -H "Accept: application/json"\
 -H "Content-Type: application/json"\
 "http://localhost/workflow/{itemId}/jobs/search?token="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.JobsApi;

import java.io.File;
import java.util.*;

public class JobsApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        JobsApi apiInstance = new JobsApi();
        String itemId = itemId_example; // String | 
        String token = token_example; // String | 
        EsriWorkflowModelsRestJobQuery body = ; // EsriWorkflowModelsRestJobQuery | 
        
        try {
            esri.workflow.models.rest.JobQueryResult result = apiInstance.searchJobs(itemId, token, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobsApi#searchJobs");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.JobsApi;

public class JobsApiExample {
    public static void main(String[] args) {
        JobsApi apiInstance = new JobsApi();
        String itemId = itemId_example; // String | 
        String token = token_example; // String | 
        EsriWorkflowModelsRestJobQuery body = ; // EsriWorkflowModelsRestJobQuery | 
        
        try {
            esri.workflow.models.rest.JobQueryResult result = apiInstance.searchJobs(itemId, token, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobsApi#searchJobs");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
JobsApi *apiInstance = [[JobsApi alloc] init];
String *itemId = itemId_example; //  (default to null)
String *token = token_example; //  (optional) (default to null)
EsriWorkflowModelsRestJobQuery *body = ; //  (optional)

// Search for jobs in the system
[apiInstance searchJobsWith:itemId
    token:token
    body:body
              completionHandler: ^(esri.workflow.models.rest.JobQueryResult output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var WorkflowManagerApi = require('workflow_manager_api');

// Create an instance of the API class
var api = new WorkflowManagerApi.JobsApi()
var itemId = itemId_example; // {String} 
var opts = {
  'token': token_example, // {String} 
  'body':  // {EsriWorkflowModelsRestJobQuery} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.searchJobs(itemId, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class searchJobsExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new JobsApi();
            var itemId = itemId_example;  // String |  (default to null)
            var token = token_example;  // String |  (optional)  (default to null)
            var body = new EsriWorkflowModelsRestJobQuery(); // EsriWorkflowModelsRestJobQuery |  (optional) 

            try {
                // Search for jobs in the system
                esri.workflow.models.rest.JobQueryResult result = apiInstance.searchJobs(itemId, token, body);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling JobsApi.searchJobs: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\JobsApi();
$itemId = itemId_example; // String | 
$token = token_example; // String | 
$body = ; // EsriWorkflowModelsRestJobQuery | 

try {
    $result = $api_instance->searchJobs($itemId, $token, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling JobsApi->searchJobs: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::JobsApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::JobsApi->new();
my $itemId = itemId_example; # String | 
my $token = token_example; # String | 
my $body = WWW::OPenAPIClient::Object::EsriWorkflowModelsRestJobQuery->new(); # EsriWorkflowModelsRestJobQuery | 

eval { 
    my $result = $api_instance->searchJobs(itemId => $itemId, token => $token, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling JobsApi->searchJobs: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.JobsApi()
itemId = itemId_example # String |  (default to null)
token = token_example # String |  (optional) (default to null)
body =  # EsriWorkflowModelsRestJobQuery |  (optional)

try: 
    # Search for jobs in the system
    api_response = api_instance.search_jobs(itemId, token=token, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling JobsApi->searchJobs: %s\n" % e)
extern crate JobsApi;

pub fn main() {
    let itemId = itemId_example; // String
    let token = token_example; // String
    let body = ; // EsriWorkflowModelsRestJobQuery

    let mut context = JobsApi::Context::default();
    let result = client.searchJobs(itemId, token, body, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
itemId*
String
Required
Body parameters
Name Description
body

The search criteria based on which result will be returned, along with information about fields to return, sorting criteria, starting index of results and number of results to return in one page.

Query parameters
Name Description
token
String

Responses


setJobLocation

Set the job's location

Set a location of work for an exisiting job. The geometry for the job location must be in the ArcGIS REST API geometry JSON format and in the the WGS 1984 Web Mercator (Auxiliary Sphere) coordinate system (spatial reference 3857). The **jobUpdateLocation** privilege is required to set a location on a job. **Location Parameters:** | Parameter | Description | Data Type | | ---------- | ----------- | --------- | | geometryType | Optional. Type of location defined. Parameter ``geomteryType`` is required if a ``geometry`` is specified. Supported geometry types are **Multipoint**, **Polyline**, and **Polygon**. Multipoint geometry type supports both Point and Multipoint geometries. | String | | geometry | Optional. Coordinates and spatial reference for the location. Currently only the Web Mercator spatial reference (3857) is supported. | String |


/workflow/{itemId}/jobs/{jobId}/location

Usage and SDK Samples

curl -X PUT\
 -H "Accept: application/json"\
 -H "Content-Type: application/json"\
 "http://localhost/workflow/{itemId}/jobs/{jobId}/location?token="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.JobsApi;

import java.io.File;
import java.util.*;

public class JobsApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        JobsApi apiInstance = new JobsApi();
        String jobId = jobId_example; // String | 
        String itemId = itemId_example; // String | 
        String token = token_example; // String | 
        EsriWorkflowModelsRestLocationBody body = ; // EsriWorkflowModelsRestLocationBody | 
        
        try {
            Success result = apiInstance.setJobLocation(jobId, itemId, token, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobsApi#setJobLocation");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.JobsApi;

public class JobsApiExample {
    public static void main(String[] args) {
        JobsApi apiInstance = new JobsApi();
        String jobId = jobId_example; // String | 
        String itemId = itemId_example; // String | 
        String token = token_example; // String | 
        EsriWorkflowModelsRestLocationBody body = ; // EsriWorkflowModelsRestLocationBody | 
        
        try {
            Success result = apiInstance.setJobLocation(jobId, itemId, token, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobsApi#setJobLocation");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
JobsApi *apiInstance = [[JobsApi alloc] init];
String *jobId = jobId_example; //  (default to null)
String *itemId = itemId_example; //  (default to null)
String *token = token_example; //  (optional) (default to null)
EsriWorkflowModelsRestLocationBody *body = ; //  (optional)

// Set the job's location
[apiInstance setJobLocationWith:jobId
    itemId:itemId
    token:token
    body:body
              completionHandler: ^(Success output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var WorkflowManagerApi = require('workflow_manager_api');

// Create an instance of the API class
var api = new WorkflowManagerApi.JobsApi()
var jobId = jobId_example; // {String} 
var itemId = itemId_example; // {String} 
var opts = {
  'token': token_example, // {String} 
  'body':  // {EsriWorkflowModelsRestLocationBody} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.setJobLocation(jobId, itemId, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class setJobLocationExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new JobsApi();
            var jobId = jobId_example;  // String |  (default to null)
            var itemId = itemId_example;  // String |  (default to null)
            var token = token_example;  // String |  (optional)  (default to null)
            var body = new EsriWorkflowModelsRestLocationBody(); // EsriWorkflowModelsRestLocationBody |  (optional) 

            try {
                // Set the job's location
                Success result = apiInstance.setJobLocation(jobId, itemId, token, body);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling JobsApi.setJobLocation: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\JobsApi();
$jobId = jobId_example; // String | 
$itemId = itemId_example; // String | 
$token = token_example; // String | 
$body = ; // EsriWorkflowModelsRestLocationBody | 

try {
    $result = $api_instance->setJobLocation($jobId, $itemId, $token, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling JobsApi->setJobLocation: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::JobsApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::JobsApi->new();
my $jobId = jobId_example; # String | 
my $itemId = itemId_example; # String | 
my $token = token_example; # String | 
my $body = WWW::OPenAPIClient::Object::EsriWorkflowModelsRestLocationBody->new(); # EsriWorkflowModelsRestLocationBody | 

eval { 
    my $result = $api_instance->setJobLocation(jobId => $jobId, itemId => $itemId, token => $token, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling JobsApi->setJobLocation: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.JobsApi()
jobId = jobId_example # String |  (default to null)
itemId = itemId_example # String |  (default to null)
token = token_example # String |  (optional) (default to null)
body =  # EsriWorkflowModelsRestLocationBody |  (optional)

try: 
    # Set the job's location
    api_response = api_instance.set_job_location(jobId, itemId, token=token, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling JobsApi->setJobLocation: %s\n" % e)
extern crate JobsApi;

pub fn main() {
    let jobId = jobId_example; // String
    let itemId = itemId_example; // String
    let token = token_example; // String
    let body = ; // EsriWorkflowModelsRestLocationBody

    let mut context = JobsApi::Context::default();
    let result = client.setJobLocation(jobId, itemId, token, body, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
jobId*
String
Required
itemId*
String
Required
Body parameters
Name Description
body

Location of the job

Query parameters
Name Description
token
String

Responses


updateAttachments

Update existing embedded or linked attachment on a job

Update alias and folder names for existing attachments associated with a job. The **jobUpdateAttachments** privilege is required to update attachments on a job.


/workflow/{itemId}/jobs/{jobId}/attachments/{attachmentId}

Usage and SDK Samples

curl -X POST\
 -H "Accept: application/json"\
 -H "Content-Type: multipart/form-data"\
 "http://localhost/workflow/{itemId}/jobs/{jobId}/attachments/{attachmentId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.JobsApi;

import java.io.File;
import java.util.*;

public class JobsApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        JobsApi apiInstance = new JobsApi();
        String jobId = jobId_example; // String | 
        String attachmentId = attachmentId_example; // String | 
        String itemId = itemId_example; // String | 
        String token = token_example; // String | 
        String alias = alias_example; // String | Updated display name for the attachment. Alias cannot be set to null.
        String folder = folder_example; // String | New folder under which the attachment will be stored.
        
        try {
            Success result = apiInstance.updateAttachments(jobId, attachmentId, itemId, token, alias, folder);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobsApi#updateAttachments");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.JobsApi;

public class JobsApiExample {
    public static void main(String[] args) {
        JobsApi apiInstance = new JobsApi();
        String jobId = jobId_example; // String | 
        String attachmentId = attachmentId_example; // String | 
        String itemId = itemId_example; // String | 
        String token = token_example; // String | 
        String alias = alias_example; // String | Updated display name for the attachment. Alias cannot be set to null.
        String folder = folder_example; // String | New folder under which the attachment will be stored.
        
        try {
            Success result = apiInstance.updateAttachments(jobId, attachmentId, itemId, token, alias, folder);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobsApi#updateAttachments");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
JobsApi *apiInstance = [[JobsApi alloc] init];
String *jobId = jobId_example; //  (default to null)
String *attachmentId = attachmentId_example; //  (default to null)
String *itemId = itemId_example; //  (default to null)
String *token = token_example; //  (default to null)
String *alias = alias_example; // Updated display name for the attachment. Alias cannot be set to null. (optional) (default to null)
String *folder = folder_example; // New folder under which the attachment will be stored. (optional) (default to null)

// Update existing embedded or linked attachment on a job
[apiInstance updateAttachmentsWith:jobId
    attachmentId:attachmentId
    itemId:itemId
    token:token
    alias:alias
    folder:folder
              completionHandler: ^(Success output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var WorkflowManagerApi = require('workflow_manager_api');

// Create an instance of the API class
var api = new WorkflowManagerApi.JobsApi()
var jobId = jobId_example; // {String} 
var attachmentId = attachmentId_example; // {String} 
var itemId = itemId_example; // {String} 
var token = token_example; // {String} 
var opts = {
  'alias': alias_example, // {String} Updated display name for the attachment. Alias cannot be set to null.
  'folder': folder_example // {String} New folder under which the attachment will be stored.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateAttachments(jobId, attachmentId, itemId, token, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class updateAttachmentsExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new JobsApi();
            var jobId = jobId_example;  // String |  (default to null)
            var attachmentId = attachmentId_example;  // String |  (default to null)
            var itemId = itemId_example;  // String |  (default to null)
            var token = token_example;  // String |  (default to null)
            var alias = alias_example;  // String | Updated display name for the attachment. Alias cannot be set to null. (optional)  (default to null)
            var folder = folder_example;  // String | New folder under which the attachment will be stored. (optional)  (default to null)

            try {
                // Update existing embedded or linked attachment on a job
                Success result = apiInstance.updateAttachments(jobId, attachmentId, itemId, token, alias, folder);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling JobsApi.updateAttachments: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\JobsApi();
$jobId = jobId_example; // String | 
$attachmentId = attachmentId_example; // String | 
$itemId = itemId_example; // String | 
$token = token_example; // String | 
$alias = alias_example; // String | Updated display name for the attachment. Alias cannot be set to null.
$folder = folder_example; // String | New folder under which the attachment will be stored.

try {
    $result = $api_instance->updateAttachments($jobId, $attachmentId, $itemId, $token, $alias, $folder);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling JobsApi->updateAttachments: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::JobsApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::JobsApi->new();
my $jobId = jobId_example; # String | 
my $attachmentId = attachmentId_example; # String | 
my $itemId = itemId_example; # String | 
my $token = token_example; # String | 
my $alias = alias_example; # String | Updated display name for the attachment. Alias cannot be set to null.
my $folder = folder_example; # String | New folder under which the attachment will be stored.

eval { 
    my $result = $api_instance->updateAttachments(jobId => $jobId, attachmentId => $attachmentId, itemId => $itemId, token => $token, alias => $alias, folder => $folder);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling JobsApi->updateAttachments: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.JobsApi()
jobId = jobId_example # String |  (default to null)
attachmentId = attachmentId_example # String |  (default to null)
itemId = itemId_example # String |  (default to null)
token = token_example # String |  (default to null)
alias = alias_example # String | Updated display name for the attachment. Alias cannot be set to null. (optional) (default to null)
folder = folder_example # String | New folder under which the attachment will be stored. (optional) (default to null)

try: 
    # Update existing embedded or linked attachment on a job
    api_response = api_instance.update_attachments(jobId, attachmentId, itemId, token, alias=alias, folder=folder)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling JobsApi->updateAttachments: %s\n" % e)
extern crate JobsApi;

pub fn main() {
    let jobId = jobId_example; // String
    let attachmentId = attachmentId_example; // String
    let itemId = itemId_example; // String
    let token = token_example; // String
    let alias = alias_example; // String
    let folder = folder_example; // String

    let mut context = JobsApi::Context::default();
    let result = client.updateAttachments(jobId, attachmentId, itemId, token, alias, folder, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
jobId*
String
Required
attachmentId*
String
Required
itemId*
String
Required
Form parameters
Name Description
token*
String
Required
alias
String
Updated display name for the attachment. Alias cannot be set to null.
folder
String
New folder under which the attachment will be stored.

Responses


updateJob

Update the properties of a job

Updates one or more properties of a job specified in the provided job object. Specify just the properties to be updated in the job object, all other job properties will remain unchanged. Properties can be updated only if you have the required privilege for the property being updated. A job cannot be closed or assignment updated using this endpoint. Close a job using the **manageJobs** operation. Assignment can be updated using **assignStep**. Values for extended properties configured on the job template can be updated during a job update. A job cannot be updated if: * You have insufficient privileges * You are not the owner or if the job is not assigned to you. * The job is already running * The job is closed **Job Parameters:** | Parameter | Description | Data Type | Privilege | | --------- | ----------- | --------- | --------- | | jobName | Optional. Rename an existing job | String | jobUpdateName | | startDate | Optional. Update start date on an existing job | String representation of date | jobUpdateDate | | dueDate | Optional. Update due date on an existing job | String representation of date | jobUpdateDate | | priority | Optional. Update the priority on an existing job including ``"High"``, ``"Medium"``, and ``"Low"``. An invalid value defaults the priority to ``"Low"``. | String | jobUpdatePriority | | description | Optional. Update the description on an existing job | String | jobUpdateDescription | | ownedBy | Optional. Update the owner of an existing job | String | jobUpdateOwner | | percentComplete * | Optional. Update the percent of completion for an existing job | Double | jobUpdatePercentComplete | | jobStatus | Optional. Update the status of an existing job | String | jobUpdateStatus | | notes | Optional. Update notes on an existing job | String | jobUpdateNotes | | parentJob | Optional. Update the parent job information on an existing job | String | jobUpdateParentJob | | extendedProperties | Optional. Define additional properties on a job template specific to your business needs. | Array[ExtendedProperties] | jobUpdateExtendedProperties | | relatedProperties | Optional. Define 1-M properties on a job template specific to your business needs | Array[RelatedProperties] | jobUpdateExtendedProperties | **ExtendedProperties Parameters:** | Parameter | Description | Data Type | | ---------- | ----------- | --------- | | identifier | Required. Combination of the extended property table name and the extended property field name created in the job template, e.g. "tableName.fieldName" | String | | value | Optional. The updated value for the extended property. It must be a string representation of the extended property value. For example, ``"true"`` for a boolean, or ``"2020-11-01T22:00:32Z"`` for a date. If the value is ``null`` or not defined, the extended property value is cleared.| String | **RelatedProperties Parameters:** | Parameter | Description | Data Type | | ---------- | ----------- | --------- | | adds | Optional. Defines the entries to be added for the properties in the 1-M table for a job | Array[RelatedPropertyAdd] | | deletes | Optional. Defines the entries to be deleted for the properties in the 1-M table for a job | Array[RelatedPropertyDelete] | | updates | Optional. Defines the entries to be updated for the properties in the 1-M table for a job | Array[RelatedPropertyUpdate] | **RelatedPropertyAdd Parameters:** | Parameter | Description | Data Type | | ---------- | ----------- | --------- | | tableName | Required. The name of the table to be updated. | String | | entries | Required. Add multiple entries for a property in a 1-M table to associate with a single JobId. | Array[AddEntries] | **AddEntries Parameters:** | Parameter | Description | Data Type | | ---------- | ----------- | --------- | | properties | Required. Property parameters for the property that will be associated with the job. | Array[Properties] | **Properties Parameters:** | Parameter | Description | Data Type | | ---------- | ----------- | --------- | | propertyName | Required. Name of the property to be added to the Job as an entry.| String | | values | Required. Value for the related property to be associated with the job.| String | **RelatedPropertyDelete Parameters:** | Parameter | Description | Data Type | | ---------- | ----------- | --------- | | tableName | Required. The name of the table to be updated. | String | | id | Required. Id for an existing entry that is being deleted.| String | **RelatedPropertyUpdate Parameters:** | Parameter | Description | Data Type | | ---------- | ----------- | --------- | | tableName | Required. The name of the table to be updated. | String | | entries | Required. Add multiple entries for a property in a 1-M table to associate with a single JobId. | Array[UpdateEntries] | **UpdateEntries Parameters:** | Parameter | Description | Data Type | | ---------- | ----------- | --------- | | properties | Required. Property parameters for the property that will be associated with the job. | Array[Properties] | | ids | Required. Id for an existing entry that is being updated. | String |


/workflow/{itemId}/jobs/{jobId}/update

Usage and SDK Samples

curl -X POST\
 -H "Accept: application/json"\
 -H "Content-Type: application/json"\
 "http://localhost/workflow/{itemId}/jobs/{jobId}/update?token="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.JobsApi;

import java.io.File;
import java.util.*;

public class JobsApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        JobsApi apiInstance = new JobsApi();
        String jobId = jobId_example; // String | 
        String itemId = itemId_example; // String | 
        String token = token_example; // String | 
        JobOverrides body = ; // JobOverrides | 
        
        try {
            esri.workflow.models.rest.SuccessResponse result = apiInstance.updateJob(jobId, itemId, token, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobsApi#updateJob");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.JobsApi;

public class JobsApiExample {
    public static void main(String[] args) {
        JobsApi apiInstance = new JobsApi();
        String jobId = jobId_example; // String | 
        String itemId = itemId_example; // String | 
        String token = token_example; // String | 
        JobOverrides body = ; // JobOverrides | 
        
        try {
            esri.workflow.models.rest.SuccessResponse result = apiInstance.updateJob(jobId, itemId, token, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobsApi#updateJob");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
JobsApi *apiInstance = [[JobsApi alloc] init];
String *jobId = jobId_example; //  (default to null)
String *itemId = itemId_example; //  (default to null)
String *token = token_example; //  (optional) (default to null)
JobOverrides *body = ; //  (optional)

// Update the properties of a job
[apiInstance updateJobWith:jobId
    itemId:itemId
    token:token
    body:body
              completionHandler: ^(esri.workflow.models.rest.SuccessResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var WorkflowManagerApi = require('workflow_manager_api');

// Create an instance of the API class
var api = new WorkflowManagerApi.JobsApi()
var jobId = jobId_example; // {String} 
var itemId = itemId_example; // {String} 
var opts = {
  'token': token_example, // {String} 
  'body':  // {JobOverrides} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateJob(jobId, itemId, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class updateJobExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new JobsApi();
            var jobId = jobId_example;  // String |  (default to null)
            var itemId = itemId_example;  // String |  (default to null)
            var token = token_example;  // String |  (optional)  (default to null)
            var body = new JobOverrides(); // JobOverrides |  (optional) 

            try {
                // Update the properties of a job
                esri.workflow.models.rest.SuccessResponse result = apiInstance.updateJob(jobId, itemId, token, body);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling JobsApi.updateJob: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\JobsApi();
$jobId = jobId_example; // String | 
$itemId = itemId_example; // String | 
$token = token_example; // String | 
$body = ; // JobOverrides | 

try {
    $result = $api_instance->updateJob($jobId, $itemId, $token, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling JobsApi->updateJob: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::JobsApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::JobsApi->new();
my $jobId = jobId_example; # String | 
my $itemId = itemId_example; # String | 
my $token = token_example; # String | 
my $body = WWW::OPenAPIClient::Object::JobOverrides->new(); # JobOverrides | 

eval { 
    my $result = $api_instance->updateJob(jobId => $jobId, itemId => $itemId, token => $token, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling JobsApi->updateJob: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.JobsApi()
jobId = jobId_example # String |  (default to null)
itemId = itemId_example # String |  (default to null)
token = token_example # String |  (optional) (default to null)
body =  # JobOverrides |  (optional)

try: 
    # Update the properties of a job
    api_response = api_instance.update_job(jobId, itemId, token=token, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling JobsApi->updateJob: %s\n" % e)
extern crate JobsApi;

pub fn main() {
    let jobId = jobId_example; // String
    let itemId = itemId_example; // String
    let token = token_example; // String
    let body = ; // JobOverrides

    let mut context = JobsApi::Context::default();
    let result = client.updateJob(jobId, itemId, token, body, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
jobId*
String
Required
itemId*
String
Required
Body parameters
Name Description
body

A job object defining the job

Query parameters
Name Description
token
String

Responses


Routes

checkStatus

Check the status and license capability of Workflow Manager server

Checks the status of Workflow Manager server and returns the license capability level.


/workflow/checkStatus

Usage and SDK Samples

curl -X GET\
 -H "Accept: application/json"\
 "http://localhost/workflow/checkStatus?token="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.RoutesApi;

import java.io.File;
import java.util.*;

public class RoutesApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        RoutesApi apiInstance = new RoutesApi();
        String token = token_example; // String | 
        
        try {
            esri.workflow.models.rest.Status result = apiInstance.checkStatus(token);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RoutesApi#checkStatus");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.RoutesApi;

public class RoutesApiExample {
    public static void main(String[] args) {
        RoutesApi apiInstance = new RoutesApi();
        String token = token_example; // String | 
        
        try {
            esri.workflow.models.rest.Status result = apiInstance.checkStatus(token);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RoutesApi#checkStatus");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
RoutesApi *apiInstance = [[RoutesApi alloc] init];
String *token = token_example; //  (optional) (default to null)

// Check the status and license capability of Workflow Manager server
[apiInstance checkStatusWith:token
              completionHandler: ^(esri.workflow.models.rest.Status output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var WorkflowManagerApi = require('workflow_manager_api');

// Create an instance of the API class
var api = new WorkflowManagerApi.RoutesApi()
var opts = {
  'token': token_example // {String} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.checkStatus(opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class checkStatusExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new RoutesApi();
            var token = token_example;  // String |  (optional)  (default to null)

            try {
                // Check the status and license capability of Workflow Manager server
                esri.workflow.models.rest.Status result = apiInstance.checkStatus(token);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling RoutesApi.checkStatus: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\RoutesApi();
$token = token_example; // String | 

try {
    $result = $api_instance->checkStatus($token);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RoutesApi->checkStatus: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::RoutesApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::RoutesApi->new();
my $token = token_example; # String | 

eval { 
    my $result = $api_instance->checkStatus(token => $token);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling RoutesApi->checkStatus: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.RoutesApi()
token = token_example # String |  (optional) (default to null)

try: 
    # Check the status and license capability of Workflow Manager server
    api_response = api_instance.check_status(token=token)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RoutesApi->checkStatus: %s\n" % e)
extern crate RoutesApi;

pub fn main() {
    let token = token_example; // String

    let mut context = RoutesApi::Context::default();
    let result = client.checkStatus(token, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
token
String

Responses


createDiagram

Create a new workflow diagram

Create a workflow diagram. Diagrams can be saved in active or non-active (draft) mode. A diagram cannot be used to create jobs if the diagram is not active. A diagram will be validated when activated. The **adminBasic** or **adminAdvanced** privilege is required to create a workflow diagram. Validation rules include: * The diagram only has one initial step. * The diagram cannot have orphan steps. **WorkflowDiagram Parameters:** | Parameter | Description | Data Type | | ----------- | ----------- | --------- | | diagramId | Optional. The unique ID of the diagram to be created. | String | | diagramName | Required. The name of the diagram to be created. | String | | description | Optional. The description of the diagram to be created. | String | | active | Optional. If it is not defined, it is set to false. | Boolean | | steps | Required. The step(s) in the diagram to be created. See details for **Step**. | Array[Step] | | annotations | Optional. The annotations of the diagram to be created. See details for **Annotation**. | Array[Annotation] | | displayGrid | Required. If true, the grid is displayed in the diagram to be created. | Boolean | | dataSources | Optional. Spatial data that will be used in the steps of the diagram. See details for **DataSources** | Array[DataSources] | **Step:** | Parameter | Description | Data Type | | ------------------ | ----------- | --------- | | id | Required. Step ID in the diagram to be created. | String | | name | Required. Step name in the diagram to be created. | String | | description | Optional. Step description in the diagram to be created. | String | | stepTemplateId | Optional. Step template being used for the step. | String | | automatic | Required. If true, the step is executed automatically. | Boolean | | canComment | Optional. If true, the user can add comments to the job. | Boolean | | commentRequired | Optional. If true, the user cannot proceed without adding a comment. | Boolean | | proceedNext | Required. If true, the diagram is proceeded to next step automatically. | Boolean | | canSkip | Required. If true, the step can be skipped. | Boolean | | position | Required. The graphical position of the step. | String | | shape | Required. The graphical shape of the step. | Number | | color | Optional. The color of the step displayed in the diagram. | String | | outlineColor | Optional. The outline color of the step. | String | | labelColor | Optional. The color of the step label. | String | | action | Required. The step action including definition of **actionType** and **args**. | String | | paths | Required. The step paths to define next step and assignment. See details for **StepPath** | Array[StepPath] | | helpUrl | Optional. The URL to open step help. | String | | helpText | Optional. The step help message. | String | | schedule | Optional. If defined, the step is run on a schedule. See details for **Schedule**. | Object | **StepPath:** | Parameter | Description | Data Type | | --------------- | ----------- | ----------- | | nextStep | Required. The next step ID. | String | | expression | Optional. The condition to determine next step if the current step has more than one next step. | String | | label | Optional. The label for the next step. | String | | assignedTo | Optional. The assignment for next step. | String | | assignedType | Optional. The assignment type for next step. Allowed values are **Unassigned**, **User**, and **Group**. **Unassigned** must be set if **assignedTo** is empty. | String | | points | Required. The position of path to connect the current step to next step. | Array[Point] | | ports | Required. The port position of path to connect the current step to next step. | Array[String] | | status | Optional. The status of the next step. | String | | notifications | Optional. The notification sent when reaching next step. | Array[String] | | lineColor | Optional. The line color of the path. | String | | labelColor | Optional. The label color of the path. | String | **Schedule:** | Parameter | Description | Data Type | | --------------- | ----------- | ----------- | | scheduleType | Optional. The schedule type for the step. Allowed values are **Duration**, **SpecificTime**, and **Expression**. | String | | timeDuration | Required if the **scheduleType** is **Duration**. The time duration before running the step. See details for **TimeDuration**. | Object | | specificTime | Required if the **scheduleType** is **SpecificTime**. The specific time to run the step. See details for **SpecificTime**. | Object | | expression | Required if the **scheduleType** is **Expression**. The arcade expression defined for the specific time to run the step. | String | **TimeDuration:** | Parameter | Description | Data Type | | --------------- | ----------- | ----------- | | months | Optional. The number of months until running the step. | Integer | | days | Optional. The number of days until running the step. | Integer | | hours | Optional. The number of hours until running the step. | Integer | | minutes | Optional. The number of minutess until running the step. | Integer | | offset | Optional. The buffer offset of the number of minutes allowed to run the step based on scheduled time. | Integer | **SpecificTime:** | Parameter | Description | Data Type | | --------------- | ----------- | ----------- | | type | Optional. The type of the **specificTime** to run the step. Allowed values are **HourOfDay**, **DayOfWeek**, **DayOfMonth**, and **MonthOfYear**. | String | | dayOfWeek | Optional. Which day of the week to run the step. 1 - Monday to 7 - Sunday | Integer | | dayOfMonth | Optional. Which day of the month to run the step. | Integer | | month | Optional. The month to run the step. 1 - January to 12 - December | Integer | | hour | Optional. The hour to run the step. Allowed values are the integer between 1 and 23 | Integer | | minute | Optional. The minute to run the step. Allowed values are the integer between 0 and 59 | Integer | | offset | Optional. The buffer offset of the number of minutes allowed to run the step based on scheduled time. | Integer | **DataSources:** | Parameter | Description | Data Type | | ------------------ | ----------- | --------- | | name | Required. The unique name of the data source to be stored in the diagram. | String | | url | Required. The url of the data source such as the portal item url for a feature service. | String | | sourceType | Required. The type of data source such as branch versioned feature service. | String | **Annotation:** | Parameter | Description | Data Type | | --------------- | ----------- | ----------- | | position | Required. Annotation position. | String | | color | Optional. Annotation text color. | String | | outlineColor | Optional. The Outline color of the annotation. | String | | labelColor | Optional. The label color of the annotation. | String | | text | Required. Annotation text. | String |


/workflow/{itemId}/diagrams

Usage and SDK Samples

curl -X POST\
 -H "Accept: application/json"\
 -H "Content-Type: application/json"\
 "http://localhost/workflow/{itemId}/diagrams?token="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.RoutesApi;

import java.io.File;
import java.util.*;

public class RoutesApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        RoutesApi apiInstance = new RoutesApi();
        String itemId = itemId_example; // String | 
        String token = token_example; // String | 
        EsriWorkflowModelsRestDiagramWorkflowDiagram body = ; // EsriWorkflowModelsRestDiagramWorkflowDiagram | 
        
        try {
            inline_response_200_7 result = apiInstance.createDiagram(itemId, token, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RoutesApi#createDiagram");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.RoutesApi;

public class RoutesApiExample {
    public static void main(String[] args) {
        RoutesApi apiInstance = new RoutesApi();
        String itemId = itemId_example; // String | 
        String token = token_example; // String | 
        EsriWorkflowModelsRestDiagramWorkflowDiagram body = ; // EsriWorkflowModelsRestDiagramWorkflowDiagram | 
        
        try {
            inline_response_200_7 result = apiInstance.createDiagram(itemId, token, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RoutesApi#createDiagram");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
RoutesApi *apiInstance = [[RoutesApi alloc] init];
String *itemId = itemId_example; //  (default to null)
String *token = token_example; //  (optional) (default to null)
EsriWorkflowModelsRestDiagramWorkflowDiagram *body = ; //  (optional)

// Create a new workflow diagram
[apiInstance createDiagramWith:itemId
    token:token
    body:body
              completionHandler: ^(inline_response_200_7 output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var WorkflowManagerApi = require('workflow_manager_api');

// Create an instance of the API class
var api = new WorkflowManagerApi.RoutesApi()
var itemId = itemId_example; // {String} 
var opts = {
  'token': token_example, // {String} 
  'body':  // {EsriWorkflowModelsRestDiagramWorkflowDiagram} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createDiagram(itemId, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class createDiagramExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new RoutesApi();
            var itemId = itemId_example;  // String |  (default to null)
            var token = token_example;  // String |  (optional)  (default to null)
            var body = new EsriWorkflowModelsRestDiagramWorkflowDiagram(); // EsriWorkflowModelsRestDiagramWorkflowDiagram |  (optional) 

            try {
                // Create a new workflow diagram
                inline_response_200_7 result = apiInstance.createDiagram(itemId, token, body);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling RoutesApi.createDiagram: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\RoutesApi();
$itemId = itemId_example; // String | 
$token = token_example; // String | 
$body = ; // EsriWorkflowModelsRestDiagramWorkflowDiagram | 

try {
    $result = $api_instance->createDiagram($itemId, $token, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RoutesApi->createDiagram: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::RoutesApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::RoutesApi->new();
my $itemId = itemId_example; # String | 
my $token = token_example; # String | 
my $body = WWW::OPenAPIClient::Object::EsriWorkflowModelsRestDiagramWorkflowDiagram->new(); # EsriWorkflowModelsRestDiagramWorkflowDiagram | 

eval { 
    my $result = $api_instance->createDiagram(itemId => $itemId, token => $token, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling RoutesApi->createDiagram: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.RoutesApi()
itemId = itemId_example # String |  (default to null)
token = token_example # String |  (optional) (default to null)
body =  # EsriWorkflowModelsRestDiagramWorkflowDiagram |  (optional)

try: 
    # Create a new workflow diagram
    api_response = api_instance.create_diagram(itemId, token=token, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RoutesApi->createDiagram: %s\n" % e)
extern crate RoutesApi;

pub fn main() {
    let itemId = itemId_example; // String
    let token = token_example; // String
    let body = ; // EsriWorkflowModelsRestDiagramWorkflowDiagram

    let mut context = RoutesApi::Context::default();
    let result = client.createDiagram(itemId, token, body, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
itemId*
String
Required
Body parameters
Name Description
body

a diagram object defining the diagram

Query parameters
Name Description
token
String

Responses


createJobTemplate

Create a job template

Create a job template by defining job template properties. Using ``JobCreator($job)`` as the default assignment when creating a job template will automatically assign the first step in the job to the person who creates the job. If the assignment of the job is updated to a different user during job creation the job template's assignment will be overridden in the new job. Additional properties called extended property tables can be added to your job template during creation. These tables consist of different extended properties based on your business needs. Each property in a table must have a unique name. Two tables can have properties with the same unique name. The **adminBasic** or **adminAdvanced** privilege is required. **Job Template Parameters:** | Parameter | Description | Data Type | | ----------- | ----------- | --------- | | jobTemplateId | Optional. Define the unique ID of the job template to be created. | String | | jobTemplateName | Required. Define the name of the job template to be created. | String | | diagramId | Required. The Id of the diagram to be associated with the job template to be created. | String | | diagramName | Required. The name of the diagram to be associated with the job template to be created. | String | | defaultJobName | Optional. Define the default job name on a job template. If null, it is set to ``JOB_[index]``. | String | | defaultAssignedType | Optional. Define the default assignment type on a job template. Allowed types are ``User``, ``Group``, ``Unassigned``. If null, it is set to ``Unassigned``. | String | | defaultAssignedTo | Optional. Define the default assignment on a job template. Required only if the default assignment type is ``User`` or ``Group``. | String | | jobStartDateType | Optional. Define the type of the default start date on a job template. Allowed types are ``CreationDate`` and ``SpecificDate``. If null, it is set to ``CreationDate``. | String | | defaultStartDate | Optional. Define the default start date on a job template. If job start date type is ``CreationDate``, then this field is ignored. | Date | | defaultDueDate | Optional. Define the default end date on a job template. | Date | | defaultJobDuration | Optional. Define the default job duration on a job template. Use this in place of ``defaultDueDate`` to specify the default due date to be some number of days after the start date. This field is ignored if ``defaultDueDate`` is specified. | Date | | defaultPriorityName | Required. Define the initial priority on a job template. If no matching property is found in the priorities lookup table, then the first priority value will be used. | String | | defaultStatus | Optional. Define the initial job status on a job template. If null, it is set to ``Ready``. | String | | defaultFinalStatus | Optional. Define the final job status on a job template. If null, it is set to ``Closed``. | String | | activities | Optional. Define job activities on a job template to trigger sending the email or web requests. | Array[Activity] | | extendedPropertyTableDefinitions | Optional. Define additional properties on a job template specific to your business needs. | Array[ExtendedPropertyTableDefinition] | | state | Required. Set the initial state of the job template. Allowed states are ``Draft``, ``Active``, ``Retired``. | String | **ExtendedPropertyTableDefinition Parameters:** | Parameter | Description | Data Type | | ------------------ | ----------- | --------- | | tableName | Required. The unique name of the table to be created. The name must be unique across all job templates in the system. | String | | tableAlias | Required. Display name for the table. Display name doesn't need to be unique and can be duplicated in the system. | String | | order | Required. Order in which the tables will appear. | Integer | | relationshipType | Required. Allows you to define the relationship between the table and the job. Allowed values are ``OnetoMany`` and ``OnetoOne``. OnetoMany means that there can be any number of records in each table for each job. OnetoOne means that there will be 1 record in each configured table for each job. | String | | featureServiceProperties | Optional. Only applicable when creating feature service extended properties.If featureServiceProperties parameters are not specified the extended property table will be created as a standard table. | FeatureServiceProperties | | updateExisting | Optional. An existing table will be updated if set to true. Only applicable when updating a job template. | Boolean | | extendedPropertyDefinitions | Required. Define different properties in the table. | Array[ExtendedPropertyDefinition] | **FeatureServiceProperties Parameters:** | Parameter | Description | Data Type | | --------------- | ----------- | ----------- | | itemId | Required. ItemId for the feature service in Portal or AGOL. | String | | layerId | Required. LayerId for the layer in the Feature service that will be added as an extended property table | String | | portalType | Required. Specify where the feature service is located. ``Current`` for feature services available on the same portal as Workflow Manager, ``ArcGISOnline`` for feature services available on AGOL and ``Other`` for public feature services available on a different portal | String | | portalUrl | Optional. Specify the complete portal url for the feature service. This field is only required for portalType ``Other`` | String | | featureServiceUniqueId | Required. Unique field defined on the feature service layer to be associated with the extended properties table. | String | | secure | Optional. Specify whether the feature service is secure or not. Default value for secure is false when it is not specified. For portalType ``Current`` secure is set to true by default. | Boolean | **ExtendedPropertyDefinition Parameters:** | Parameter | Description | Data Type | | --------------- | ----------- | ----------- | | propertyName | Required. Name of the property inside the table. It can only contain lowercase letters, numbers or underscores. Each property in a table must have a unique name. Two tables can have properties with the same unique name. | String | | propertyAlias | Required. Display name for the property. | String | | propertyOrder | Required. The order in which the proeprty will appear inside the table. | Integer | | dataType | Required. DataType for the property inside the table. Allowed data types are ``Integer``, ``Double``, ``Boolean``, ``DateTime`` or ``String``. | String | | defaultValue | Optional. The default value placed in the field when the record is created for this property. The default value of a string field dataType cannot exceed the fieldLength limit. The maximum allowed length is 5000 characters, even if the fieldLength size is greater than 5000. | Value based on DataType | | fieldLength | Required for string dataType, not applicable and can be omitted for other types. | Integer | | required | Required. Whether the property value is required or not. For feature service extended properties this will be set to ``false`` by default. | Boolean | | editable | Required. Whether the property can be edited or not. For feature service extended properties, only the field defined as the featureServiceUniqueId is editable. | Boolean | | visible | Required. Whether the property is visible to the user in the client application. | Boolean | | domain | Optional. Used when using domains to constrain values allowed for a particular property. Domains are only supported for ``Integer``, ``Double``, and ``String`` data types. It is not supported for ``Boolean`` and ``DateTime`` types and will be ignored for those types.| Domain | **Domain Parameters:** | Parameter | Description | Data Type | | --------------- | ----------- | ----------- | | type | Required. Specify the type of domain being used, codedValue or range. | String | | codedValues | Optional. Specify an array of valid codes and names for a property. | Array[CodedValue] | | range | Optional. Specify a range of valid minimum and maximum values for a property. For example, ``["1","5"]`` | Array[String] | **CodedValue Parameters:** | Parameter | Description | Data Type | | --------------- | ----------- | ----------- | | code | Required. Specify a value for the property. | Integer, Double, String | | name | Required. User-friendly description of what the code actually means. | String | **Activity Parameters:** | Parameter | Description | Data Type | | ------------------ | ----------- | --------- | | typeName | Required. The name of the job activity. The allowed activity type names are ``createJob``, ``closeJob``, ``addComment``, ``setCurrentStep``, ``assignJob``, and ``deleteJob``. | String | | actionName | Required. The action name triggered by the job activity. The allowed action name is ``Email``. | String | | templateId | Required. The id of the template being used to send email or web request. | String |


/workflow/{itemId}/jobTemplates

Usage and SDK Samples

curl -X POST\
 -H "Accept: application/json"\
 -H "Content-Type: application/json"\
 "http://localhost/workflow/{itemId}/jobTemplates?token="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.RoutesApi;

import java.io.File;
import java.util.*;

public class RoutesApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        RoutesApi apiInstance = new RoutesApi();
        String itemId = itemId_example; // String | 
        String token = token_example; // String | 
        EsriWorkflowModelsRestJobTemplate body = ; // EsriWorkflowModelsRestJobTemplate | 
        
        try {
            inline_response_200_4 result = apiInstance.createJobTemplate(itemId, token, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RoutesApi#createJobTemplate");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.RoutesApi;

public class RoutesApiExample {
    public static void main(String[] args) {
        RoutesApi apiInstance = new RoutesApi();
        String itemId = itemId_example; // String | 
        String token = token_example; // String | 
        EsriWorkflowModelsRestJobTemplate body = ; // EsriWorkflowModelsRestJobTemplate | 
        
        try {
            inline_response_200_4 result = apiInstance.createJobTemplate(itemId, token, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RoutesApi#createJobTemplate");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
RoutesApi *apiInstance = [[RoutesApi alloc] init];
String *itemId = itemId_example; //  (default to null)
String *token = token_example; //  (optional) (default to null)
EsriWorkflowModelsRestJobTemplate *body = ; //  (optional)

// Create a job template
[apiInstance createJobTemplateWith:itemId
    token:token
    body:body
              completionHandler: ^(inline_response_200_4 output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var WorkflowManagerApi = require('workflow_manager_api');

// Create an instance of the API class
var api = new WorkflowManagerApi.RoutesApi()
var itemId = itemId_example; // {String} 
var opts = {
  'token': token_example, // {String} 
  'body':  // {EsriWorkflowModelsRestJobTemplate} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createJobTemplate(itemId, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class createJobTemplateExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new RoutesApi();
            var itemId = itemId_example;  // String |  (default to null)
            var token = token_example;  // String |  (optional)  (default to null)
            var body = new EsriWorkflowModelsRestJobTemplate(); // EsriWorkflowModelsRestJobTemplate |  (optional) 

            try {
                // Create a job template
                inline_response_200_4 result = apiInstance.createJobTemplate(itemId, token, body);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling RoutesApi.createJobTemplate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\RoutesApi();
$itemId = itemId_example; // String | 
$token = token_example; // String | 
$body = ; // EsriWorkflowModelsRestJobTemplate | 

try {
    $result = $api_instance->createJobTemplate($itemId, $token, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RoutesApi->createJobTemplate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::RoutesApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::RoutesApi->new();
my $itemId = itemId_example; # String | 
my $token = token_example; # String | 
my $body = WWW::OPenAPIClient::Object::EsriWorkflowModelsRestJobTemplate->new(); # EsriWorkflowModelsRestJobTemplate | 

eval { 
    my $result = $api_instance->createJobTemplate(itemId => $itemId, token => $token, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling RoutesApi->createJobTemplate: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.RoutesApi()
itemId = itemId_example # String |  (default to null)
token = token_example # String |  (optional) (default to null)
body =  # EsriWorkflowModelsRestJobTemplate |  (optional)

try: 
    # Create a job template
    api_response = api_instance.create_job_template(itemId, token=token, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RoutesApi->createJobTemplate: %s\n" % e)
extern crate RoutesApi;

pub fn main() {
    let itemId = itemId_example; // String
    let token = token_example; // String
    let body = ; // EsriWorkflowModelsRestJobTemplate

    let mut context = RoutesApi::Context::default();
    let result = client.createJobTemplate(itemId, token, body, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
itemId*
String
Required
Body parameters
Name Description
body

a job template object defining the job template

Query parameters
Name Description
token
String

Responses


createJobs

Create a job

Create a new job by defining the basic properties of a job. A job is a unit of work performed by one or more people. For example, updating parcel data, creating a new work plan for a residential subdivision, and creating a map of a specific scale each qualifies as a job. Each individual job is an instance of the job template, which serves as the blueprint for a job. You can choose to assign the first step in a job to the user creating the job by setting the job's default assignment to ``JobCreator($job)``. During job creation, the job's default assignment takes precedence over the job template's default assignment. Values for extended properties configured on the job template can be updated during job creation. If no properties are provided while creating a job, the job is created with the default values in the job template. The first step runs automatically at job creation if it is configured to run automatically and assigned to the job creator. The **jobCreate** privilege is required. A job will not be created in the following cases: * Invalid or no job template is provided * Job template is not in Active state * A value other than User, Group or Unassigned is provided for assignedType * If the due date is before the provided start date * An invalid number of jobs is provided **Job Parameters:** | Parameter | Description | Data Type | | ---------- | ----------- | --------- | | numberOfJobs | Optional. Define the number of jobs to be created with the specified job configuration. | Integer | | jobId | Optional. Define the unique jobId of the job to be created. Once defined, only one job can be created.| String | | location | Optional. Define an area of location for your job. | Location | | extendedProperties | Optional. Define additional properties on a job template specific to your business needs. | Array[ExtendedProperties] | | relatedProperties | Optional. Define additional 1-M properties on a job template specific to your business needs. | Array[RelatedProperties] | **Location Parameters:** | Parameter | Description | Data Type | | ---------- | ----------- | --------- | | geometryType | Optional. Type of location defined. geometryType is required if a geometry is specified. Supported geometry types are ``Multipoint``, ``Polyline``, ``Polygon``| String | | geometry | Optional. Coordinates and spatial reference for the location.| String | **ExtendedProperties Parameters:** | Parameter | Description | Data Type | | ---------- | ----------- | --------- | | identifier | Required. Combination of the extended property table name and the extended property field name created in the job template, for example, "tableName.fieldName" | String | | value | Optional. The value placed in the field when the record is created for this property. It must be a string representation of the extended property value. For example, ``"true"`` for a boolean, or ``"2020-11-01T22:00:32Z"`` for a date. If the value is ``null`` or not defined, the extended property value is cleared.| String | **RelatedProperties Parameters:** | Parameter | Description | Data Type | | ---------- | ----------- | --------- | | tableName | Required. The name of the table to be updated. | String | | entries | Required. Add multiple entries for a property in a 1-M table to associate with a single JobId| Array[Entries] | **Entries Parameters:** | properties | Required. Property parameters for the property that will be associated with the job| Array[Properties] | **Properties Parameters:** | propertyName | Required. Name of the property to be added to the Job as an entry.| String | | values | Required. Value for the related property to be associated with the job.| String |


/workflow/{itemId}/jobTemplates/{jobTemplateId}/job

Usage and SDK Samples

curl -X POST\
 -H "Accept: application/json"\
 -H "Content-Type: application/json"\
 "http://localhost/workflow/{itemId}/jobTemplates/{jobTemplateId}/job?token="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.RoutesApi;

import java.io.File;
import java.util.*;

public class RoutesApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        RoutesApi apiInstance = new RoutesApi();
        String jobTemplateId = jobTemplateId_example; // String | 
        String itemId = itemId_example; // String | 
        String token = token_example; // String | 
        CreateJobOverrides body = ; // CreateJobOverrides | 
        
        try {
            esri.workflow.models.rest.CreateJobsResponse result = apiInstance.createJobs(jobTemplateId, itemId, token, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RoutesApi#createJobs");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.RoutesApi;

public class RoutesApiExample {
    public static void main(String[] args) {
        RoutesApi apiInstance = new RoutesApi();
        String jobTemplateId = jobTemplateId_example; // String | 
        String itemId = itemId_example; // String | 
        String token = token_example; // String | 
        CreateJobOverrides body = ; // CreateJobOverrides | 
        
        try {
            esri.workflow.models.rest.CreateJobsResponse result = apiInstance.createJobs(jobTemplateId, itemId, token, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RoutesApi#createJobs");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
RoutesApi *apiInstance = [[RoutesApi alloc] init];
String *jobTemplateId = jobTemplateId_example; //  (default to null)
String *itemId = itemId_example; //  (default to null)
String *token = token_example; //  (optional) (default to null)
CreateJobOverrides *body = ; //  (optional)

// Create a job
[apiInstance createJobsWith:jobTemplateId
    itemId:itemId
    token:token
    body:body
              completionHandler: ^(esri.workflow.models.rest.CreateJobsResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var WorkflowManagerApi = require('workflow_manager_api');

// Create an instance of the API class
var api = new WorkflowManagerApi.RoutesApi()
var jobTemplateId = jobTemplateId_example; // {String} 
var itemId = itemId_example; // {String} 
var opts = {
  'token': token_example, // {String} 
  'body':  // {CreateJobOverrides} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createJobs(jobTemplateId, itemId, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class createJobsExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new RoutesApi();
            var jobTemplateId = jobTemplateId_example;  // String |  (default to null)
            var itemId = itemId_example;  // String |  (default to null)
            var token = token_example;  // String |  (optional)  (default to null)
            var body = new CreateJobOverrides(); // CreateJobOverrides |  (optional) 

            try {
                // Create a job
                esri.workflow.models.rest.CreateJobsResponse result = apiInstance.createJobs(jobTemplateId, itemId, token, body);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling RoutesApi.createJobs: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\RoutesApi();
$jobTemplateId = jobTemplateId_example; // String | 
$itemId = itemId_example; // String | 
$token = token_example; // String | 
$body = ; // CreateJobOverrides | 

try {
    $result = $api_instance->createJobs($jobTemplateId, $itemId, $token, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RoutesApi->createJobs: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::RoutesApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::RoutesApi->new();
my $jobTemplateId = jobTemplateId_example; # String | 
my $itemId = itemId_example; # String | 
my $token = token_example; # String | 
my $body = WWW::OPenAPIClient::Object::CreateJobOverrides->new(); # CreateJobOverrides | 

eval { 
    my $result = $api_instance->createJobs(jobTemplateId => $jobTemplateId, itemId => $itemId, token => $token, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling RoutesApi->createJobs: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.RoutesApi()
jobTemplateId = jobTemplateId_example # String |  (default to null)
itemId = itemId_example # String |  (default to null)
token = token_example # String |  (optional) (default to null)
body =  # CreateJobOverrides |  (optional)

try: 
    # Create a job
    api_response = api_instance.create_jobs(jobTemplateId, itemId, token=token, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RoutesApi->createJobs: %s\n" % e)
extern crate RoutesApi;

pub fn main() {
    let jobTemplateId = jobTemplateId_example; // String
    let itemId = itemId_example; // String
    let token = token_example; // String
    let body = ; // CreateJobOverrides

    let mut context = RoutesApi::Context::default();
    let result = client.createJobs(jobTemplateId, itemId, token, body, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
jobTemplateId*
String
Required
itemId*
String
Required
Body parameters
Name Description
body

A job object defining the job

Query parameters
Name Description
token
String

Responses


createSavedSearch

Create saved search

Create a saved search or chart by specifying the search parameters in the json body. All search properties except for optional properties must be passed in the body to save the search or chart. The **adminBasic** or **adminAdvanced** privilege is required. **Create Saved Search Parameters:** | Parameter | Description | Data Type | | ----------- | ----------- | --------- | | searchId | Optional. The unique ID of the search or chart to be created. | String | | name | Required. The display name for the saved search or chart. | String | | folder | Optional. The folder the saved search or chart will be categorized under. | String | | definition | Required if the **searchType** is **Standard**. The search definition to be saved. For details on search definition syntax, see **Search for jobs in the system**. | String | | searchType | Optional. The type for the saved search or chart. The accepted values are **Standard**, **Chart** and **All**. If not defined, the default search type is **Standard**. | String | | colorRamp | Required if the **searchType** is **Chart**. The color ramp for the saved chart. | String | | sortIndex | Optional. The sorting order for the saved search or chart. | Integer |


/workflow/{itemId}/searches

Usage and SDK Samples

curl -X POST\
 -H "Accept: application/json"\
 -H "Content-Type: application/json"\
 "http://localhost/workflow/{itemId}/searches?token="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.RoutesApi;

import java.io.File;
import java.util.*;

public class RoutesApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        RoutesApi apiInstance = new RoutesApi();
        String itemId = itemId_example; // String | 
        String token = token_example; // String | 
        EsriWorkflowModelsRestSavedSearch body = ; // EsriWorkflowModelsRestSavedSearch | 
        
        try {
            CreateSavedSearchResponse result = apiInstance.createSavedSearch(itemId, token, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RoutesApi#createSavedSearch");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.RoutesApi;

public class RoutesApiExample {
    public static void main(String[] args) {
        RoutesApi apiInstance = new RoutesApi();
        String itemId = itemId_example; // String | 
        String token = token_example; // String | 
        EsriWorkflowModelsRestSavedSearch body = ; // EsriWorkflowModelsRestSavedSearch | 
        
        try {
            CreateSavedSearchResponse result = apiInstance.createSavedSearch(itemId, token, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RoutesApi#createSavedSearch");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
RoutesApi *apiInstance = [[RoutesApi alloc] init];
String *itemId = itemId_example; //  (default to null)
String *token = token_example; //  (optional) (default to null)
EsriWorkflowModelsRestSavedSearch *body = ; //  (optional)

// Create saved search
[apiInstance createSavedSearchWith:itemId
    token:token
    body:body
              completionHandler: ^(CreateSavedSearchResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var WorkflowManagerApi = require('workflow_manager_api');

// Create an instance of the API class
var api = new WorkflowManagerApi.RoutesApi()
var itemId = itemId_example; // {String} 
var opts = {
  'token': token_example, // {String} 
  'body':  // {EsriWorkflowModelsRestSavedSearch} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createSavedSearch(itemId, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class createSavedSearchExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new RoutesApi();
            var itemId = itemId_example;  // String |  (default to null)
            var token = token_example;  // String |  (optional)  (default to null)
            var body = new EsriWorkflowModelsRestSavedSearch(); // EsriWorkflowModelsRestSavedSearch |  (optional) 

            try {
                // Create saved search
                CreateSavedSearchResponse result = apiInstance.createSavedSearch(itemId, token, body);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling RoutesApi.createSavedSearch: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\RoutesApi();
$itemId = itemId_example; // String | 
$token = token_example; // String | 
$body = ; // EsriWorkflowModelsRestSavedSearch | 

try {
    $result = $api_instance->createSavedSearch($itemId, $token, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RoutesApi->createSavedSearch: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::RoutesApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::RoutesApi->new();
my $itemId = itemId_example; # String | 
my $token = token_example; # String | 
my $body = WWW::OPenAPIClient::Object::EsriWorkflowModelsRestSavedSearch->new(); # EsriWorkflowModelsRestSavedSearch | 

eval { 
    my $result = $api_instance->createSavedSearch(itemId => $itemId, token => $token, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling RoutesApi->createSavedSearch: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.RoutesApi()
itemId = itemId_example # String |  (default to null)
token = token_example # String |  (optional) (default to null)
body =  # EsriWorkflowModelsRestSavedSearch |  (optional)

try: 
    # Create saved search
    api_response = api_instance.create_saved_search(itemId, token=token, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RoutesApi->createSavedSearch: %s\n" % e)
extern crate RoutesApi;

pub fn main() {
    let itemId = itemId_example; // String
    let token = token_example; // String
    let body = ; // EsriWorkflowModelsRestSavedSearch

    let mut context = RoutesApi::Context::default();
    let result = client.createSavedSearch(itemId, token, body, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
itemId*
String
Required
Body parameters
Name Description
body

An object defining the seach to be saved

Query parameters
Name Description
token
String

Responses


createTemplate

Create a new template

Create a new template. The **adminBasic** or **adminAdvanced** privilege is required. ***Request:*** | Parameter | Description | Data Type | | --------------- | ----------- | --------- | | templateType | Required. The type of template you will create. Create an email template by entering 'email', a Web Request Template by entering 'webRequest', or a Step Template by entering 'step'. Or, enter your own value to define a custom template. | String | ***Body:*** | Parameter | Description | Data Type | | --------------- | ----------- | --------- | | templateId | Optional. The ID of the new template to be defined. | String | | templateName | Required. The name of the new template. Case sensitive. | String | | templateDetails | Required. Information to be stored in the template. | String |


/workflow/{itemId}/templates/{templateType}

Usage and SDK Samples

curl -X POST\
 -H "Accept: application/json"\
 -H "Content-Type: application/json"\
 "http://localhost/workflow/{itemId}/templates/{templateType}?token="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.RoutesApi;

import java.io.File;
import java.util.*;

public class RoutesApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        RoutesApi apiInstance = new RoutesApi();
        String templateType = templateType_example; // String | 
        String itemId = itemId_example; // String | 
        String token = token_example; // String | 
        EsriWorkflowModelsRestTemplate body = ; // EsriWorkflowModelsRestTemplate | 
        
        try {
            inline_response_200_10 result = apiInstance.createTemplate(templateType, itemId, token, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RoutesApi#createTemplate");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.RoutesApi;

public class RoutesApiExample {
    public static void main(String[] args) {
        RoutesApi apiInstance = new RoutesApi();
        String templateType = templateType_example; // String | 
        String itemId = itemId_example; // String | 
        String token = token_example; // String | 
        EsriWorkflowModelsRestTemplate body = ; // EsriWorkflowModelsRestTemplate | 
        
        try {
            inline_response_200_10 result = apiInstance.createTemplate(templateType, itemId, token, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RoutesApi#createTemplate");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
RoutesApi *apiInstance = [[RoutesApi alloc] init];
String *templateType = templateType_example; //  (default to null)
String *itemId = itemId_example; //  (default to null)
String *token = token_example; //  (optional) (default to null)
EsriWorkflowModelsRestTemplate *body = ; //  (optional)

// Create a new template
[apiInstance createTemplateWith:templateType
    itemId:itemId
    token:token
    body:body
              completionHandler: ^(inline_response_200_10 output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var WorkflowManagerApi = require('workflow_manager_api');

// Create an instance of the API class
var api = new WorkflowManagerApi.RoutesApi()
var templateType = templateType_example; // {String} 
var itemId = itemId_example; // {String} 
var opts = {
  'token': token_example, // {String} 
  'body':  // {EsriWorkflowModelsRestTemplate} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createTemplate(templateType, itemId, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class createTemplateExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new RoutesApi();
            var templateType = templateType_example;  // String |  (default to null)
            var itemId = itemId_example;  // String |  (default to null)
            var token = token_example;  // String |  (optional)  (default to null)
            var body = new EsriWorkflowModelsRestTemplate(); // EsriWorkflowModelsRestTemplate |  (optional) 

            try {
                // Create a new template
                inline_response_200_10 result = apiInstance.createTemplate(templateType, itemId, token, body);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling RoutesApi.createTemplate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\RoutesApi();
$templateType = templateType_example; // String | 
$itemId = itemId_example; // String | 
$token = token_example; // String | 
$body = ; // EsriWorkflowModelsRestTemplate | 

try {
    $result = $api_instance->createTemplate($templateType, $itemId, $token, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RoutesApi->createTemplate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::RoutesApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::RoutesApi->new();
my $templateType = templateType_example; # String | 
my $itemId = itemId_example; # String | 
my $token = token_example; # String | 
my $body = WWW::OPenAPIClient::Object::EsriWorkflowModelsRestTemplate->new(); # EsriWorkflowModelsRestTemplate | 

eval { 
    my $result = $api_instance->createTemplate(templateType => $templateType, itemId => $itemId, token => $token, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling RoutesApi->createTemplate: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.RoutesApi()
templateType = templateType_example # String |  (default to null)
itemId = itemId_example # String |  (default to null)
token = token_example # String |  (optional) (default to null)
body =  # EsriWorkflowModelsRestTemplate |  (optional)

try: 
    # Create a new template
    api_response = api_instance.create_template(templateType, itemId, token=token, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RoutesApi->createTemplate: %s\n" % e)
extern crate RoutesApi;

pub fn main() {
    let templateType = templateType_example; // String
    let itemId = itemId_example; // String
    let token = token_example; // String
    let body = ; // EsriWorkflowModelsRestTemplate

    let mut context = RoutesApi::Context::default();
    let result = client.createTemplate(templateType, itemId, token, body, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
templateType*
String
Required
itemId*
String
Required
Body parameters
Name Description
body

The template to be created

Query parameters
Name Description
token
String

Responses


createWorkflowItem

Creates a Workflow Manager schema

Creates a Workflow Manager schema that stores all the configuration information and location data in the data store on Portal. This can be run by any user assigned to the administrator role in Portal. For users that do not belong to the administrator role, the following privileges are required to run Create Workflow Item: **General Privileges:** - Members : View - Groups : Create, update, and delete; View groups shared with organization - Content : Create, update, and delete; Publish hosted feature layers; View content shared with organization - Sharing : Share with groups; Make groups visible to portal **Create Workflow Item process will:** - Create a Workflow Manager schema in the data store on portal. This schema consists of all the Workflow Manager system tables and will store all the data related to Workflow Manager. - Create database views in the Workflow Manager schema. - Load basic roles in the roles table in the schema. - Create a WorkflowLocations feature service view that consists of location data. These views are read only and are shared with the organization. - Create a Workflow Manager Admin group and adds the user as a member.


/workflow/admin/createWorkflowItem

Usage and SDK Samples

curl -X POST\
 -H "Accept: application/json"\
 "http://localhost/workflow/admin/createWorkflowItem?name=&token="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.RoutesApi;

import java.io.File;
import java.util.*;

public class RoutesApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        RoutesApi apiInstance = new RoutesApi();
        String name = name_example; // String | 
        String token = token_example; // String | 
        
        try {
            CreateItemResponse result = apiInstance.createWorkflowItem(name, token);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RoutesApi#createWorkflowItem");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.RoutesApi;

public class RoutesApiExample {
    public static void main(String[] args) {
        RoutesApi apiInstance = new RoutesApi();
        String name = name_example; // String | 
        String token = token_example; // String | 
        
        try {
            CreateItemResponse result = apiInstance.createWorkflowItem(name, token);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RoutesApi#createWorkflowItem");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
RoutesApi *apiInstance = [[RoutesApi alloc] init];
String *name = name_example; //  (default to null)
String *token = token_example; //  (optional) (default to null)

// Creates a Workflow Manager schema
[apiInstance createWorkflowItemWith:name
    token:token
              completionHandler: ^(CreateItemResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var WorkflowManagerApi = require('workflow_manager_api');

// Create an instance of the API class
var api = new WorkflowManagerApi.RoutesApi()
var name = name_example; // {String} 
var opts = {
  'token': token_example // {String} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createWorkflowItem(name, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class createWorkflowItemExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new RoutesApi();
            var name = name_example;  // String |  (default to null)
            var token = token_example;  // String |  (optional)  (default to null)

            try {
                // Creates a Workflow Manager schema
                CreateItemResponse result = apiInstance.createWorkflowItem(name, token);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling RoutesApi.createWorkflowItem: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\RoutesApi();
$name = name_example; // String | 
$token = token_example; // String | 

try {
    $result = $api_instance->createWorkflowItem($name, $token);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RoutesApi->createWorkflowItem: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::RoutesApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::RoutesApi->new();
my $name = name_example; # String | 
my $token = token_example; # String | 

eval { 
    my $result = $api_instance->createWorkflowItem(name => $name, token => $token);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling RoutesApi->createWorkflowItem: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.RoutesApi()
name = name_example # String |  (default to null)
token = token_example # String |  (optional) (default to null)

try: 
    # Creates a Workflow Manager schema
    api_response = api_instance.create_workflow_item(name, token=token)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RoutesApi->createWorkflowItem: %s\n" % e)
extern crate RoutesApi;

pub fn main() {
    let name = name_example; // String
    let token = token_example; // String

    let mut context = RoutesApi::Context::default();
    let result = client.createWorkflowItem(name, token, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
name*
String
Required
token
String

Responses


deleteDiagram

Delete all versions of a diagram.

Delete all the versions of a diagram. The diagram version is not deleted if it is being used by existing jobs. The **adminBasic** or **adminAdvanced** privilege is required.


/workflow/{itemId}/diagrams/{diagramId}

Usage and SDK Samples

curl -X DELETE\
 -H "Accept: application/json"\
 "http://localhost/workflow/{itemId}/diagrams/{diagramId}?token="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.RoutesApi;

import java.io.File;
import java.util.*;

public class RoutesApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        RoutesApi apiInstance = new RoutesApi();
        String diagramId = diagramId_example; // String | 
        String itemId = itemId_example; // String | 
        String token = token_example; // String | 
        
        try {
            Success result = apiInstance.deleteDiagram(diagramId, itemId, token);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RoutesApi#deleteDiagram");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.RoutesApi;

public class RoutesApiExample {
    public static void main(String[] args) {
        RoutesApi apiInstance = new RoutesApi();
        String diagramId = diagramId_example; // String | 
        String itemId = itemId_example; // String | 
        String token = token_example; // String | 
        
        try {
            Success result = apiInstance.deleteDiagram(diagramId, itemId, token);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RoutesApi#deleteDiagram");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
RoutesApi *apiInstance = [[RoutesApi alloc] init];
String *diagramId = diagramId_example; //  (default to null)
String *itemId = itemId_example; //  (default to null)
String *token = token_example; //  (optional) (default to null)

// Delete all versions of a diagram.
[apiInstance deleteDiagramWith:diagramId
    itemId:itemId
    token:token
              completionHandler: ^(Success output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var WorkflowManagerApi = require('workflow_manager_api');

// Create an instance of the API class
var api = new WorkflowManagerApi.RoutesApi()
var diagramId = diagramId_example; // {String} 
var itemId = itemId_example; // {String} 
var opts = {
  'token': token_example // {String} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteDiagram(diagramId, itemId, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class deleteDiagramExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new RoutesApi();
            var diagramId = diagramId_example;  // String |  (default to null)
            var itemId = itemId_example;  // String |  (default to null)
            var token = token_example;  // String |  (optional)  (default to null)

            try {
                // Delete all versions of a diagram.
                Success result = apiInstance.deleteDiagram(diagramId, itemId, token);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling RoutesApi.deleteDiagram: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\RoutesApi();
$diagramId = diagramId_example; // String | 
$itemId = itemId_example; // String | 
$token = token_example; // String | 

try {
    $result = $api_instance->deleteDiagram($diagramId, $itemId, $token);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RoutesApi->deleteDiagram: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::RoutesApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::RoutesApi->new();
my $diagramId = diagramId_example; # String | 
my $itemId = itemId_example; # String | 
my $token = token_example; # String | 

eval { 
    my $result = $api_instance->deleteDiagram(diagramId => $diagramId, itemId => $itemId, token => $token);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling RoutesApi->deleteDiagram: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.RoutesApi()
diagramId = diagramId_example # String |  (default to null)
itemId = itemId_example # String |  (default to null)
token = token_example # String |  (optional) (default to null)

try: 
    # Delete all versions of a diagram.
    api_response = api_instance.delete_diagram(diagramId, itemId, token=token)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RoutesApi->deleteDiagram: %s\n" % e)
extern crate RoutesApi;

pub fn main() {
    let diagramId = diagramId_example; // String
    let itemId = itemId_example; // String
    let token = token_example; // String

    let mut context = RoutesApi::Context::default();
    let result = client.deleteDiagram(diagramId, itemId, token, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
diagramId*
String
Required
itemId*
String
Required
Query parameters
Name Description
token
String

Responses


deleteDiagramByVersion

Delete a diagram version

Delete a diagram version. The diagram version is not deleted if it is being used by existing jobs. The **adminBasic** or **adminAdvanced** privilege is required.


/workflow/{itemId}/diagrams/{diagramId}/{diagramVersion}

Usage and SDK Samples

curl -X DELETE\
 -H "Accept: application/json"\
 "http://localhost/workflow/{itemId}/diagrams/{diagramId}/{diagramVersion}?token="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.RoutesApi;

import java.io.File;
import java.util.*;

public class RoutesApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        RoutesApi apiInstance = new RoutesApi();
        String diagramId = diagramId_example; // String | 
        Integer diagramVersion = 56; // Integer | 
        String itemId = itemId_example; // String | 
        String token = token_example; // String | 
        
        try {
            Success result = apiInstance.deleteDiagramByVersion(diagramId, diagramVersion, itemId, token);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RoutesApi#deleteDiagramByVersion");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.RoutesApi;

public class RoutesApiExample {
    public static void main(String[] args) {
        RoutesApi apiInstance = new RoutesApi();
        String diagramId = diagramId_example; // String | 
        Integer diagramVersion = 56; // Integer | 
        String itemId = itemId_example; // String | 
        String token = token_example; // String | 
        
        try {
            Success result = apiInstance.deleteDiagramByVersion(diagramId, diagramVersion, itemId, token);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RoutesApi#deleteDiagramByVersion");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
RoutesApi *apiInstance = [[RoutesApi alloc] init];
String *diagramId = diagramId_example; //  (default to null)
Integer *diagramVersion = 56; //  (default to null)
String *itemId = itemId_example; //  (default to null)
String *token = token_example; //  (optional) (default to null)

// Delete a diagram version
[apiInstance deleteDiagramByVersionWith:diagramId
    diagramVersion:diagramVersion
    itemId:itemId
    token:token
              completionHandler: ^(Success output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var WorkflowManagerApi = require('workflow_manager_api');

// Create an instance of the API class
var api = new WorkflowManagerApi.RoutesApi()
var diagramId = diagramId_example; // {String} 
var diagramVersion = 56; // {Integer} 
var itemId = itemId_example; // {String} 
var opts = {
  'token': token_example // {String} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteDiagramByVersion(diagramId, diagramVersion, itemId, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class deleteDiagramByVersionExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new RoutesApi();
            var diagramId = diagramId_example;  // String |  (default to null)
            var diagramVersion = 56;  // Integer |  (default to null)
            var itemId = itemId_example;  // String |  (default to null)
            var token = token_example;  // String |  (optional)  (default to null)

            try {
                // Delete a diagram version
                Success result = apiInstance.deleteDiagramByVersion(diagramId, diagramVersion, itemId, token);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling RoutesApi.deleteDiagramByVersion: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\RoutesApi();
$diagramId = diagramId_example; // String | 
$diagramVersion = 56; // Integer | 
$itemId = itemId_example; // String | 
$token = token_example; // String | 

try {
    $result = $api_instance->deleteDiagramByVersion($diagramId, $diagramVersion, $itemId, $token);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RoutesApi->deleteDiagramByVersion: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::RoutesApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::RoutesApi->new();
my $diagramId = diagramId_example; # String | 
my $diagramVersion = 56; # Integer | 
my $itemId = itemId_example; # String | 
my $token = token_example; # String | 

eval { 
    my $result = $api_instance->deleteDiagramByVersion(diagramId => $diagramId, diagramVersion => $diagramVersion, itemId => $itemId, token => $token);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling RoutesApi->deleteDiagramByVersion: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.RoutesApi()
diagramId = diagramId_example # String |  (default to null)
diagramVersion = 56 # Integer |  (default to null)
itemId = itemId_example # String |  (default to null)
token = token_example # String |  (optional) (default to null)

try: 
    # Delete a diagram version
    api_response = api_instance.delete_diagram_by_version(diagramId, diagramVersion, itemId, token=token)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RoutesApi->deleteDiagramByVersion: %s\n" % e)
extern crate RoutesApi;

pub fn main() {
    let diagramId = diagramId_example; // String
    let diagramVersion = 56; // Integer
    let itemId = itemId_example; // String
    let token = token_example; // String

    let mut context = RoutesApi::Context::default();
    let result = client.deleteDiagramByVersion(diagramId, diagramVersion, itemId, token, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
diagramId*
String
Required
diagramVersion*
Integer
Required
itemId*
String
Required
Query parameters
Name Description
token
String

Responses


deleteJobTemplate

Delete a job template by jobTemplateId

Delete a job template by jobTemplateId. The deleted job template can be active, draft or retired. Job templates used by jobs in the system cannot be deleted. The **adminBasic** or **adminAdvanced** privilege is required.


/workflow/{itemId}/jobTemplates/{jobTemplateId}

Usage and SDK Samples

curl -X DELETE\
 -H "Accept: application/json"\
 "http://localhost/workflow/{itemId}/jobTemplates/{jobTemplateId}?token="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.RoutesApi;

import java.io.File;
import java.util.*;

public class RoutesApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        RoutesApi apiInstance = new RoutesApi();
        String jobTemplateId = jobTemplateId_example; // String | 
        String itemId = itemId_example; // String | 
        String token = token_example; // String | 
        
        try {
            Success result = apiInstance.deleteJobTemplate(jobTemplateId, itemId, token);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RoutesApi#deleteJobTemplate");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.RoutesApi;

public class RoutesApiExample {
    public static void main(String[] args) {
        RoutesApi apiInstance = new RoutesApi();
        String jobTemplateId = jobTemplateId_example; // String | 
        String itemId = itemId_example; // String | 
        String token = token_example; // String | 
        
        try {
            Success result = apiInstance.deleteJobTemplate(jobTemplateId, itemId, token);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RoutesApi#deleteJobTemplate");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
RoutesApi *apiInstance = [[RoutesApi alloc] init];
String *jobTemplateId = jobTemplateId_example; //  (default to null)
String *itemId = itemId_example; //  (default to null)
String *token = token_example; //  (optional) (default to null)

// Delete a job template by jobTemplateId
[apiInstance deleteJobTemplateWith:jobTemplateId
    itemId:itemId
    token:token
              completionHandler: ^(Success output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var WorkflowManagerApi = require('workflow_manager_api');

// Create an instance of the API class
var api = new WorkflowManagerApi.RoutesApi()
var jobTemplateId = jobTemplateId_example; // {String} 
var itemId = itemId_example; // {String} 
var opts = {
  'token': token_example // {String} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteJobTemplate(jobTemplateId, itemId, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class deleteJobTemplateExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new RoutesApi();
            var jobTemplateId = jobTemplateId_example;  // String |  (default to null)
            var itemId = itemId_example;  // String |  (default to null)
            var token = token_example;  // String |  (optional)  (default to null)

            try {
                // Delete a job template by jobTemplateId
                Success result = apiInstance.deleteJobTemplate(jobTemplateId, itemId, token);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling RoutesApi.deleteJobTemplate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\RoutesApi();
$jobTemplateId = jobTemplateId_example; // String | 
$itemId = itemId_example; // String | 
$token = token_example; // String | 

try {
    $result = $api_instance->deleteJobTemplate($jobTemplateId, $itemId, $token);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RoutesApi->deleteJobTemplate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::RoutesApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::RoutesApi->new();
my $jobTemplateId = jobTemplateId_example; # String | 
my $itemId = itemId_example; # String | 
my $token = token_example; # String | 

eval { 
    my $result = $api_instance->deleteJobTemplate(jobTemplateId => $jobTemplateId, itemId => $itemId, token => $token);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling RoutesApi->deleteJobTemplate: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.RoutesApi()
jobTemplateId = jobTemplateId_example # String |  (default to null)
itemId = itemId_example # String |  (default to null)
token = token_example # String |  (optional) (default to null)

try: 
    # Delete a job template by jobTemplateId
    api_response = api_instance.delete_job_template(jobTemplateId, itemId, token=token)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RoutesApi->deleteJobTemplate: %s\n" % e)
extern crate RoutesApi;

pub fn main() {
    let jobTemplateId = jobTemplateId_example; // String
    let itemId = itemId_example; // String
    let token = token_example; // String

    let mut context = RoutesApi::Context::default();
    let result = client.deleteJobTemplate(jobTemplateId, itemId, token, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
jobTemplateId*
String
Required
itemId*
String
Required
Query parameters
Name Description
token
String

Responses


deleteLookup

Delete a lookup table

Delete a lookup table. System lookup tables cannot be deleted. The **adminBasic** or **adminAdvanced** privilege is required.


/workflow/{itemId}/lookups/{lookupType}

Usage and SDK Samples

curl -X DELETE\
 -H "Accept: application/json"\
 "http://localhost/workflow/{itemId}/lookups/{lookupType}?token="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.RoutesApi;

import java.io.File;
import java.util.*;

public class RoutesApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        RoutesApi apiInstance = new RoutesApi();
        String lookupType = lookupType_example; // String | 
        String itemId = itemId_example; // String | 
        String token = token_example; // String | 
        
        try {
            Success result = apiInstance.deleteLookup(lookupType, itemId, token);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RoutesApi#deleteLookup");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.RoutesApi;

public class RoutesApiExample {
    public static void main(String[] args) {
        RoutesApi apiInstance = new RoutesApi();
        String lookupType = lookupType_example; // String | 
        String itemId = itemId_example; // String | 
        String token = token_example; // String | 
        
        try {
            Success result = apiInstance.deleteLookup(lookupType, itemId, token);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RoutesApi#deleteLookup");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
RoutesApi *apiInstance = [[RoutesApi alloc] init];
String *lookupType = lookupType_example; //  (default to null)
String *itemId = itemId_example; //  (default to null)
String *token = token_example; //  (optional) (default to null)

// Delete a lookup table
[apiInstance deleteLookupWith:lookupType
    itemId:itemId
    token:token
              completionHandler: ^(Success output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var WorkflowManagerApi = require('workflow_manager_api');

// Create an instance of the API class
var api = new WorkflowManagerApi.RoutesApi()
var lookupType = lookupType_example; // {String} 
var itemId = itemId_example; // {String} 
var opts = {
  'token': token_example // {String} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteLookup(lookupType, itemId, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class deleteLookupExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new RoutesApi();
            var lookupType = lookupType_example;  // String |  (default to null)
            var itemId = itemId_example;  // String |  (default to null)
            var token = token_example;  // String |  (optional)  (default to null)

            try {
                // Delete a lookup table
                Success result = apiInstance.deleteLookup(lookupType, itemId, token);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling RoutesApi.deleteLookup: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\RoutesApi();
$lookupType = lookupType_example; // String | 
$itemId = itemId_example; // String | 
$token = token_example; // String | 

try {
    $result = $api_instance->deleteLookup($lookupType, $itemId, $token);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RoutesApi->deleteLookup: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::RoutesApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::RoutesApi->new();
my $lookupType = lookupType_example; # String | 
my $itemId = itemId_example; # String | 
my $token = token_example; # String | 

eval { 
    my $result = $api_instance->deleteLookup(lookupType => $lookupType, itemId => $itemId, token => $token);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling RoutesApi->deleteLookup: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.RoutesApi()
lookupType = lookupType_example # String |  (default to null)
itemId = itemId_example # String |  (default to null)
token = token_example # String |  (optional) (default to null)

try: 
    # Delete a lookup table
    api_response = api_instance.delete_lookup(lookupType, itemId, token=token)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RoutesApi->deleteLookup: %s\n" % e)
extern crate RoutesApi;

pub fn main() {
    let lookupType = lookupType_example; // String
    let itemId = itemId_example; // String
    let token = token_example; // String

    let mut context = RoutesApi::Context::default();
    let result = client.deleteLookup(lookupType, itemId, token, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
lookupType*
String
Required
itemId*
String
Required
Query parameters
Name Description
token
String

Responses