Signiant Support

13.3 Signiant Manager REST API Developers Guide Print


REST API Introduction

With this version of the REST API, client programs can manage users, user groups, agent groups, jobs, resource controls, job groups and channels. It is important to note that a Media Exchange license is required to manage channels.

Signiant Service REST Schema

 

 

To access the Signiant Manager Rest API, use the following URL:

https://< Signiant_manager_name>/signiant/spring/admin/v1.0/< service_uri>

Signiant Service REST Schema URI's

The following table details the URI's for the Signiant Service REST Schema.

URI Description HTTP Method

../users

Create a user

POST

../users

Edit a user

PUT

../users/ username|userID|emailAddress

Get a user by name, userID or emailAddress

GET

../users/ username|userID

Delete a user by name or userID

DELETE

../activateusers

Activate a user

GET

../deactivateusers

Deactivate a user

GET

../listusers

Get a list of users

GET

../usergroups

Create a user group

POST

../usergroups

Edit a user group

PUT

../usergroups/ groupname|groupID

Get a user group by name or groupID

GET

../usergroups/ groupname|groupID

Delete a user group by name or groupID

DELETE

../listusergroups

Get a list of user groups

GET

../channels

Create a channel

POST

../channels

Edit a channel

PUT

../channels/ channelname|channelID

Get a channel by name or channelID. If the channel name is not unique, all occurrences are returned.

GET

../channels/ channelname|channelID

Delete a channel by name or channelID. If the channel name is not unique, an error occurs. If this occurs, use the channelID in the GET response JSON body.

DELETE

../listchannels

Get a list of channels

GET

../listagents

Get a list of agents

GET

../agentgroups

Create an agent group

POST

../agentgroups

Edit an agent group

PUT

../agengroups/ agentgroupname|agentgroupID

Get an agent group by name or agent group ID

GET

../agengroups/ agentgroupname|agentgroupID

Delete an agent group by name or agent group ID

DELETE

../listagentgroups

Get a list of agent groups

GET

../jobgroups

Create a job group

POST

../jobgroups

Edit a job group

PUT

../jobgroups/ jobgroupname|jobgroupID

Get a job group by name or job group ID

GET

../jobgroups/ jobgroupname|jobgroupID

Delete a job group by name or job group ID

DELETE

../listjobgroups

Get a list of job groups

GET

../resourcecontrols

Create a resource control

POST

../resourcecontorls

Edit a resource control

PUT

../resourceontrols/ resourcecontrolname|resourcecontrolID

Get a resource control by name or resource control ID

GET

../resourcecontrols/ resourcecontrolname|resourcecontrolID

Delete a resource control by name or resource control ID

DELETE

../listresourcecontrols

Get a list of resource controls

GET

../activateresourcecontrols

Activate a resource control

POST

../deactivateresourcecontrols

Deactivate a resource control

POST

../resourcecontrols/move/ jobname|jobID|jobgroupname/ value

Move jobs in the job resource control queue. To move the job to the left, the value can be: ..., -3, -2, -1. To move the job to the right, the value can be: 1, 2, 3, ....

GET

../resourceontrols/move/ consumerID/ value

Move jobs in the Agent and Media Exchange resource control queue. To move the job to the left, the value can be: ..., -3, -2, -1. To move the job to the right, the value can be: 1, 2, 3, ....

GET

../listresourcecontrolqueue/ resourcecontrolname|resourcecontrol ID

Get a list of all consumers by name or ID for a specified resource control.

GET

../jobs

Create a job

POST

../jobs

Edit a job

PUT

../jobs/joblog/ jobName View the complete job log for a job on an Agent GET
../jobs/joblog/ jobName/jobGroupName View the job log for the most recently run job GET
../jobs/joblog/ jobName/jobGroupName/runNumber View the job log for a specific job run GET

../jobs/jobname/ jobgroupname|jobgroupID

Get a job by name

GET

../jobs/jobname/ jobgroupname|jobgroupID

Delete a job by name

DELETE

../listjobs/ jobgroupname|jobgroupID

Get a list of jobs from a specified job group

GET

../jobs/variables/jobname/jobgroup

Update or add job variables for a specified job

POST

../jobs/command/jobname /jobgroupname|jobgroupID/command

Commands for the job include: cancel, delete, pause and continue

GET

../jobs/stats/jobname/ jobgroupname|jobgroupID

Stats for the job

POST

../job/stats/jobname/ jobgroupname|jobgroupID/runnumber

Stats for the job and run number. The number can be: 0, 1, 2, ....

POST

../jobs/jobview/ jobviewname|jobviewID

Get a job view by job view name or job view ID

GET

../certificate/revoke

Revoke an Agent certificate

POST

Note: ID fields cannot be changed once the user, user group or channel is created. Ensure that firstName and lastName do not include <, > or =. The password must conform to the Password Strength Policy specified in Users > List > Settings (Minimum Characters 8, Minimum Upper Case Letters 1, Minimum Lower Case Letters 1, and Minimum Numbers and Symbols 1). This default password policy can be edited in Users > ListSettings.

Agent Group

The following is an example the JSON used to create an agent group.

          
                            [
                            {
                            "agentGroup":
                            {
                    
                            "groupName": "exampleAgentGroup",
                            "fields":
                            {
                            "description": "Agent Group",
                            "organization": "xyzcompany",
                            "loadBalance": "Yes",
                            "members":
                            [
                            {
                                 
                            "name": "test_group"
                             
                            }
                            ],
                            "accessAcls":
                            [
                            {
                            "userName": "mxuser1",
                            "remove": true,
                            "execute": false,
                            "edit": true,
                            "read": true
                            },
                         
                            {
                            "userName": "Media Exchange Users",
                            "remove": false,
                            "execute": true,
                            "edit": false,
                            "read": false
                            },
                            {
                            "userName": "Media Exchange Guest Users",
                            "remove": false,
                            "execute": true,
                            "edit": false,
                            "read": false
                            },
                            {
                            "userName": "admin",
                            "remove": true,
                            "execute": true,
                            "edit": true,
                            "read": true
                            }
                            ],
                     
                            "mxProperties":
                            {
                            "downloadBandwidthProfile": "System Default",
                            "uploadBandwidthProfile": "System Default",
                            "mxEnabled": true,
                            "mxNetworkMaskProfileId": true,
                            "licenses Remaining": 945,
                            "mxConcurrency": 67,
                            "packageRepositoryPath": "c:/tmp",
                            "useMxRelaysFromMemberAgents": false,
                            "relays":
                            [
                            {
                            "address": "myagent.example.com",
                            "udpPort": 49221,
                            "tcpPort": 49221,
                            "httpPort": 8080
                            }
                         
                            ]
    
                            }
                            }
                            }
                            }
                            ]	  
                        

Users

The following is an example the JSON used to create a user.

JSON Body Request

[
                            {
                            "user": {
                            "userName":"exampleuser",
                            "fields":{
                            "firstName":"Example",
                            "lastName":"User",
                            "email":"user@example.com",
                            "title":"title",
                            "phone":"phone",
                            "cell":"21313",
                            "fax":"321234",
                            "password":"password",
                            "organization":"signiant",
                            "failedLoginCount":"0",
                            "maxAllowedLoginAttempts":"10",
                            "failedLoginTimePeriod":"24",
                            "ignoreAdministrationForSoapAuth":false,
                            "groups":"Media Exchange Users,Media Exchange Guest Users",
                            "roles":{
                            "isTemporary":false,
                            "isAdminGuiLogin":false,
                            "validFrom":null,
                            "validTo":null,
                            "isSysAdmin":false,
                            "isOrgAdmin":false,
                            "isWorkflowAdmin":false,
                            "isWorkflowSupervisor":false,
                            "isCompEditor":true,
                            "isMonitorUser":false
                            },
                            "accessAcls":[{  
                            "userName":"Media Exchange Guest Users",
                            "read":true,
                            "edit":true,
                            "remove":true
                            },{  
                            "userName":"admin",
                            "read":true,
                            "edit":true,
                            "remove":true
                            }],
                            "menus":[{
                            "name":"Groups",
                            "parent":{
                            "name":"Jobs"
                            }
                            },{
                            "name":"List",
                            "parent":{
                            "name":"Users",
                            "parent":{
                            "name":"Administration"
                            }
                            }
                            }],
                            "mediaExchange":{
                            "mxAgent":"myagent.example.com",
                            "homeDir":"c:/tmp",
                            "allowedToBrowseAgent":true,
                            "transferJobGroup":"Default",
                            "defaultUploadProfile":"System Default",
                            "defaultDownloadProfile":"System Default",
                            "allowedToCreateTempUsers":true,
                            "allowedToSendPackages":true,
                            "allowedToReceivePackages":true,
                            "allowedToForwardPackages":false,
                            "notifyInterestedParties":true,
                            "interestedPartiesEmails":"user2@example.com",
                            "notifySenderPackReceive":true,
                            "notifySendCopyEmail":false,
                            "notifySenderReceiveFailure":true,
                            "notifySenderPackDownload":false,
                            "notifyReceiverPackAvaliable":true,
                            "notifyReceiverForSelectedCategoriesOnly":true,
                            "notifySenderReceiverAvailableCategories":null
                            }
                            }
                            }
                            }
                            ]			
                        

Jobs

The following is an example the JSON used to create a job.

JSON Body Request

[
                            {
                            "job":
                            {
                            "jobName": "MediaDistributor",
                            "fields":
                            {
                            "jobGroupName": "MediaDistributor",
                            "jobTemplateLibraryName": "Media_Mover_Workflows",
                            "jobTemplateName": "MediaDistributor",
                
                            "jobArgs":
                            {
                            "MediaDistributor.Source.SourceAgent": "sourceagent.com",
                            "MediaDistributor.Source.SourceData": "c:/source/1.jpg",
                            "MediaDistributor.Source.IncludeFiles": "*",
                            "MediaDistributor.Source.ExcludeFiles": "",
                            "MediaDistributor.Source.ExcludeSubdirectories": "Specified",
                            "MediaDistributor.Source.ExcludeSubDirList": "",
                            "MediaDistributor.Source.FileReadinessCheckType": "Stream Growing Files",
                            "MediaDistributor.Source.FileReadinessCheckDelay": "10",
                            "MediaDistributor.Source.sourceDeletionsAfterSuccessfulTransfer": "None",
                            "MediaDistributor.Source.sourceDirectoriestoExcludefromDeletionScan": "",
                            "MediaDistributor.Source.sourceDatalocationAfterSuccessfulTransfer": "c:/source",
                            "MediaDistributor.Source.skipSourceFileNotFoundOnSend": "no", 
                            "MediaDistributor.Source.skipFilesWith0BytesSize": "yes",
                         
                         
                            "MediaDistributor.Target.TargetAgents": "targetagent.com",
                            "MediaDistributor.Target.TargetDirectory": "c:/target",
                            "MediaDistributor.Target.PathMappingOptions": "Source Host,Job Date/Time",
                            "MediaDistributor.Target.maximumJobDateTimeDirectories": "",
                            "MediaDistributor.Target.RemoveTargetFiles": "yes",
                            "MediaDistributor.Target.removeExpiredDirectoriesonTarget": "no",
                            "MediaDistributor.Target.expirationPeriod": "30",
                        
                            "MediaDistributor.Transport._sp_udp": "yes",
                            "MediaDistributor.Transport.UseWANAccelerator": "No",
                            "MediaDistributor.Transport.wANAcceleratorAggressiveness": "high",
                            "MediaDistributor.Transport.BandwidthFloor": "0",
                            "MediaDistributor.Transport.BandwidthCeiling": "0",
                            "MediaDistributor.Transport.BandwidthThrottleByTimeOfDay": "00:00;00:00;YYYYYYY;0;",
                        
                            "MediaDistributor.Options._sp_encryption": "No encryption - unsigned",
                            "MediaDistributor.Options.deliveryMode": "Log File Name",
                            "MediaDistributor.Options.CompressFiles": "yes",
                            "MediaDistributor.Options.followSymbolicLinks": "yes",
                            "MediaDistributor.Options.IncrementalTransfer": "yes",
                            "MediaDistributor.Options.verifyforsufficientdiskspacebeforeJobtransfersstart": "Yes",
                            "MediaDistributor.Options.verifytargetdirectoryexists": "no",
                        
                    
                        
                            "MediaDistributor.NotificationAndLogging.EmailCondition": "Always",
                            "MediaDistributor.NotificationAndLogging.EmailTo": "",
                            "MediaDistributor.NotificationAndLogging.EmailCc": "",
                            "MediaDistributor.NotificationAndLogging.EmailBcc": "",
                            "MediaDistributor.NotificationAndLogging.emailJobFailureReportTo": "",
                            "MediaDistributor.NotificationAndLogging._sp_log_severity": "Info",
                        
                        
                            "MediaDistributor.sNMPProperties.sNMPTrapReceivers": "",
                            "MediaDistributor.sNMPProperties.sNMPTrapCommunityString": "",
                            "MediaDistributor.sNMPProperties.sNMPTrapTypes": "",
                        
                            "MediaDistributor.Schedule._sp_frequency": "3 H",
                            "MediaDistributor.Schedule._sp_start_at": "2017/12/20 10:11:00",
                            "MediaDistributor.Schedule.timezone": "Europe/Skopje",
                            "MediaDistributor.Schedule._sp_interrupt_on_failure": "Yes",
                            "MediaDistributor.Schedule.priority": "High",
                            "MediaDistributor.Schedule.finishBefore": ""
                      
                            }
                            }
                            }
                            }
                            ]			
                        

Job Groups

The following is an example of the JSON used to create a job group.

JSON Body Request

                            
                            [
                            {
                            "jobGroup":
                            {
                    
                            "groupName": "new_test_group",
                            "fields":
                            {
                            "groupDescription": "Test job group",
                            "limitAccess": "n",
                            "accessAcls":
                            [
                            {
                            "userName": "mxuser1",
                            "edit": true,
                            "read": true,
                            "execute": false,
                            "remove": true
                            },
                            {
                            "userName": "admin",
                            "edit": true,
                            "read": true,
                            "execute": true,
                            "remove": true
                            },
                            {
                            "userName": "Media Exchange Users",
                            "edit": false,
                            "read": true,
                            "execute": false,
                            "remove": false
                            }
                            ]
                            }
                            }
                            }
                            ]						
                        

User Groups

The following is an example of the JSON used to create a user group.

JSON Body Request

[
                            {
                            "userGroup":{
                            "groupName":"examplegroup",
                            "fields":{
                            "groupName":"examplegroup",
                            "organization":"signiant",
                            "compEditor":true,
                            "persistentForDirServiceUsers":true,
                            "members":["exampleuser","testuser","admin"],
                            "accessAcls":[{
                            "userName":"exampleuser",
                            "read":true,
                            "edit":true,
                            "remove":false
                            }],
                            "menus":[{
                            "name":"Groups",
                            "parent":{
                            "name":"Jobs"
                            }
                            },{
                            "name":"List",
                            "parent":{
                            "name":"Users",
                            "parent":{
                            "name":"Administration"
                            }
                            }
                            }],
                            "mediaExchange":{
                            "mxEnabled":true,
                            "canSubscribe":true
                            }
                            }
                            }
                            }
                            ]
        
                        

Channels

The following is an example of the JSON used to create a channel.

JSON Body Request

[
                            {
                            "channel":{
                            "channel":{
                            "name":"myChannelName1",
                            "parent":{
                            "name":"secondLevel",
                            "parent":{
                            "name":"topLevel"
                            }
                            }
                            },
                            "fields":{
                            "name":"myChannelName1",
                            "mxAgent":"myagent.example.com",
                            "notAvailableBefore":"2014-04-09T18:02:52.249Z",
                            "expiresAfter":"2014-08-21T18:02:52.249Z",
                            "packageDuration":"600000",
                            "createPackageDirectory":true,
                            "directoryType":"DELIVERY",
                            "path":"",
                            "accessAcls":[{
                            "userName":"mxuser1",
                            "read":true,
                            "edit":true,
                            "remove":false
                            },{
                            "userName":"mxuser2",
                            "read":true
                            }]
                            }
                            }
                            }
                            ]
                            
                        

Agent Resource Controls

The following is an example of the JSON used to create an agent resource control.

JSON Body Request

[
                            {
                            "resourceControl":
                            {
                            "resourceControlName": "exampleAgentResourceControl",
                            "fields":
                            {
                            "type": "Agent",
                            "scope": "Agent Name",
                            "concurrency": 1,
                            "ceiling": 1048576,
                            "floor": 1048576,
                            "isPrioritization": true,
                            "resourceControlTimeOfDay":
                            [
                            {
                            "startTime": "08:20:00",
                            "endTime": "10:20:00",
                            "days": "YYYYYYY",
                            "dataRate": 1048576
                            },
                            {
                            "startTime": "00:00:00",
                            "endTime": "00:00:00",
                            "days": "YYYYYYY",
                            "dataRate": 1048576
                            }
                            ],
                            "filters":
                            [
                            "AGENT_TRANSFER_SOURCE=true",
                            "MX_CTE_DOWNLOAD=true",
                            "AGENT_REMOTE_COMMAND=true",
                            "AGENT_TRANSFER_TARGET=true",
                            "MX_CTE_UPLOAD=true"
                            ],
                            "sourceToAgent": "Agent Name",
                            "targetFromAgent": "All Agents",
                            "precedence": 1,
                            "accessAcls":
                            [
                            {
                            "userName": "admin",
                            "read": true,
                            "edit": true,
                            "remove": true
                            },
                            {
                            "userName": "test",
                            "remove": true,                           
                            "edit": true,
                            "read": true
                            },				 
                            {
                            "userName": "Media Exchange Users",
                            "remove": false,
                            "edit": false,
                            "read": false
                            },
                            {
                            "userName": "Media Exchange Guest Users",
                            "remove": false,
                            "edit": false,
                            "read": false
                            }
                            ]
                            }
                            }
                            }
                            ]
    
                            
                        

Job Resource Controls

The following is an example of the JSON used to create a job resource control.

JSON Body Request

[[
                            {
                            "resourceControl":
                            {
                            "resourceControlName": "exampleJobResourceControl",
                            "fields":
                            {
                            "type": "Job",
                            "scope": "MediaDistributor",
                            "concurrency": 1,
                            "ceiling": 1048576,
                            "floor": 1048576,
                            "isPrioritization": true,
                            "resourceControlTimeOfDay":
                            [
                            {
                            "startTime": "08:20:00",
                            "endTime": "10:20:00",
                            "days": "YYYYYYY",
                            "dataRate": 1048576
                            },
                            {
                            "startTime": "00:00:00",
                            "endTime": "00:00:00",
                            "days": "YYYYYYY",
                            "dataRate": 1048576
                            }
                            ],
                            "accessAcls":
                            [
                            {
                            "userName": "admin",
                            "read": true,
                            "edit": true,
                            "remove": true
                            },
                            {
                            "userName": "test",
                            "remove": true,                           
                            "edit": true,
                            "read": true
                            },				 
                            {
                            "userName": "Media Exchange Users",
                            "remove": false,
                            "edit": false,
                            "read": false
                            },
                            {
                            "userName": "Media Exchange Guest Users",
                            "remove": false,
                            "edit": false,
                            "read": false
                            }
                            ]
                            }
                            }
                            }
                            ]
    
    
                            
                        

Media Exchange Transfer Job Group Resource Controls

The following is an example of the JSON used to create a Media Exchange transfer job group resource control.

JSON Body Request

[
                            {
                            "resourceControl":
                            {
                            "resourceControlName": "exampleMediaExchangeTransferJobGroupResourceControl",
                            "fields":
                            {
                            "type": "Media Exchange Transfer Job Group",
                            "scope": "MediaExchangeJteTransfers",
                            "concurrency": 1,
                            "ceiling": 1048576,
                            "floor": 1048576,
                            "isPrioritization": true,
                            "resourceControlTimeOfDay":
                            [
                            {
                            "startTime": "08:20:00",
                            "endTime": "10:20:00",
                            "days": "YYYYYYY",
                            "dataRate": 1048576
                            },
                            {
                            "startTime": "00:00:00",
                            "endTime": "00:00:00",
                            "days": "YYYYYYY",
                            "dataRate": 1048576
                            }
                            ],
                            "filters":
                            [                       
                            "MX_CTE_DOWNLOAD=true",                      
                            "MX_CTE_UPLOAD=true"
                            ],
                            "precedence": 1,
                            "accessAcls":
                            [
                            {
                            "userName": "admin",
                            "read": true,
                            "edit": true,
                            "remove": true
                            },
                            {
                            "userName": "test",
                            "remove": true,                           
                            "edit": true,
                            "read": true
                            },				 
                            {
                            "userName": "Media Exchange Users",
                            "remove": false,
                            "edit": false,
                            "read": false
                            },
                            {
                            "userName": "Media Exchange Guest Users",
                            "remove": false,
                            "edit": false,
                            "read": false
                            }
                            ]
                            }
                            }
                            }
                            ]
    
    
                            
                        

Revoke Agent Certificate

The following is an example of the JSON used to revoke an Agent certificate.

JSON Body Request

                            {
                            "agentName": "Agent Hostname",
                        "caPassphrase": "CA Passphrase"
}
                            
                        
                        

REST Response Examples

The following are REST examples of successful calls:

Create Users Response JSON

                            {"creator":"admin", "users":[{"id":2344, "userName":"createdUser1"}, {"id":2345, "userName":"createdUser2"}]}					
                        

Create User Groups Response JSON

                            {"creator":"admin", "groups":[{"id":2344, "groupName":"createdGroup1"}, {"id":2345, "groupName":"createdGroup2"}]}					
                        

Create Channels Response JSON

{"creator":"admin", "channels":[{"id":2344, "name":"createdChannel1"}, {"id":2345, "name":"createdChannel2"}]}					
                        

Edit Users Response JSON

 
                            {"success":"true"}					
                        

Edit User Groups Response JSON

 
                            {"success":"true"}					
                        

Edit Channels Response JSON

 
                            {"success":"true"}					
                        

Delete Users Response JSON

 
                            {"success":"true"}					
                        

Delete User Group Response JSON

 
                            {"success":"true"}					
                        

Delete Channel Response JSON

 
                            {"success":"true"}					
                        

Create Agent Group Response JSON

 {
                            "creator": "admin",
                            "agentGroups": [
                            {
                            "id": 391507,
                            "groupName": "exampleAgentGroup"
                            }
                            ]
                            }
                            
                        

Edit Agent Group Response JSON

{
                            "success": "true"
                            }
    
                        

Get Agent Group Response JSON

 [
                            {
                            "agentGroup": {
                            "id": 391521,
                            "groupName": "exampleAgentGroup",
                            "fields": {
                            "description": "Agent Group",
                            "organization": "Signiant",
                            "loadBalance": "Yes",
                            "members": [
                            {
                            "id": 10588,
                            "type": "HOST",
                            "name": "agent7.xyzcompany.com",
                            "description": "",
                            "organization": "Signiant",
                            "loadBalanceMember": "Yes"
                            }
                            ],
                            "accessAcls": [
                            {
                            "userName": "Media Exchange Users",
                            "read": false,
                            "edit": false,
                            "remove": false,
                            "execute": true
                            },
                            {
                            "userName": "Media Exchange Guest Users",
                            "read": false,
                            "edit": false,
                            "remove": false,
                            "execute": true
                            },
                            {
                            "userName": "admin",
                            "read": true,
                            "edit": true,
                            "remove": true,
                            "execute": true
                            },
                            {
                            "userName": "mxuser1",
                            "read": true,
                            "edit": true,
                            "remove": true,
                            "execute": false
                            }
                            ],
                            "mxProperties": {
                            "downloadBandwidthProfile": "System Default",
                            "uploadBandwidthProfile": "System Default",
                            "packageRepositoryPath": "c:/tmp",
                            "licensesRemaining": 946,
                            "mxConcurrency": 67,
                            "mxEnabled": true,
                            "useMxRelaysFromMemberAgents": false,
                            "mxNetworkMaskProfileId": true,
                            "relays": [
                            {
                            "address": "myagent.example.com",
                            "udpPort": 49221,
                            "tcpPort": 49221,
                            "httpPort": 8080
                            }
                            ]
                            }
                            }
                            }
                            }
                            ]
                                                
                        

List Agent Groups Response JSON

 [
                            {
                            "agentGroup": {
                            "id": 41203,
                            "groupName": "Administration",
                            "fields": {
                            "organization": "XYZCompany",
                            "loadBalanced": "Yes",
                            "description": "",
                            "mxEnabled": false,
                            "transferConcurrency": null
                            }
                            }
                            },
                            {
                            "agentGroup": {
                            "id": 391507,
                            "groupName": "exampleAgentGroup",
                            "fields": {
                            "organization": "XYZCompany",
                            "loadBalanced": "Yes",
                            "description": "Agent Group",
                            "mxEnabled": true,
                            "transferConcurrency": 67
                            }
                            }
                            }
                            ]
                        
                        

Delete Agent Group Response JSON

{
                            "success": "true"
                            }
                                            
                        

List Agents Response JSON

[
                            {
                            "agent": {
                            "id": 14,
                            "agentName": "agent5.xyzcompany.com",
                            "fields": {
                            "type": "Manager",
                            "organization": "System",
                            "platform": "Windows 2000/2003/XP/7/2008",
                            "externalJobMonitor": "Monitoring External Jobs",
                            "mediaExchangeEnabled": true,
                            "concurrency": 10,
                            "description": "Transfer Manager Host",
                            "version": "12.1 (74013)",
                            "imported": false
                            }
                            }
                            },
                            {
                            "agent": {
                            "id": 10588,
                            "agentName": "agent5.xyzcompany.com",
                            "fields": {
                            "type": "Agent",
                            "organization": "Signiant",
                            "platform": "Windows 2003 R2/2008 R2/7/2012 R2/8.1/10 - 64 bit",
                            "externalJobMonitor": "Monitoring External Jobs",
                            "mediaExchangeEnabled": true,
                            "concurrency": 0,
                            "description": "",
                            "version": "12.0 (71544)",
                            "imported": false
                            }
                            }
                            }
                            ] 
                            
                        
                        

Create Job Group Response JSON

{
                            "creator": "admin",
                            "jobGroups": [
                            {
                            "id": 391518,
                            "groupName": "xyz_test_group"
                            }
                            ]
                            } 
                                                
                        

Edit Job Group Response JSON

{
                            "success": "true"
                            } 
                            
                        

List Job Groups Response JSON

[
                            {
                            "jobGroup": {
                            "id": 11,
                            "groupName": "Default",
                            "fields": {
                            "groupDescription": "Default Job Group created at install",
                            "organization": "XYZCompany",
                            "resourceControlled": false,
                            "alarmEnabled": false
                            }
                            }
                            },
                            {
                            "jobGroup": {
                            "id": 66,
                            "groupName": "personal_job_group_00000000010",
                            "fields": {
                            "groupDescription": "Personal job group for jobs created by user: admin"
                            ,
                            "organization": "XYZCompany",
                            "resourceControlled": false,
                            "alarmEnabled": false
                            }
                            }
                            },
                            {
                            "jobGroup": {
                            "id": 237,
                            "groupName": "UpgradeAgentGUI",
                            "fields": {
                            "groupDescription": "Automatically created to contain jobs from publishe
                            d Job Template: Upgrade",
                            "organization": "XYZCompany",
                            "resourceControlled": false,
                            "alarmEnabled": false
                            }
                            }
                            },
                            {
                            "jobGroup": {
                            "id": 1835,
                            "groupName": "Maintenance",
                            "fields": {
                            "groupDescription": "Automatically created to contain jobs from publishe
                            d Job Template: Certificates",
                            "organization": "XYZCompany",
                            "resourceControlled": false,
                            "alarmEnabled": false
                            }
                            }
                            },
                            {
                            "jobGroup": {
                            "id": 1841,
                            "groupName": "ReportViewSchedules",
                            "fields": {
                            "groupDescription": "Scheduled Reporting",
                            "organization": "XYZCompany",
                            "resourceControlled": false,
                            "alarmEnabled": false
                            }
                            }
                            },
                            {
                            "jobGroup": {
                            "id": 3155,
                            "groupName": "MediaExchangeJteTransfers",
                            "fields": {
                            "groupDescription": "Default job group for MX JTE transfers",
                            "organization": "XYZCompany",
                            "resourceControlled": false,
                            "alarmEnabled": false
                            }
                            }
                            },
                            {
                            "jobGroup": {
                            "id": 3156,
                            "groupName": "MediaExchange",
                            "fields": {
                            "groupDescription": "Default job group for MXP workflows",
                            "organization": "XYZCompany",
                            "resourceControlled": false,
                            "alarmEnabled": false
                            }
                            }
                            },
                            {
                            "jobGroup": {
                            "id": 37366,
                            "groupName": "MediaExchangeUploadDownload",
                            "fields": {
                            "groupDescription": "Default Job Group for Content Transfer Engine jobs"
                            ,
                            "organization": "XYZCompany",
                            "resourceControlled": false,
                            "alarmEnabled": false
                            }
                            }
                            },
                            {
                            "jobGroup": {
                            "id": 67731,
                            "groupName": "Media_Integrations_Job_Group",
                            "fields": {
                            "groupDescription": "",
                            "organization": "XYZCompany",
                            "resourceControlled": false,
                            "alarmEnabled": false
                            }
                            }
                            },
                            {
                            "jobGroup": {
                            "id": 124936,
                            "groupName": "AgentsReport",
                            "fields": {
                            "groupDescription": "Automatically created to contain jobs from publishe
                            d Job Template: Report",
                            "organization": "XYZCompany",
                            "resourceControlled": false,
                            "alarmEnabled": false
                            }
                            }
                            },
                            {
                            "jobGroup": {
                            "id": 2778,
                            "groupName": "FIMS_Workflow",
                            "fields": {
                            "groupDescription": "FIMS Workflow",
                            "organization": "XYZCompany",
                            "resourceControlled": false,
                            "alarmEnabled": false
                            }
                            }
                            },
                            {
                            "jobGroup": {
                            "id": 350355,
                            "groupName": "FlightUploads",
                            "fields": {
                            "groupDescription": "Flight Upload Jobs",
                            "organization": "XYZCompany",
                            "resourceControlled": false,
                            "alarmEnabled": false
                            }
                            }
                            },
                            {
                            "jobGroup": {
                            "id": 350356,
                            "groupName": "FlightDownloads",
                            "fields": {
                            "groupDescription": "Flight Download Jobs",
                            "organization": "XYZCompany",
                            "resourceControlled": false,
                            "alarmEnabled": false
                            }
                            }
                            },
                            {
                            "jobGroup": {
                            "id": 13817,
                            "groupName": "SigniantUtilities",
                            "fields": {
                            "groupDescription": "Signiant Utilities",
                            "organization": "XYZCompany",
                            "resourceControlled": false,
                            "alarmEnabled": false
                            }
                            }
                            },
                            {
                            "jobGroup": {
                            "id": 6734,
                            "groupName": "MediaGatewayDropBoxMonitors",
                            "fields": {
                            "groupDescription": "Media Gateway DropBox Monitors",
                            "organization": "XYZCompany",
                            "resourceControlled": false,
                            "alarmEnabled": false
                            }
                            }
                            },
                            {
                            "jobGroup": {
                            "id": 7687,
                            "groupName": "MediaGatewayDeliveryJobs",
                            "fields": {
                            "groupDescription": "Media Gateway Delivery Jobs",
                            "organization": "XYZCompany",
                            "resourceControlled": false,
                            "alarmEnabled": false
                            }
                            }
                            },
                            {
                            "jobGroup": {
                            "id": 4748,
                            "groupName": "MediaDropBox",
                            "fields": {
                            "groupDescription": "Media DropBox Jobs",
                            "organization": "XYZCompany",
                            "resourceControlled": false,
                            "alarmEnabled": false
                            }
                            }
                            },
                            {
                            "jobGroup": {
                            "id": 4744,
                            "groupName": "MediaAggregator",
                            "fields": {
                            "groupDescription": "Media Aggregator Jobs",
                            "organization": "XYZCompany",
                            "resourceControlled": false,
                            "alarmEnabled": false
                            }
                            }
                            },
                            {
                            "jobGroup": {
                            "id": 4746,
                            "groupName": "MediaDistributor",
                            "fields": {
                            "groupDescription": "Media Distributor Jobs",
                            "organization": "XYZCompany",
                            "resourceControlled": false,
                            "alarmEnabled": false
                            }
                            }
                            },
                            {
                            "jobGroup": {
                            "id": 4750,
                            "groupName": "MediaReplicator",
                            "fields": {
                            "groupDescription": "Media Replicator Jobs",
                            "organization": "XYZCompany",
                            "resourceControlled": false,
                            "alarmEnabled": false
                            }
                            }
                            },
                            {
                            "jobGroup": {
                            "id": 391518,
                            "groupName": "teama_test_group",
                            "fields": {
                            "groupDescription": "Teama Test job group changed",
                            "organization": "XYZCompany",
                            "resourceControlled": false,
                            "alarmEnabled": false
                            }
                            }
                            }
                            ] 
                            
                        
                        

Get Job Group Response JSON

[
                            {
                            "jobGroup": {
                            "id": 391518,
                            "groupName": "teama_test_group",
                            "fields": {
                            "groupDescription": "Teama Test job group changed",
                            "limitAccess": "n",
                            "accessAcls": [
                            {
                            "userName": "Media Exchange Users",
                            "read": true,
                            "edit": false,
                            "remove": false,
                            "execute": false
                            },
                            {
                            "userName": "admin",
                            "read": true,
                            "edit": true,
                            "remove": true,
                            "execute": true
                            },
                            {
                            "userName": "mxuser1",
                            "read": true,
                            "edit": true,
                            "remove": true,
                            "execute": false
                            },
                            {
                            "userName": "mxuser2",
                            "read": true,
                            "edit": true,
                            "remove": true,
                            "execute": false
                            }
                            ]
                            }
                            }
                            }
                            ] 
                                                
                        

Delete Job Group Response JSON

 
                            {
                            "success": "true"
                            } 						
                        

Get Users Response JSON

                            [
                            {
                            "user": {
                            "id": 227871,
                            "userName": "testuser1",
                            "fields": {
                            "firstName": "firsttest111",
                            "lastName": "lasttst222",
                            "email": "a@a.com",
                            "title": "title",
                            "phone": "phone",
                            "cell": "21313",
                            "fax": "321234",
                            "organization": "signiant",
                            "maxAllowedLoginAttempts": 10,
                            "failedLoginTimePeriod": 24,
                            "ignoreAdministrationForSoapAuth": false,
                            "groups": "Media Exchange Users",
                            "roles": {
                            "isTemporary": false,
                            "validFrom": null,
                            "validTo": null,
                            "isAdminGuiLogin": true,
                            "isSysAdmin": false,
                            "isOrgAdmin": false,
                            "isWorkflowAdmin": false,
                            "isWorkflowSupervisor": false,
                            "isCompEditor": true,
                            "isMonitorUser": false
                            },
                            "accessAcls": [
                            {
                            "userName": "admin",
                            "remove": true,
                            "read": true,
                            "edit": true
                            },
                            {
                            "userName": "testuser1",
                            "remove": false,
                            "read": true,
                            "edit": true
                            }
                            ],
                            "menus": [
                            {
                            "name": "Dashboard",
                            "parent": null
                            },
                            {
                            "name": "Groups",
                            "parent": {
                            "name": "Jobs",
                            "parent": null
                            }
                            },
                            {
                            "name": "List",
                            "parent": {
                            "name": "Users",
                            "parent": {
                            "name": "Administration",
                            "parent": null
                            }
                            }
                            }
                            ],
                            "mediaExchange": {
                            "mxAgent": "myagent.example.com",
                            "homeDir": "c:/tmp",
                            "allowedToBrowseAgent": true,
                            "transferJobGroup": "Default",
                            "defaultUploadProfile": "High Bandwidth - Unlimited",
                            "defaultDownloadProfile": "High Bandwidth - Unlimited",
                            "allowedToCreateTempUsers": true,
                            "allowedToSendPackages": true,
                            "allowedToReceivePackages": true,
                            "allowedToForwardPackages": false,
                            "notifyInterestedParties": true,
                            "interestedPartiesEmails": "testuser2@example.com",
                            "isTraceLoggingEnabled": false,				
                            "notifySenderPackReceive": true,
                            "notifySendCopyEmail": false,
                            "notifySenderReceiveFailure": true,
                            "notifySenderPackDownload": false,
                            "notifyReceiverPackAvaliable": true,
                            "notifyReceiverForSelectedCategoriesOnly": true,
                            "notifySenderReceiverAvailableCategories": ""
                            }
                            }
                            }
                            }
                            ]			
                        

Get User Groups Response JSON

                            [
                            {
                            "userGroup": {
                            "id": 3153,
                            "groupName": "Media Exchange Users",
                            "fields": {
                            "organization": "signiant",
                            "compEditor": false,
                            "persistentForDirServiceUsers": false,
                            "members": "mxuser2,mxuser1,mxuser3,mxuser5,mxuser4,testuser1",
                            "accessAcls": [
                            {
                            "userName": "Media Exchange Users",
                            "remove": false,
                            "read": true,
                            "edit": false
                            }
                            ],
                            "menus": [
                            {
                            "name": "Dashboard",
                            "parent": null
                            }
                            ],
                            "mediaExchange": null
                            }
                            }
                            }
                            ]			
                        

Get Channels Response JSON

                            [
                            {
                            "channel": {
                            "id": 227908,
                            "channel": {
                            "name": "myChannelName",
                            "parent": {
                            "name": "secondLevel",
                            "parent": {
                            "name": "topLevel",
                            "parent": null,
                            }
                            }
                            }
                            },
                            "fields": {
                            "name": "myChannelName",
                            "mxAgent": "myagent.example.com",
                            "notAvailableBefore": "Unlimited",
                            "expiresAfter": "Unlimited",
                            "packageDuration": 0,
                            "path": "",
                            "directoryType": "DELIVERY",
                            "accessAcls": [
                            {
                            "userName": "admin",
                            "remove": true,
                            "read": true,
                            "edit": true
                            }
                            ]
                            }
                            }
                            }
                            ]			
                        

Activate Resource Control JSON

                            [
                            {
                            "resourceControl":
                            {          
                            "resourceControlName": "1"		
                            }
                            }
                            ]			
                        

Deactivate Resource Control JSON

                            [
                            {
                            "resourceControl":
                            {          
                            "resourceControlName": "1"		
                            }
                            }
                            ]		
                        

Update Agent Resource Control JSON

                            [
                            {
                            "resourceControl":
                            {
                            "resourceControlName": "exampleAgentResourceControl",
                            "fields":
                            {
                            "type": "Agent",
                            "resourceControlName": "NewAgentResourceControlName",
                            "scope": "Agent Name",
                            "concurrency": 1,
                            "ceiling": 1048576,
                            "floor": 1048576,
                            "isPrioritization": true,
                            "resourceControlTimeOfDay":
                            [
                            {
                            "startTime": "08:20:00",
                            "endTime": "10:20:00",
                            "days": "YYYYYYY",
                            "dataRate": 1048576
                            },
                            {
                            "startTime": "00:00:00",
                            "endTime": "00:00:00",
                            "days": "YYYYYYY",
                            "dataRate": 1048576
                            }
                            ],
                            "filters":
                            [
                            "AGENT_TRANSFER_SOURCE=true",
                            "MX_CTE_DOWNLOAD=true",
                            "AGENT_REMOTE_COMMAND=true",
                            "AGENT_TRANSFER_TARGET=true",
                            "MX_CTE_UPLOAD=true"
                            ],
                            "sourceToAgent": "Agent Name",
                            "targetFromAgent": "All Agents",
                            "precedence": 1,
                            "accessAcls":
                            [
                            {
                            "userName": "admin",
                            "read": true,
                            "edit": true,
                            "remove": true
                            },
                            {
                            "userName": "test",
                            "remove": true,                           
                            "edit": true,
                            "read": true
                            },				 
                            {
                            "userName": "Media Exchange Users",
                            "remove": false,
                            "edit": false,
                            "read": false
                            },
                            {
                            "userName": "Media Exchange Guest Users",
                            "remove": false,
                            "edit": false,
                            "read": false
                            }
                            ]
                            }
                            }
                            }
                            ]		
                        

Stats for Job JSON

                            [
                            "job_id", 
                            "package_name", 
                            "source_host", 
                            "target_host", 
                            "status", 
                            "package_type", 
                            "transport_type_display", 
                            "effective_bytes", 
                            "file_count", 
                            "directory_count", 
                            "byte_count", 
                            "files_transferred", 
                            "files_skipped", 
                            "files_deleted", 
                            "failed_files", 
                            "agent_start_time", 
                            "remote_start_time", 
                            "names_cmd_end_time", 
                            "transfer_start_time", 
                            "transfer_end_time", 
                            "remote_end_time", 
                            "agent_end_time", 
                            "bandwidth_throttle", 
                            "transfer_rate", 
                            "transfer_rate_max", 
                            "transfer_rate_min", 
                            "directories_transferred", 
                            "directories_skipped", 
                            "directories_deleted", 
                            "failed_directories", 
                            "file_data_bytes", 
                            "target_filebytes", 
                            "file_attr_bytes", 
                            "file_data_bytes_comp", 
                            "file_attr_bytes_comp", 
                            "file_bytes_skipped", 
                            "file_bytes_deleted", 
                            "rsync_bytes_skipped", 
                            "ovhd_src_rsync", 
                            "ovhd_tgt_rsync", 
                            "ovhd_src_mnfst_comp", 
                            "ovhd_tgt_mnfst_comp", 
                            "ovhd_src_prtcl", 
                            "ovhd_tgt_prtcl", 
                            "ovhd_src_cchnl", 
                            "ovhd_tgt_cchnl", 
                            "sf_bytes_recvd", 
                            "sf_bytes_sent", 
                            "ntwk_bytes_sent", 
                            "ntwk_bytes_ack", 
                            "ntwk_bytes_recvd", 
                            "udp_aggressiveness", 
                            "udp_payload_size", 
                            "udp_header_size", 
                            "udp_pkts_sent", 
                            "udp_pkts_ack", 
                            "udp_pkts_recvd", 
                            "udp_pkts_resent", 
                            "udp_pkts_rjctd", 
                            "udp_ceiling", 
                            "udp_floor", 
                            "rmt_cmd_twu", 
                            "rmt_cmd_wuc", 
                            "unrecovered_errors", 
                            "total_errors", 
                            "proc_data_bytes_sent", 
                            "proc_data_bytes_unconsumed", 
                            "tnnl_data_bytes_sent", 
                            "tnnl_data_bytes_recvd", 
                            "agent_stat_time", 
                            "time_est"
                            ]		
                        

Stats for Job and Run Number JSON

                            [
                            "job_id", 
                            "package_name", 
                            "source_host", 
                            "target_host", 
                            "status", 
                            "package_type", 
                            "transport_type_display", 
                            "effective_bytes", 
                            "file_count", 
                            "directory_count", 
                            "byte_count", 
                            "files_transferred", 
                            "files_skipped", 
                            "files_deleted", 
                            "failed_files", 
                            "agent_start_time", 
                            "remote_start_time", 
                            "names_cmd_end_time", 
                            "transfer_start_time", 
                            "transfer_end_time", 
                            "remote_end_time", 
                            "agent_end_time", 
                            "bandwidth_throttle", 
                            "transfer_rate", 
                            "transfer_rate_max", 
                            "transfer_rate_min", 
                            "directories_transferred", 
                            "directories_skipped", 
                            "directories_deleted", 
                            "failed_directories", 
                            "file_data_bytes", 
                            "target_filebytes", 
                            "file_attr_bytes", 
                            "file_data_bytes_comp", 
                            "file_attr_bytes_comp", 
                            "file_bytes_skipped", 
                            "file_bytes_deleted", 
                            "rsync_bytes_skipped", 
                            "ovhd_src_rsync", 
                            "ovhd_tgt_rsync", 
                            "ovhd_src_mnfst_comp", 
                            "ovhd_tgt_mnfst_comp", 
                            "ovhd_src_prtcl", 
                            "ovhd_tgt_prtcl", 
                            "ovhd_src_cchnl", 
                            "ovhd_tgt_cchnl", 
                            "sf_bytes_recvd", 
                            "sf_bytes_sent", 
                            "ntwk_bytes_sent", 
                            "ntwk_bytes_ack", 
                            "ntwk_bytes_recvd", 
                            "udp_aggressiveness", 
                            "udp_payload_size", 
                            "udp_header_size", 
                            "udp_pkts_sent", 
                            "udp_pkts_ack", 
                            "udp_pkts_recvd", 
                            "udp_pkts_resent", 
                            "udp_pkts_rjctd", 
                            "udp_ceiling", 
                            "udp_floor", 
                            "rmt_cmd_twu", 
                            "rmt_cmd_wuc", 
                            "unrecovered_errors", 
                            "total_errors", 
                            "proc_data_bytes_sent", 
                            "proc_data_bytes_unconsumed", 
                            "tnnl_data_bytes_sent", 
                            "tnnl_data_bytes_recvd", 
                            "agent_stat_time", 
                            "time_est"
                            ]	
                        

Update Job JSON

                            [
                            {
                            "job":
                            {
                            "jobName": "MediaDistributor",
                            "fields":
                            {
                            "jobName": "test",
                            "jobGroupName": "MediaDistributor",
                            "jobTemplateLibraryName": "Media_Mover_Workflows",
                            "jobTemplateName": "MediaDistributor",
                
                            "jobArgs":
                            {
    
                            "MediaDistributor.Source.SourceAgent": "sourceagent.com",
                            "MediaDistributor.Source.SourceData": "c:/source/1.jpg",
                            "MediaDistributor.Source.IncludeFiles": "*",
                            "MediaDistributor.Source.ExcludeFiles": "",
                            "MediaDistributor.Source.ExcludeSubdirectories": "Specified",
                            "MediaDistributor.Source.ExcludeSubDirList": "",
                            "MediaDistributor.Source.FileReadinessCheckType": "Stream Growing Files",
                            "MediaDistributor.Source.FileReadinessCheckDelay": "10",
                            "MediaDistributor.Source.sourceDeletionsAfterSuccessfulTransfer": "None",
                            "MediaDistributor.Source.sourceDirectoriestoExcludefromDeletionScan": "",
                            "MediaDistributor.Source.sourceDatalocationAfterSuccessfulTransfer": "c:/source",
                            "MediaDistributor.Source.skipSourceFileNotFoundOnSend": "no", 
                            "MediaDistributor.Source.skipFilesWith0BytesSize": "yes",
                         
                         
                            "MediaDistributor.Target.TargetAgents": "targetagent.com",
                            "MediaDistributor.Target.TargetDirectory": "c:/target",
                            "MediaDistributor.Target.PathMappingOptions": "Job Date/Time",
                            "MediaDistributor.Target.maximumJobDateTimeDirectories": "",
                            "MediaDistributor.Target.RemoveTargetFiles": "yes",
                            "MediaDistributor.Target.removeExpiredDirectoriesonTarget": "no",
                            "MediaDistributor.Target.expirationPeriod": "30",
                        
                            "MediaDistributor.Transport._sp_udp": "yes",
                            "MediaDistributor.Transport.UseWANAccelerator": "No",
                            "MediaDistributor.Transport.wANAcceleratorAggressiveness": "high",
                            "MediaDistributor.Transport.BandwidthFloor": "0",
                            "MediaDistributor.Transport.BandwidthCeiling": "0",
                            "MediaDistributor.Transport.BandwidthThrottleByTimeOfDay": "00:00;00:00;YYYYYYY;0;",
                        
                            "MediaDistributor.Options._sp_encryption": "Encryption On",
                            "MediaDistributor.Options.deliveryMode": "Certify File Delivery",
                            "MediaDistributor.Options.CompressFiles": "yes",
                            "MediaDistributor.Options.followSymbolicLinks": "yes",
                            "MediaDistributor.Options.IncrementalTransfer": "yes",
                            "MediaDistributor.Options.verifyforsufficientdiskspacebeforeJobtransfersstart": "Yes",
                            "MediaDistributor.Options.verifytargetdirectoryexists": "no",
                        
                    
                        
                            "MediaDistributor.NotificationAndLogging.EmailCondition": "On Transfer",
                            "MediaDistributor.NotificationAndLogging.EmailTo": "",
                            "MediaDistributor.NotificationAndLogging.EmailCc": "",
                            "MediaDistributor.NotificationAndLogging.EmailBcc": "",
                            "MediaDistributor.NotificationAndLogging.emailJobFailureReportTo": "",
                            "MediaDistributor.NotificationAndLogging._sp_log_severity": "Debug",
                        
                        
                            "MediaDistributor.sNMPProperties.sNMPTrapReceivers": "",
                            "MediaDistributor.sNMPProperties.sNMPTrapCommunityString": "",
                            "MediaDistributor.sNMPProperties.sNMPTrapTypes": "Failure",
                        
                            "MediaDistributor.Schedule._sp_frequency": "First Saturday",
                            "MediaDistributor.Schedule._sp_start_at": "2017/12/20 10:11:00",
                            "MediaDistributor.Schedule.timezone": "Europe/Skopje",
                            "MediaDistributor.Schedule._sp_interrupt_on_failure": "Yes",
                            "MediaDistributor.Schedule.priority": "High",
                            "MediaDistributor.Schedule.finishBefore": ""
                      
                            }
                            }
                            }
                            }
                        ]

Update Job Resource Control JSON

                            [
                            {
                            "resourceControl":
                            {
                            "resourceControlName": "exampleJobResourceControl",
                            "fields":
                            {
                            "type": "Job",
                            "resourceControlName": "NewJobResourceControlName",
                            "scope": "MediaDistributor",
                            "concurrency": 1,
                            "ceiling": 1048576,
                            "floor": 1048576,
                            "isPrioritization": true,
                            "resourceControlTimeOfDay":
                            [
                            {
                            "startTime": "08:20:00",
                            "endTime": "10:20:00",
                            "days": "YYYYYYY",
                            "dataRate": 1048576
                            },
                            {
                            "startTime": "00:00:00",
                            "endTime": "00:00:00",
                            "days": "YYYYYYY",
                            "dataRate": 1048576
                            }
                            ],
                            "accessAcls":
                            [
                            {
                            "userName": "admin",
                            "read": true,
                            "edit": true,
                            "remove": true
                            },
                            {
                            "userName": "test",
                            "remove": true,                           
                            "edit": true,
                            "read": true
                            },				 
                            {
                            "userName": "Media Exchange Users",
                            "remove": false,
                            "edit": false,
                            "read": false
                            },
                            {
                            "userName": "Media Exchange Guest Users",
                            "remove": false,
                            "edit": false,
                            "read": false
                            }
                            ]
                            }
                            }
                            }
                        ]

Update Media Exchange Transfer Job Group Resource Control JSON

                            [
                            {
                            "resourceControl":
                            {
                            "resourceControlName": "exampleMediaExchangeTransferJobGroupResourceControl",
                            "fields":
                            {
                            "type": "Media Exchange Transfer Job Group",
                            "resourceControlName": "NewMediaExchangeTransferJobGroupResourceControlName",
                            "scope": "MediaExchangeJteTransfers",
                            "concurrency": 1,
                            "ceiling": 1048576,
                            "floor": 1048576,
                            "isPrioritization": true,
                            "resourceControlTimeOfDay":
                            [
                            {
                            "startTime": "08:20:00",
                            "endTime": "10:20:00",
                            "days": "YYYYYYY",
                            "dataRate": 1048576
                            },
                            {
                            "startTime": "00:00:00",
                            "endTime": "00:00:00",
                            "days": "YYYYYYY",
                            "dataRate": 1048576
                            }
                            ],
                            "filters":
                            [                       
                            "MX_CTE_DOWNLOAD=true",                      
                            "MX_CTE_UPLOAD=true"
                            ],
                            "precedence": 1,
                            "accessAcls":
                            [
                            {
                            "userName": "admin",
                            "read": true,
                            "edit": true,
                            "remove": true
                            },
                            {
                            "userName": "test",
                            "remove": true,                           
                            "edit": true,
                            "read": true
                            },				 
                            {
                            "userName": "Media Exchange Users",
                            "remove": false,
                            "edit": false,
                            "read": false
                            },
                            {
                            "userName": "Media Exchange Guest Users",
                            "remove": false,
                            "edit": false,
                            "read": false
                            }
                            ]
                            }
                            }
                            }
                            ]
                        

Update or Add Job Variable JSON

                            {
                            "MediaDistributor.Source.FileReadinessCheckDelay": "10",
                            "MediaDistributor.Options.followSymbolicLinks": "yes",
                            "MediaDistributor.sNMPProperties.sNMPTrapTypes": "",
                            "MediaDistributor.Options.verifytargetdirectoryexists": "no",
                            "MediaDistributor.Source.skipFilesWith0BytesSize": "no",
                            "MediaDistributor.NotificationAndLogging.EmailBcc": "",
                            "MediaDistributor.Target.RemoveTargetFiles": "no",
                            "MediaDistributor.Target.TargetDirectory": "c:\\Users",
                            "MediaDistributor.NotificationAndLogging.EmailTo": "",
                            "MediaDistributor.Source.FileReadinessCheckType": "None",
                            "MediaDistributor.Target.expirationPeriod": "30",
                            "MediaDistributor.Schedule._sp_start_at": "",
                            "MediaDistributor.Transport.UseWANAccelerator": "yes",
                            "MediaDistributor.Source.ExcludeSubDirList": "",
                            "MediaDistributor.Schedule._sp_frequency": "None",
                            "MediaDistributor.Source.SourceAgent": "sourceAgent",
                            "MediaDistributor.Source.ExcludeSubdirectories": "None",
                            "MediaDistributor.Options._sp_encryption": "off",
                            "MediaDistributor.Source.ExcludeFiles": "",
                            "MediaDistributor.Transport.BandwidthFloor": "0",
                            "MediaDistributor.sNMPProperties.sNMPTrapCommunityString": "",
                            "MediaDistributor.Schedule._sp_interrupt_on_failure": "no",
                            "MediaDistributor.Options.verifyforsufficientdiskspacebeforeJobtransfersstart": "no",
                            "MediaDistributor.Source.IncludeFiles": "*",
                            "MediaDistributor.Options.CompressFiles": "no",
                            "MediaDistributor.NotificationAndLogging._sp_log_severity": "2",
                            "MediaDistributor.NotificationAndLogging.EmailCc": "",
                            "MediaDistributor.Target.maximumJobDateTimeDirectories": "10",
                            "MediaDistributor.Options.IncrementalTransfer": "no",
                            "MediaDistributor.Transport.BandwidthCeiling": "0",
                            "MediaDistributor.Source.SourceData": "",
                            "MediaDistributor.Schedule.finishBefore": "",
                            "MediaDistributor.Target.TargetAgents": "targetAgents",
                            "MediaDistributor.Transport.BandwidthThrottleByTimeOfDay": "00:00;00:00;YYYYYYY;0;",
                            "MediaDistributor.Target.PathMappingOptions": "Source Host,Job Date/Time",
                            "MediaDistributor.Transport.wANAcceleratorAggressiveness": "medium",
                            "MediaDistributor.Options.deliveryMode": "unsigned",
                            "MediaDistributor.sNMPProperties.sNMPTrapReceivers": "",
                            "MediaDistributor.Schedule.priority": "2",
                            "MediaDistributor.NotificationAndLogging.EmailCondition": "Always",
                            "MediaDistributor.Source.skipSourceFileNotFoundOnSend": "yes",
                            "MediaDistributor.Target.removeExpiredDirectoriesonTarget": "no",
                            "MediaDistributor.NotificationAndLogging.emailJobFailureReportTo": "",
                            "MediaDistributor.Transport._sp_udp": "no",
                            "MediaDistributor.Source.sourceDatalocationAfterSuccessfulTransfer": "",
                            "MediaDistributor.Schedule.timezone": "Europe/Belgrade",
                            "MediaDistributor.Source.sourceDeletionsAfterSuccessfulTransfer": "none",
                            "MediaDistributor.Source.sourceDirectoriestoExcludefromDeletionScan": ""
                            }
                        

Get Job View Response JSON

                            [  
                            {  
                            "job":{  
                            "id":109839,
                            "jobName":"test",
                            "fields":{  
                            "jobTemplate":"MediaDistributor",
                            "jobState":"Completed",
                            "startedAt":"2017-04-28T14:40:14",
                            "percentComplete":"100%",
                            "jobGroup":"MediaDistributor"
                            }
                            }
                            },
                            {  
                            "job":{  
                            "id":109841,
                            "jobName":"testets",
                            "fields":{  
                            "jobTemplate":"MediaDistributor",
                            "jobState":"Canceled",
                            "startedAt":"2017-04-24T16:53:57",
                            "percentComplete":"15%",
                            "jobGroup":"MediaDistributor"
                            }
                            }
                            },
                            {  
                            "job":{  
                            "id":128343,
                            "jobName":"MediaDistributor_1",
                            "fields":{  
                            "jobTemplate":"MediaDistributor",
                            "jobState":"Completed",
                            "startedAt":"2017-04-21T11:05:41",
                            "percentComplete":"100%",
                            "jobGroup":"MediaDistributor"
                            }
                            }
                            },
    
                            {  
                            "job":{  
                            "id":125371,
                            "jobName":"jobtest2",
                            "fields":{  
                            "jobTemplate":"MediaDistributor",
                            "jobState":"Completed",
                            "startedAt":"2017-04-12T14:59:46",
                            "percentComplete":"100%",
                            "jobGroup":"MediaDistributor"
                            }
                            }
                            }  
                            }
                            }
                            ]
    
                        

Revoke Agent Certificate Response JSON

                            {
                            "success": "true"
                            }
                        

Agent Job Log Response JSON

                            [
                            {
                            "jobLog": 
                            {
                            "date": 1522221591000,
                            "severity": "Info",
                            "category": "Application",
                            "message": "The Signiant supervisor V13.3.0[76914] (logbase: Default-MediaDistributor.5116).",
                            "messageId": ">a href='javascript:FMCOpenHelp("manager_029_1", "signiant", null, null)'>40010>/a>",
                            "messageSource": "Supervisor",
                            "agent": "my.example.server",
                            "jobTemplate": ""
                            }
                            },
                            {
                            "jobLog": 
                            {
                            "date": 1522221591000,
                            "severity": "Info",
                            "category": "Application",
                            "message": "Execution counts - groups: 4. links: 0, job components: 3",
                            "messageId": "> href='javascript:FMCOpenHelp("manager_029_1", "signiant", null, null)'>40029>/a>",
                            "messageSource": "Supervisor",
                            "agent": "my.example.server",
                            "jobTemplate": "MediaDistributor"
                            }
                            }
                            ]
                        

REST Errors

When an exception occurs while processing a REST request, the server returns a REST error message.

Errors may occur when processing a request itself, or may occur as the result of an outside condition (i.e. the database becoming unavailable).

These errors are written in plain language and typically indicate the missing or incorrect information that triggered the error.

The following table includes examples of REST error messages:

Fault Message Explanation
Exception retrieving user - no user was found with the specified username or id The username or ID was not found. Verify that the correct username/ID details are being used.
Exception creating user - user with username: <username> already exists! A user with the selected username already exists, choose a different username.
Exception updating groups - no user exists with the specified ID: <userID> or userName:<userName>! The user group could not be updated correctly. The specified user does not exist. Verify the username and ID.
Exception deleting channel - multiple channels found with the specified channel name: <channelName>. Please use a unique name or channel ID. The specified channel could not be deleted because there are multiple channels with the specified name. Ensure you're using a unique name or channel ID.

The following is an example of a JSON Fault Response:

{
  "fault": {
    "error": "Exception retrieving user - no user was found with the specified username or ID:testuser1!"
  }
}			
				
				

REST API Examples

 

 

These REST examples use Curl, a command line tool used to initiate HTTP requests. To download and install Curl on Windows, see CURL 7.41.0.

These services support the following operations:

Supported Command Command Description

create

Used to create a user, user group, agent group, job group or channel.

read

Used to view user, user group or channel details.

update

Used to update a user, user group, agent group, job group or channel.

delete

Used to delete a user, user group, agent group, job group or channel.

list

Used to list users, user group, agents, agent group, job groups or channel details.

When using update, only the updated fields need to be included in the JSON Body Request.

Note:the JSON examples include all of the possible values for users, user group and channels, but only the default values displayed in the Signiant Manger GUI are required.

Users

The following REST examples show how to create, edit and delete users.

Creating Users (POST)

Create Request

 
curl -X POST -H "username: <YourUsername>" -H "password: <YourPassword>" -H "Content-Type: application/json" --data <jsonBody> https://<YourManagerHostname>/signiant/spring/admin/v1.0/users						
                    

JSON Body Request

[
{
    "user": {
        "userName":"exampleuser",
        "fields":{
            "firstName":"Example",
            "lastName":"User",
            "email":"user@example.com",
            "title":"title",
            "phone":"phone",
            "cell":"21313",
            "fax":"321234",
            "password":"password",
            "organization":"signiant",
            "failedLoginCount":"0",
            "maxAllowedLoginAttempts":"10",
            "failedLoginTimePeriod":"24",
            "ignoreAdministrationForSoapAuth":false,
            "groups":"Media Exchange Users,Media Exchange Guest Users",
            "roles":{
                "isTemporary":false,
                "isAdminGuiLogin":false,
                "validFrom":null,
                "validTo":null,
                "isSysAdmin":false,
                "isOrgAdmin":false,
                "isWorkflowAdmin":false,
                "isWorkflowSupervisor":false,
                "isCompEditor":true,
                "isMonitorUser":false
            },
            "accessAcls":[{  
                "userName":"Media Exchange Guest Users",
                "read":true,
                "edit":true,
                "remove":true
            },{  
                "userName":"admin",
                "read":true,
                "edit":true,
                "remove":true
            }],
            "menus":[{
                "name":"Groups",
                "parent":{
                    "name":"Jobs"
                }
            },{
                "name":"List",
                "parent":{
                    "name":"Users",
                    "parent":{
                        "name":"Administration"
                    }
                }
            }],
            "mediaExchange":{
                "mxAgent":"myagent.example.com",
                "homeDir":"c:/tmp",
                "allowedToBrowseAgent":true,
                "transferJobGroup":"Default",
                "defaultUploadProfile":"System Default",
                "defaultDownloadProfile":"System Default",
                "allowedToCreateTempUsers":true,
                "allowedToSendPackages":true,
                "allowedToReceivePackages":true,
                "allowedToForwardPackages":false,
                "notifyInterestedParties":true,
                "interestedPartiesEmails":"user2@example.com",
                "notifySenderPackReceive":true,
                "notifySendCopyEmail":false,
                "notifySenderReceiveFailure":true,
                "notifySenderPackDownload":false,
                "notifyReceiverPackAvaliable":true,
                "notifyReceiverForSelectedCategoriesOnly":true,
                "notifySenderReceiverAvailableCategories":null
            }
        }
    }
}
]				
                
                
                

Editing Users (PUT)

Edit Request

curl -X PUT -H "username: <YourUsername>" -H "password: <YourPassword>" -H "Content-Type: application/json" --data <jsonBody> https://<YourManagerHostname>/signiant/spring/admin/v1.0/users					
                    

JSON Body Request

[
{  
  "user":{  
     "userName":"exampleuser",
     "fields":{  
        "firstName":"Example",
        "lastName":"User",
        "email":"user@example.com",
        "title":"title",
        "phone":"phone",
        "cell":"21313",
        "fax":"321234",
        "password":"password",
        "organization":"signiant",
        "failedLoginCount":"0",
        "maxAllowedLoginAttempts":"10",
        "failedLoginTimePeriod":"24",
        "ignoreAdministrationForSoapAuth":"false",
        "groups":"Media Exchange Users,Media Exchange Guest Users",
        "roles":{  
           "isTemporary":"false",
           "isAdminGuiLogin":"false",
           "validFrom":"null",
           "validTo":"null",
           "isSysAdmin":"false",
           "isOrgAdmin":"false",
           "isWorkflowAdmin":"false",
           "isWorkflowSupervisor":"false",
           "isCompEditor":"true",
           "isMonitorUser":"false"
        },
        "accessAcls":[  
           {  
              "userName":"Media Exchange Guest Users",
              "read":"true",
              "edit":"true",
              "remove":"true"
           },
           {  
              "userName":"admin",
              "read":"true",
              "edit":"true",
              "remove":"true"
           }
        ],
        "menus":[  
           {  
              "name":"Groups",
              "parent":{  
                 "name":"Jobs"
              }
           },
           {  
              "name":"List",
              "parent":{  
                 "name":"Users",
                 "parent":{  
                    "name":"Administration"
                 }
              }
           }
        ],
        "mediaExchange":{  
           "mxAgent":"myagent.example.com",
           "homeDir":"c:/tmp",
           "allowedToBrowseAgent":"true",
           "transferJobGroup":"Default",
           "defaultUploadProfile":"System Default",
           "defaultDownloadProfile":"System Default",
           "allowedToCreateTempUsers":"true",
           "allowedToSendPackages":"true",
           "allowedToReceivePackages":"true",
           "allowedToForwardPackages":"false",
           "notifyInterestedParties":"true",
           "interestedPartiesEmails":"user2@example.com",
           "notifySenderPackReceive":"true",
           "notifySendCopyEmail":"false",
           "notifySenderReceiveFailure":"true",
           "notifySenderPackDownload":"false",
           "notifyReceiverPackAvaliable":"true",
           "notifyReceiverForSelectedCategoriesOnly":"true",
           "notifySenderReceiverAvailableCategories":"null"
        }
     }
  }
}
]
                    

List Users (Get)

https://< HOSTNAME>/signiant/spring/admin/v1.0/listusers

This request supports two optional filters:

  • userType: "manager", "mediaExchangeUser" or "mediaExchangeGuestUser"
  • status: "activated" or "deactivated"

List Request

curl -X GET -H "username: <YourUsername>" -H "password: <YourPassword>" -H "Content-Type: application/json" https://<YourManagerHostname>/signiant/spring/admin/v1.0/listusers?userType=<userTypeOption>&status=<statusOption>					
                    

List User Response

[
{
"user": {
  "id": 10605,
  "userName": "mxuser1",
  "state": {
    "status": "Activated",
    "lastLoginAttempt": "2015-06-24T09:54:39",
    "guest": false
  },
  "fields": {
    "firstName": "mxuser1",
    "lastName": "mxuser1",
    "organization": "companyName",
    "mediaExchange": {
      "mxAgent": "agent1.example.com"
    }
  }
}
},
{
"user": {
  "id": 10,
  "userName": "admin",
  "state": {
    "status": "Activated",
    "lastLoginAttempt": "2015-06-24T13:41:04",
    "guest": false
  },
  "fields": {
    "firstName": "Admin",
    "lastName": "User",
    "organization": "companyName",
    "mediaExchange": null
  }
}
},
{
"user": {
  "id": 241857,
  "userName": "fimsuser",
  "state": {
    "status": "Deactivated",
    "lastLoginAttempt": "2015-06-12T15:28:48",
    "guest": false
  },
  "fields": {
    "firstName": "fims",
    "lastName": "user",
    "organization": "companyName",
    "mediaExchange": null
  }
}
}
]					
                    

Activate Users (Get)

https://< HOSTNAME>/signiant/spring/admin/v1.0/activateusers

Activate Request

 
curl -X GET -H "username: <YourUsername>" -H "password: <YourPassword>" -H "Content-Type: application/json" --data <jsonBody>  https://<YourManagerHostname>/signiant/spring/admin/v1.0/activateusers				
                

When the jsonbody is a list of users, the username or ID attribute is required:

                    [
{
"user": {
  "userName": "mxuser1"
}
}
]					
                

Activate User Response

                    {
"editor": "admin",
"users": [
{
  "id": 167387,
  "userName": "mxuser1"
}
]
}
                

Deactivate Users (Get)

https://< HOSTNAME>/signiant/spring/admin/v1.0/deactivateusers

Deactivate Request

curl -X GET -H "username: <YourUsername>" -H "password: <YourPassword>" -H "Content-Type: application/json" --data <jsonBody>  https://<YourManagerHostname>/signiant/spring/admin/v1.0/deactivateusers						
                

When the jsonbody is a list of users, the username or ID attribute is required:

[
{
"user": {
  "userName": "mxuser1"
}
}
]
                    
                

Deactivate User Response

                    {
"editor": "admin",
"users": [
{
  "id": 167387,
  "userName": "mxuser1"
}
]
}					
                

Deleting Users by Username

 
curl -X DELETE -H "username: <YourUsername>" -H "password: <YourPassword>" -H "Content-Type: application/json" https://<YourManagerHostname>/signiant/spring/admin/v1.0/users/<YourUserName>			
            

Deleting Users by ID

curl -X DELETE -H "username: <YourUsername>" -H "password: <YourPassword>" -H "Content-Type: application/json" https://<YourManagerHostname>/signiant/spring/admin/v1.0/users/<YourUserId>			
            

Getting Users by Username

 
curl -X GET -H "username: <YourUsername>" -H "password: <YourPassword>" -H "Content-Type: application/json" https://<YourManagerHostname>/signiant/spring/admin/v1.0/users/<YourUserName>			
            

Getting Users by Email Address

	
curl -X GET -H "username: <YourUsername>" -H "password: <YourPassword>" -H "Content-Type:application/json" https://<YourManagerHostname>/signiant/spring/admin/v1.0/users?email=<emailAddress>					

This call accepts only one email address and returns a list of user who have this email address in their email field. This can result in returning a long list of users.

Getting Users by ID

curl -X GET -H "username: <YourUsername>" -H "password: <YourPassword>" -H "Content-Type: application/json" https://<YourManagerHostname>/signiant/spring/admin/v1.0/users/<YourUserId>			
            

Channels

The following REST examples show how to create, edit and delete channels.

Creating Channels (POST)

Create Request


curl -X POST -H "username: <YourUsername>" -H "password: <YourPassword>" -H "Content-Type: application/json" --data <jsonBody> https://<YourManagerHostname>/signiant/spring/admin/v1.0/channels

JSON Body Request

[
{
    "channel":{
        "channel":{
            "name":"myChannelName1",
            "parent":{
                "name":"secondLevel",
                "parent":{
                    "name":"topLevel"
                }
            }
        },
        "fields":{
            "name":"myChannelName1",
            "mxAgent":"myagent.example.com",
            "notAvailableBefore":"2014-04-09T18:02:52.249Z",
            "expiresAfter":"2014-08-21T18:02:52.249Z",
            "packageDuration":"600000",
            "createPackageDirectory":true,
            "directoryType":"DELIVERY",
            "path":"",
            "accessAcls":[{
                "userName":"mxuser1",
                "read":true,
                "edit":true,
                "remove":false
            },{
                "userName":"mxuser2",
                "read":true
            }]
        }
    }
}
]					
                    

Editing Channel (PUT)

Edit Request

 
curl -X PUT -H "username: <YourUsername>" -H "password: <YourPassword>" -H "Content-Type: application/json" --data <jsonBody> https://<YourManagerHostname>/signiant/spring/admin/v1.0/channels			
            

JSON Body Request

[
{
  "channel":{
     "name":"3",
     "parent":{
        "name":"2",
        "parent":{
           "name":"1"
        }
     }
  },
  "fields":{
     "name":"3",
     "mxAgent":"zoki.x3mk.local",
     "notAvailableBefore":"2014-04-09T18:02:52.249Z",
     "expiresAfter":"2014-08-21T18:02:52.249Z",
     "packageDuration":"600000",
     "createPackageDirectory":"true",
     "directoryType":"DELIVERY",
     "path":"d:\\channelRepo",
     "accessAcls":[
        {
           "userName":"webserver",
           "read":"true",
           "edit":"true",
           "remove":"false"
        },
        {
           "userName":"elena",
           "read":"true"
        }
     ]
  }
}
]		
            

List Channels (Get)

https://< HOSTNAME>/signiant/spring/admin/v1.0/listchannels

List Request

curl -X GET -H "username: <YourUsername>" -H "password: <YourPassword>" -H "Content-Type: application/json" https://<YourManagerHostname>/signiant/spring/admin/v1.0/listchannels						
                    

List Channels Response

[
{
"channel": {
  "id": 10696,
  "channel": {
    "name": "TestCategory1",
    "parent": null
  },
  "fields": {
    "name": "TestCategory1",
    "mxAgent": "agent1.example.com",
    "notAvailableBefore": "Unlimited",
    "expiresAfter": "Unlimited",
    "status": "Activated",
    "packageDuration": 0
  }
}
}
]
                            

Delete Channels by Name

 
curl -X DELETE -H "username: <YourUsername>" -H "password: <YourPassword>" -H "Content-Type: application/json" https://<YourManagerHostname>/signiant/spring/admin/v1.0/channels/<YourChannelName>					
                    

Delete Channels by ID

 
curl -X DELETE -H "username: <YourUsername>" -H "password: <YourPassword>" -H "Content-Type: application/json" https://<YourManagerHostname>/signiant/spring/admin/v1.0/channels/<YourChannelID>					
                    

Getting Channels by Name

 
curl -X GET -H "username: <YourUsername>" -H "password: <YourPassword>" -H "Content-Type: application/json" https://<YourManagerHostname>/signiant/spring/admin/v1.0/channels/<YourChannelName>					
                

Getting Channels by ID

 
curl -X GET -H "username: <YourUsername>" -H "password: <YourPassword>" -H "Content-Type: application/json" https://<YourManagerHostname>/signiant/spring/admin/v1.0/channels/<YourChannelID>					
                

Agents

The following REST examples show how to list agents.

List Agents

https://< HOSTNAME>/signiant/spring/admin/v1.0/listagents

List Request

curl -X GET -H "username: <YourUsername>" -H "password: <YourPassword>" -H "Content-Type: application/json" https://<YourManagerHostname>/signiant/spring/admin/v1.0/listagents						
                    

List Agents Response

[
{
"agents": {
  "id": 41203,
  "groupName": "Administration",
  "fields": {
    "organization": "Signiant",
    "loadBalanced": "Yes",
    "description": "",
    "mxEnabled": false,
    "transferConcurrency": null
  }
}
},
{
"agents": {
  "id": 391507,
  "groupName": "exampleAgentGroup",
  "fields": {
    "organization": "Signiant",
    "loadBalanced": "Yes",
    "description": "Agent Group",
    "mxEnabled": true,
    "transferConcurrency": 67
  }
}
}
]

Agent Groups

The following REST examples show how to create and edit agent groups.

Creating Agent Groups (POST)

Create Request

 
curl -X POST -H "username: <YourUsername>" -H "password: <YourPassword>" -H "Content-Type: application/json" --data <jsonBody> https://<YourManagerHostname>/signiant/spring/admin/v1.0/agentgroups						
                    

JSON Body Request

[
    {
        "agentGroup":
        {
            
            "groupName": "exampleAgentGroup",
            "fields":
            {
                "description": "Agent Group",
                "organization": "xyzcompany",
                "loadBalance": "Yes",
                "members":
                [
                    {
                         
                        "name": "test_group"
                     
                    }
                ],
                "accessAcls":
                [
                    {
                        "userName": "mxuser1",
                        "remove": true,
                        "execute": false,
                        "edit": true,
                        "read": true
                    },
                 
                    {
                        "userName": "Media Exchange Users",
                        "remove": false,
                        "execute": true,
                        "edit": false,
                        "read": false
                    },
                    {
                        "userName": "Media Exchange Guest Users",
                        "remove": false,
                        "execute": true,
                        "edit": false,
                        "read": false
                    },
                    {
                        "userName": "admin",
                        "remove": true,
                        "execute": true,
                        "edit": true,
                        "read": true
                    }
                ],
             
                "mxProperties":
                {
                    "downloadBandwidthProfile": "System Default",
                    "uploadBandwidthProfile": "System Default",
                    "mxEnabled": true,
                    "mxNetworkMaskProfileId": true,
                    "licenses Remaining": 945,
                    "mxConcurrency": 67,
                    "packageRepositoryPath": "c:/tmp",
                    "useMxRelaysFromMemberAgents": false,
          "relays":
                [
                    {
                        "address": "myagent.example.com",
                        "udpPort": 49221,
                        "tcpPort": 49221,
                        "httpPort": 8080
                    }
                 
                ]

                }
            }
        }
    }
]
                
                    
    

Editing Agent Groups (PUT)

Edit Request


curl -X PUT -H "username: <YourUsername>" -H "password: <YourPassword>" -H "Content-Type: application/json" --data <jsonBody> https://<YourManagerHostname>/signiant/spring/admin/v1.0/agentgroups					
        
    

JSON Body Request

[
    {
        "agentGroup":
        {
            
            "groupName": "exampleAgentGroup",
            "fields":
            {
                "description": "Agent Group",
                "organization": "xyzcompany",
                "loadBalance": "Yes",
                "addedMembers":
                [
                    {
                      
                        "name": "test_agent"
                    }
                   
                ],
                "removedMembers":
                [
                    {
                      
                        "name": "test_group"
                    }
                   
                ],
                "accessAcls":
                [
                    {
                        "userName": "test",
                        "remove": false,
                        "execute": false,
                        "edit": false,
                        "read": false
                    },
                 
                    {
                        "userName": "Media Exchange Users",
                        "remove": false,
                        "execute": true,
                        "edit": false,
                        "read": false
                    },
                    {
                        "userName": "Media Exchange Guest Users",
                        "remove": false,
                        "execute": true,
                        "edit": false,
                        "read": false
                    },
                    {
                        "userName": "admin",
                        "remove": true,
                        "execute": true,
                        "edit": true,
                        "read": true
                    }
                ],
             
                "mxProperties":
                {
                    "downloadBandwidthProfile": "System Default",
                    "uploadBandwidthProfile": "System Default",
                    "mxEnabled": true,
                    "mxNetworkMaskProfileId": false,
                    "licenses Remaining": 945,
                    "mxConcurrency": 67,
                    "packageRepositoryPath": "c:/tmp",
                    "useMxRelaysFromMemberAgents": false,
          "relays":
                [
                    {
                        "address": "myagent.example.com",
                        "udpPort": 49221,
                        "tcpPort": 49221,
                        "httpPort": 8080
                    }
                 
                ]

                }
            }
        }
    }
]					
        
            

List Agent Groups

https://< HOSTNAME>/signiant/spring/admin/v1.0/listagentgroups

List Request

curl -X GET -H "username: <YourUsername>" -H "password: <YourPassword>" -H "Content-Type: application/json" https://<YourManagerHostname>/signiant/spring/admin/v1.0/listagentgroups						
                    

List Agent Group Response

[
{
"agentGroup": {
  "id": 41203,
  "groupName": "Administration",
  "fields": {
    "organization": "Signiant",
    "loadBalanced": "Yes",
    "description": "",
    "mxEnabled": false,
    "transferConcurrency": null
  }
}
},
{
"agentGroup": {
  "id": 391507,
  "groupName": "exampleAgentGroup",
  "fields": {
    "organization": "Signiant",
    "loadBalanced": "Yes",
    "description": "Agent Group",
    "mxEnabled": true,
    "transferConcurrency": 67
  }
}
}
]

Getting Agent Groups

curl -X GET -H "username: <YourUsername>" -H "password: <YourPassword>" -H "Content-Type: application/json" https://<YourManagerHostname>/signiant/spring/admin/v1.0/agentgroups/<YourAgentGroupName>

Deleting Agent Groups

curl -X DELETE -H "username: <YourUsername>" -H "password: <YourPassword>" -H "Content-Type: application/json" https://<YourManagerHostname>/signiant/spring/admin/v1.0/agentgroups/<YourAgentGroupName>

Job Groups

The following REST examples show how to create and edit job groups.

Creating Job Groups (POST)

Create Request


curl -X POST -H "username: <YourUsername>" -H "password: <YourPassword>" -H "Content-Type: application/json" --data <jsonBody> https://<YourManagerHostname>/signiant/spring/admin/v1.0/jobgroups		
                    
    

JSON Body Request

[
    {
        "jobGroup":
        {
            
            "groupName": "newjobgroup",
            "fields":
            {
                "groupDescription": "New Team job group",
                "limitAccess": "n",
                "accessAcls":
                [
                    {
                        "userName": "mxuser1",
                        "edit": true,
                        "read": true,
                        "execute": false,
                        "remove": true
                    },
                    {
                        "userName": "admin",
                        "edit": true,
                        "read": true,
                        "execute": true,
                        "remove": true
                    },
                    {
                        "userName": "Media Exchange Users",
                        "edit": false,
                        "read": true,
                        "execute": false,
                        "remove": false
                    }
                ]
            }
        }
    }
]					
                    
        

Editing Job Groups (PUT)

Edit Request

                    

curl -X PUT -H "username: <YourUsername>" -H "password: <YourPassword>" -H "Content-Type: application/json" --data <jsonBody> https://<YourManagerHostname>/signiant/spring/admin/v1.0/jobgroups			
        

JSON Body Request

[
    {
        "jobGroup":
        {
            
            "groupName": "new_job_group",
            "fields":
            {
                "groupDescription": "New Team job group changed",
                "limitAccess": "n",
                "accessAcls":
                [
                    {
                        "userName": "mxuser1",
                        "edit": true,
                        "read": true,
                        "execute": false,
                        "remove": true
                    },
                    {
                        "userName": "mxuser2",
                        "edit": true,
                        "read": true,
                        "execute": false,
                        "remove": true
                    },
                    {
                        "userName": "admin",
                        "edit": true,
                        "read": true,
                        "execute": true,
                        "remove": true
                    },
                    {
                        "userName": "Media Exchange Users",
                        "edit": false,
                        "read": true,
                        "execute": false,
                        "remove": false
                    }
                ]
            }
        }
    }
]					
        
            

List Job Groups (Get)

https://< HOSTNAME>/signiant/spring/admin/v1.0/listjobgroups

List Request

curl -X GET -H "username: <YourUsername>" -H "password: <YourPassword>" -H "Content-Type: application/json" https://<YourManagerHostname>/signiant/spring/admin/v1.0/listjobgroups						
                    

List Job Group Response

[
{
"jobGroup": {
  "id": 41203,
  "groupName": "Administration",
  "fields": {
    "organization": "Signiant",
    "loadBalanced": "Yes",
    "description": "",
    "mxEnabled": false,
    "transferConcurrency": null
  }
}
},
{
"jobGroup": {
  "id": 391507,
  "groupName": "exampleAgentGroup",
  "fields": {
    "organization": "Signiant",
    "loadBalanced": "Yes",
    "description": "Agent Group",
    "mxEnabled": true,
    "transferConcurrency": 67
  }
}
}
]

Getting Job Groups

curl -X GET -H "username: <YourUsername>" -H "password: <YourPassword>" -H "Content-Type: application/json" https://<YourManagerHostname>/signiant/spring/admin/v1.0/jobgroups/<YourJobGroupName>

Deleting Job Groups

curl -X DELETE -H "username: <YourUsername>" -H "password: <YourPassword>" -H "Content-Type: application/json" https://<YourManagerHostname>/signiant/spring/admin/v1.0/jobgroups/<YourJobGroupName>

User Groups

The following REST examples show how to create, edit and delete user groups.

Creating User Groups (POST)

Create Request

 
curl -X POST -H "username: <YourUsername>" -H "password: <YourPassword>" -H "Content-Type: application/json" --data <jsonBody> https://<YourManagerHostname>/signiant/spring/admin/v1.0/usergroups					
                    

JSON Body Request

[
{
    "userGroup":{
        "groupName":"examplegroup",
        "fields":{
            "groupName":"examplegroup",
            "organization":"signiant",
            "compEditor":true,
            "persistentForDirServiceUsers":true,
            "members":["exampleuser","testuser","admin"],
            "accessAcls":[{
                "userName":"exampleuser",
                "read":true,
                "edit":true,
                "remove":false
            }],
            "menus":[{
                "name":"Groups",
                "parent":{
                    "name":"Jobs"
                }
            },{
                "name":"List",
                "parent":{
                    "name":"Users",
                    "parent":{
                        "name":"Administration"
                    }
                }
            }],
            "mediaExchange":{
                "mxEnabled":true,
                "canSubscribe":true
            }
        }
    }
}
]
                    

Editing User Groups (PUT)

Edit Request

 
curl -X PUT -H "username: <YourUsername>" -H "password: <YourPassword>" -H "Content-Type: application/json" --data <jsonBody> https://<YourManagerHostname>/signiant/spring/admin/v1.0/usergroups					
                    

JSON Body Request

[
{
  "groupName":"group1",
  "fields":{
     "groupName":"group222",
     "organization":"test",
     "compEditor":"true",
     "persistentForDirServiceUsers":"true",
     "addedMembers":[
        "admin",
        "elena"
     ],
     "removedMembers":[
        "zoki"
     ],
     "accessAcls":[
        {
           "userName":"webserver",
           "read":"true",
           "edit":"true",
           "remove":"false"
        },
        {
           "userName":"elena",
           "read":"true"
        }
     ],
     "menus":[
        {
           "name":"Groups",
           "parent":{
              "name":"Jobs"
           }
        },
        {
           "name":"List",
           "parent":{
              "name":"Users",
              "parent":{
                 "name":"Administration"
              }
           }
        }
     ],
     "mediaExchange":{
        "mxEnabled":"true",
        "canSubscribe":"true"
     }
  }
}
]			
            

List User Groups (Get)

https://< HOSTNAME>/signiant/spring/admin/v1.0/listusergroups

List Request

 
curl -X GET -H "username: <YourUsername>" -H "password: <YourPassword>" -H "Content-Type: application/json" https://<YourManagerHostname>/signiant/spring/admin/v1.0/listusergroups					
                    
                    

List User Groups Response

[
{
"userGroup": {
  "id": 3154,
  "groupName": "Media Exchange Guest Users",
  "fields": {
    "organization": "companyName",
    "mediaExchange": null
  }
}
},
{
"userGroup": {
  "id": 3153,
  "groupName": "Media Exchange Users",
  "fields": {
    "organization": "companyName",
    "mediaExchange": null
  }
}
}
]				
            

Deleting User Groups by Name

 
curl -X DELETE -H "username: <YourUsername>" -H "password: <YourPassword>" -H "Content-Type: application/json" https://<YourManagerHostname>/signiant/spring/admin/v1.0/usergroups/<YourGroupName>			
            

Deleting User Groups by ID

curl -X DELETE -H "username: <YourUsername>" -H "password: <YourPassword>" -H "Content-Type: application/json" https://<YourManagerHostname>/signiant/spring/admin/v1.0/usergroups/<YourGroupID>					
                    

Getting User Groups by Name

 
curl -X GET -H "username: <YourUsername>" -H "password: <YourPassword>" -H "Content-Type: application/json" https://<YourManagerHostname>/signiant/spring/admin/v1.0/usergroups/<YourGroupName>			
                

Getting User Groups by ID

curl -X GET -H "username: <YourUsername>" -H "password: <YourPassword>" -H "Content-Type: application/json" https://<YourManagerHostname>/signiant/spring/admin/v1.0/usergroups/<YourGroupID>					
                

Resource Controls

The following REST examples show how to create, edit, and list resource controls.

Creating Resource Controls (POST)

Create Request

 curl -X POST -H "username: <YourUsername>" -H "password: <YourPassword>" -H "ContentType: application/json" --data <jsonBody>https://<YourManagerHostName>/signiant/spring/admin/v1.0/resourcecontrols					
                

Editing Resource Controls (PUT)

Edit Request

 curl -X PUT -H "username: <YourUsername>" -H "password: <YourPassword>" -H "ContentType: application/json" --data <jsonBody>https://<YourManagerHostName>/signiant/spring/admin/v1.0/resourcecontrols					
                

List Resource Controls (Get)

List Request

 curl -X GET -H "username: <YourUsername>" -H "password: <YourPassword>" -H "ContentType: application/json" --data <jsonBody>https://<YourManagerHostName>/signiant/spring/admin/v1.0/listresourcecontrols					
                    
                

List Resource Controls Response

[  
{  
  "resourceControl":       {  
     "id": 132530,
     "resourceControlName": "exampleAgentResourceControl",
     "fields":          {  
        "status": true,
        "type": "Agent",
        "scope": "exampleagent.example.com",
        "concurrency": 1,
        "ceiling": 1048576,
        "floor": 1048576,
        "throttle": 1048576,
        "conflicts": false,
        "running": 0,
        "queued": 0,
        "precedence": 1,
        "criteria": "MX_CTE_UPLOAD MX_CTE_DOWNLOAD AGENT_TRANSFER_SOURCE AGENT_TRANSFER_TARGET AGENT_REMOTE_COMMAND"
     }
  }
},
    {  
  "resourceControl":       {  
     "id": 108813,
     "resourceControlName": "exampleJobResourceControl",
     "fields":          {  
        "status": false,
        "type": "Job",
        "scope": "MediaAggregator",
        "concurrency": 1,
        "ceiling": 1048576,
        "floor": 1048576,
        "throttle": 1048576,
        "conflicts": false,
        "running": 0,
        "queued": 0,
        "precedence": 0,
        "criteria": null
     }
  }
},
    {  
  "resourceControl":       {  
     "id": 108816,
     "resourceControlName": "exampleMediaExchangeTransferJobGroupResourceControl",
     "fields":          {  
        "status": false,
        "type": "Media Exchange Transfer Job Group",
        "scope": "MediaExchangeJteTransfers",
        "concurrency": 1,
        "ceiling": 1048576,
        "floor": 1048576,
        "throttle": 1048576,
        "conflicts": false,
        "running": 0,
        "queued": 0,
        "precedence": 1,
        "criteria": "MX_CTE_UPLOAD"
     }
  }
}
]

            
                

Activate Resource Controls (POST)

curl -X GET -H "username: <YourUsername>" -H "password: <YourPassword>" -H "ContentType: application/json" --data <jsonBody>https://<YourManagerHostName>/signiant/spring/admin/v1.0/activateresourcecontrols		

Activate Resource Controls Response

{
"editor": "admin",
"users":
[
{
"id": 108813,
"resourceControlName": "exampleJobResourceControl"
   }
]
}
                
                    

Deactivate Resource Controls (POST)

curl -X GET -H "username: <YourUsername>" -H "password: <YourPassword>" -H "ContentType: application/json" --data <jsonBody>https://<YourManagerHostName>/signiant/spring/admin/v1.0/deactivateresourcecontrols					
                

Deactivate Resource Controls Response

{
"editor": "admin",
"users":
[
{
"id": 108813,
"resourceControlName": "exampleJobResourceControl"
   }
]
}
                
                    

Delete Resource Controls by ID (DELETE)

 curl -X DELETE -H "username: <YourUsername>" -H "password: <YourPassword>" -H "ContentType: application/json" --data <jsonBody>https://<YourManagerHostName>/signiant/spring/admin/v1.0/resourcecontrols/<YourResouceControlID>			
                

Delete Resource Controls by Name (DELETE)

curl -X DELETE -H "username: <YourUsername>" -H "password: <YourPassword>" -H "ContentType: application/json" --data <jsonBody>https://<YourManagerHostName>/signiant/spring/admin/v1.0/resourcecontrols/<YourResouceControlName>					
                

Get Resource Controls by ID (GET)

curl -X GET -H "username: <YourUsername>" -H "password: <YourPassword>" -H "ContentType: application/json" --data <jsonBody>https://<YourManagerHostName>/signiant/spring/admin/v1.0/resourcecontrols/<YourResouceControlID>					
                

Get Resource Controls by Name (GET)

curl -X GET -H "username: <YourUsername>" -H "password: <YourPassword>" -H "ContentType: application/json" --data <jsonBody>https://<YourManagerHostName>/signiant/spring/admin/v1.0/resourcecontrols/<YourResouceControlName>					
                

Jobs

The following REST examples show how to move, create, edit, and list jobs.

Move Job in Queue by Job Name (GET)

curl -X GET -H "username: <YourUsername>" -H "password: <YourPassword>" -H "ContentType: application/json" --data <jsonBody>https://<YourManagerHostName>/signiant/spring/admin/v1.0/resourcecontrols/move/<JobName>/<JobGroup>/<value>					
                

Move Job in Queue by Job ID (GET)

curl -X GET -H "username: <YourUsername>" -H "password: <YourPassword>" -H "ContentType: application/json" --data <jsonBody>https://<YourManagerHostName>/signiant/spring/admin/v1.0/resourcecontrols/move/<JobID>/<JobGroup>/<value>					
                

Move Media Exchange Job Group or Agent Process in Queue (GET)

curl -X GET -H "username: <YourUsername>" -H "password: <YourPassword>" -H "ContentType: application/json" --data <jsonBody>https://<YourManagerHostName>/signiant/spring/admin/v1.0/resourcecontrols/move/<ConsumerID>/<value>	

Creating Jobs (POST)

curl -X POST -H "username: <YourUsername>" -H "password: <YourPassword>" -H "ContentType: application/json" --data <jsonBody>https://<YourManagerHostName>/signiant/spring/admin/v1.0/jobs					
                

Editing Jobs (PUT)

 curl -X PUT -H "username: <YourUsername>" -H "password: <YourPassword>" -H "ContentType: application/json" --data <jsonBody>https://<YourManagerHostName>/signiant/spring/admin/v1.0/jobs			
                

Get Job by Job Group Name (GET)

curl -X GET -H "username: <YourUsername>" -H "password: <YourPassword>" -H "ContentType: application/json" --data <jsonBody>https://<YourManagerHostName>/signiant/spring/admin/v1.0/<JobName>/<JobGroupName>					
                

Get Job by Job Group ID (GET)

curl -X GET -H "username: <YourUsername>" -H "password: <YourPassword>" -H "ContentType: application/json" --data <jsonBody>https://<YourManagerHostName>/signiant/spring/admin/v1.0/<JobName>/<JobGroupID>					
                

Get Job View by Name (GET)

curl -X GET -H "username: <YourUsername>" -H "password: <YourPassword>" -H "ContentType: application/json" --data <jsonBody>https://<YourManagerHostName>/signiant/spring/admin/v1.0/jobs/jobview/<JobViewName>					
                

Get Job View by ID (GET)

curl -X GET -H "username: <YourUsername>" -H "password: <YourPassword>" -H "ContentType: application/json" --data <jsonBody>https://<YourManagerHostName>/signiant/spring/admin/v1.0/jobs/jobview/<JobViewID>					
                

List all Jobs by Job Group Name (GET)

curl -X GET -H "username: <YourUsername>" -H "password: <YourPassword>" -H "ContentType: application/json" --data <jsonBody>https://<YourManagerHostName>/signiant/spring/admin/v1.0/listjobs/<JobGroupName>					
                

List all Jobs by Job Group ID (GET)

curl -X GET -H "username: <YourUsername>" -H "password: <YourPassword>" -H "ContentType: application/json" --data <jsonBody>https://<YourManagerHostName>/signiant/spring/admin/v1.0/listjobs/<JobGroupID>					
                

List Jobs Response

[  
   {  
  "job":       {  
     "id": 132022,
     "jobName": "MediaDistributor",
     "fields":          {  
        "jobGroupName": "firefox",
        "jobTemplateLibraryName": "Media_Mover_Workflows",
        "jobTemplateName": "MediaDistributor",
        "createdBy": "admin",
        "createdOn":             "2017-04-25T11:11:46            ", 
"            activeState": "IDLE",
        "scheduledState": "DORMANT",
        "lastExitCode": 0,
        "lastActiveStatusMessage": "",
        "activeFilename": "",
        "timeZone": "Europe/Belgrade"
     }
  }
},
{  
  "job":       {  
     "id": 132024,
     "jobName": "MediaDistributor3",
     "fields":          {  
        "jobGroupName": "firefox",
        "jobTemplateLibraryName": "Media_Mover_Workflows",
        "jobTemplateName": "MediaDistributor",
        "createdBy": "admin",
        "createdOn":             "2017-04-25T11:12:08            ", 
"            activeState": "IDLE",
        "scheduledState": "DORMANT",
        "lastExitCode": 0,
        "lastActiveStatusMessage": "",
        "activeFilename": "",
        "timeZone": "Europe/Belgrade"
     }
  }
}
]

                
                

Delete Jobs by Job Group ID (DELETE)

curl -X DELETE-H "username: <YourUsername>" -H "password: <YourPassword>" -H "ContentType: application/json" --data <jsonBody>https://<YourManagerHostName>/signiant/spring/admin/v1.0/<JobName>/<JobGroupID>					
                

Delete Jobs by Job Group Name (DELETE)

curl -X DELETE-H "username: <YourUsername>" -H "password: <YourPassword>" -H "ContentType: application/json" --data <jsonBody>https://<YourManagerHostName>/signiant/spring/admin/v1.0/<JobName>/<JobGroupName>					
                

Update or Add Job Variables (POST)

curl -X POST -H "username: <YourUsername>" -H "password: <YourPassword>" -H "ContentType: application/json" --data <jsonBody>https://<YourManagerHostName>/signiant/spring/admin/v1.0/jobs/variables/<JobName>/<JobGroup>				
                

Command For Job by Job Group Name (GET)

curl -X GET -H "username: <YourUsername>" -H "password: <YourPassword>" -H "ContentType: application/json" --data <jsonBody>https://<YourManagerHostName>/signiant/spring/admin/v1.0/jobs/command/<JobName>/<JobGroupName>/<Command>				
                

Command For Job by Job Group ID (GET)

curl -X GET -H "username: <YourUsername>" -H "password: <YourPassword>" -H "ContentType: application/json" --data <jsonBody>https://<YourManagerHostName>/signiant/spring/admin/v1.0/jobs/command/<JobName>/<JobGroupID>/<Command>					
                

Stats For Job by Job Group ID (POST)

curl -X POST -H "username: <YourUsername>" -H "password: <YourPassword>" -H "ContentType: application/json" --data <jsonBody>https://<YourManagerHostName>/signiant/spring/admin/v1.0/jobs/stats/<JobName>/<JobGroupID>					
                

Stats For Job by Job Group Name (POST)

curl -X POST -H "username: <YourUsername>" -H "password: <YourPassword>" -H "ContentType: application/json" --data <jsonBody>https://<YourManagerHostName>/signiant/spring/admin/v1.0/jobs/stats/<JobName>/<JobGroupName>					
                

Stats For Job and Run Number by Job Group Name (POST)

curl -X POST -H "username: <YourUsername>" -H "password: <YourPassword>" -H "ContentType: application/json" --data <jsonBody>https://<YourManagerHostName>/signiant/spring/admin/v1.0/jobs/stats/<JobName>/<JobGroupName>/<RunNumber>					
                

Stats For Job and Run Number by Job Group ID (POST)

curl -X POST -H "username: <YourUsername>" -H "password: <YourPassword>" -H "ContentType: application/json" --data <jsonBody>https://<YourManagerHostName>/signiant/spring/admin/v1.0/jobs/stats/<JobName>/<JobGroupID/<RunNumber>