MGSI Reference

Table of Contents

Structure index

Objects and return records

AgentModule DeviceProfile LoginInfo Role
AgentVersion Error Platform SchedulingDescriptor
Application GlobalResource Privilege Service
CreateWorkunitsFromDataSetsOptions GlobalResourceRequirement Program ServiceManager
Credential GuidNameCount ProgramModule User
Data IdNameCount ProgramModuleVersion UserGroup
DataId Job ProgramVersion UserOrGroupPrivilege
DataSet JobGuidAndId Resource UserProfile
Device JobStatus ResourceAvailable VersionInfo
DeviceCommand JobStep ResourceRequirement Workunit
DeviceGroup JobStepStatus Result

Array return records

AgentModuleArrayRange DeviceGroupArrayRange JobStepArrayRange ResultArrayRange
AgentVersionArrayRange DeviceProfileArrayRange PrivilegeArrayRange RoleArrayRange
ApplicationArrayRange ErrorArrayRange ProgramArrayRange UserArrayRange
CredentialArrayRange Exception ProgramModuleArrayRange UserGroupArrayRange
DataArrayRange ExceptionOrGuid ProgramModuleVersionArrayRange WorkunitArrayRange
DataSetArrayRange GlobalResourceArrayRange ProgramVersionArrayRange
DeviceArrayRange JobArrayRange ResourceArrayRange

Filters

AgentModuleFilter DeviceFilter JobStepFilter ResourceFilter
AgentVersionFilter DeviceGroupFilter PrivilegeFilter ResultFilter
ApplicationFilter DeviceProfileFilter ProgramFilter RoleFilter
CredentialFilter ErrorFilter ProgramModuleFilter UserFilter
DataFilter GlobalResourceFilter ProgramModuleVersionFilter UserGroupFilter
DataSetFilter JobFilter ProgramVersionFilter WorkunitFilter

Statistics

StatsDevice StatsDeviceGroup StatsDeviceWorkunit StatsJobDevices

Function index

accessCheck Check whether the calling User has a given Role.
accessCheckObject Check whether the current user has a particular Privilege for a specific object.
accessCheckObjects Check whether the current user has a particular Privilege for a specific set of objects.
addApplicationsToDeviceProfile Add multiple Application objects to a DeviceProfile.
addApplicationToDeviceProfile Add a Application object to a DeviceProfile.
addDeviceGroupsToJob Add to the list of DeviceGroups on which the Job can run.
addDeviceGroupToJob Add to the list of DeviceGroups on which the Job can run.
addPrivilegesToUserGroup Associate multiple Privilege objects with a UserGroup.
addPrivilegeToUserGroup Associate Privilege objects with a UserGroup.
addProgramsToApplication Add multiple Program objects to a Application.
addProgramsToDeviceProfile Add multiple Program objects to a DeviceProfile.
addProgramToApplication Add a Program object to a Application.
addProgramToDeviceProfile Add a Program object to a DeviceProfile.
addUserOrGroupsToObjectPrivilege Add multiple User objects to an object with a specific Privilege.
addUserOrGroupsToRole Add multiple User or UserGroup objects to a Role.
addUserOrGroupToObjectPrivilege Add a User or UserGroup object to an object with a specific Privilege.
addUserOrGroupToRole Add a User or UserGroup object to a Role.
addUsersToUserGroup Add multiple User objects to a UserGroup.
addUserToUserGroup Add a User object to a UserGroup.
cancelDeviceCommands Cancel any outstanding commands for a Device or DeviceGroup.
createAgentModule Create a new AgentModule object.
createAgentModules Create multiple new AgentModule objects.
createAgentVersion Create a new AgentVersion object.
createAgentVersions Create multiple new AgentVersion objects.
createApplication Create a new Application object.
createApplications Create multiple new Application objects.
createCredential Create a new Credential object.
createCredentials Create multiple new Credential objects.
createData Create a new Data object.
createDatas Create multiple new Data objects.
createDataSet Create a new DataSet object.
createDataSets Create multiple new DataSet objects.
createDeviceGroup Create a new DeviceGroup object.
createDeviceGroups Create multiple new DeviceGroup objects.
createDeviceProfile Create a new DeviceProfile object.
createDeviceProfiles Create multiple new DeviceProfile objects.
createGlobalResource Create a new GlobalResource object.
createGlobalResources Create multiple new GlobalResource objects.
createJob Create a new Job object.
createJob2 Create a new Job object. Similar to createJob but returns both the new job's "job_gid" and "id" members.
createJobs Create multiple new Job objects.
createJobStep Create a new JobStep object.
createJobSteps Create multiple new JobStep objects.
createJobStepsWithResourceRequirements Create multiple new JobStep objects.
createJobStepWithResourceRequirements Create a new JobStep object.
createProgram Create a new Program object.
createProgramModule Create a new ProgramModule object.
createProgramModules Create multiple new ProgramModule objects.
createProgramModuleVersion Create a new ProgramModuleVersion object.
createProgramModuleVersions Create multiple new ProgramModuleVersion objects.
createPrograms Create multiple new Program objects.
createProgramVersion Create a new ProgramVersion object.
createProgramVersions Create multiple new ProgramVersion objects.
createResource Create a new Resource object.
createResources Create multiple new Resource objects.
createResultQueue Create a new Result queue.
createSchedulingDescriptor Create a new SchedulingDescriptor object.
createSchedulingDescriptors Create multiple new SchedulingDescriptor objects.
createService Create a Service object.
createServiceManager Create a ServiceManager object.
createServices Create multiple new Service objects.
createUser Create a new User object.
createUserGroup Create a new UserGroup object.
createUserGroups Create multiple new UserGroup objects.
createUsers Create multiple new User objects.
createWorkunit Create a new Workunit object.
createWorkunits Create multiple new Workunit objects.
createWorkunitsFromDataSetsAsync Create Workunits from DataSets for a JobStep.
deleteAgentModule Delete a AgentModule object.
deleteAgentModules Delete multiple AgentModule objects.
deleteAgentVersion Delete a AgentVersion object.
deleteAgentVersions Delete multiple AgentVersion objects.
deleteApplication Delete a Application object.
deleteApplications Delete multiple Application objects.
deleteCredential Delete a Credential object.
deleteCredentials Delete multiple Credential objects.
deleteData Delete a Data object.
deleteDatas Delete multiple Data objects.
deleteDataSet Delete a DataSet object.
deleteDataSets Delete multiple DataSet objects.
deleteDevice Delete a Device object.
deleteDeviceGroup Delete a DeviceGroup object.
deleteDeviceGroups Delete multiple DeviceGroup objects.
deleteDeviceProfile Delete a DeviceProfile object.
deleteDeviceProfiles Delete multiple DeviceProfile objects.
deleteDevices Delete multiple Device objects.
deleteErrors Delete Error objects older than a specified time.
deleteGlobalResource Delete a GlobalResource object.
deleteGlobalResourceRequirement Delete a GlobalResourceRequirement object.
deleteGlobalResources Delete multiple GlobalResource objects.
deleteJob Delete a Job object.
deleteJobs Delete multiple Job objects.
deleteJobStep Delete a JobStep object.
deleteJobSteps Delete multiple JobStep objects.
deleteProgram Delete a Program object.
deleteProgramModule Delete a ProgramModule object.
deleteProgramModules Delete multiple ProgramModule objects.
deleteProgramModuleVersion Delete a ProgramModuleVersion object.
deleteProgramModuleVersions Delete multiple ProgramModuleVersion objects.
deletePrograms Delete multiple Program objects.
deleteProgramVersion Delete a ProgramVersion object.
deleteProgramVersions Delete multiple ProgramVersion objects.
deleteResource Delete a Resource object.
deleteResourceAvailable Delete a ResourceAvailable object.
deleteResourceRequirement Delete a ResourceRequirement object.
deleteResources Delete multiple Resource objects.
deleteResult Delete a Result object.
deleteResultQueue Delete a result queue.
deleteResults Delete multiple Result objects.
deleteSchedulingDescriptor Delete a SchedulingDescriptor object.
deleteSchedulingDescriptors Delete multiple SchedulingDescriptor objects.
deleteService Delete a Service object.
deleteServiceManager Delete a ServiceManager object.
deleteServices Delete multiple Service objects.
deleteUser Delete a User object.
deleteUserGroup Delete a UserGroup object.
deleteUserGroups Delete multiple UserGroup objects.
deleteUsers Delete multiple User objects.
deleteWorkunit Delete a Workunit object.
deleteWorkunits Delete multiple Workunit objects.
getAgentModule Return a specific AgentModule object.
getAgentModuleByAgentVersionPlatform Returns an AgentModule object for a given AgentVersion and Platform.
getAgentModules Return a filtered list of AgentModule objects.
getAgentModulesByGuid Return specific AgentModule objects.
getAgentVersion Return a specific AgentVersion object.
getAgentVersionByName Return a specific AgentVersion object.
getAgentVersions Return a filtered list of AgentVersion objects.
getAgentVersionsByGuid Return specific AgentVersion objects.
getAllAgentModules Return a list of all AgentModule objects.
getAllAgentVersions Return a list of all AgentVersion objects.
getAllApplications Return a list of all Application objects.
getAllCredentials Return a list of all Credential objects.
getAllDataSets Return a list of all DataSet objects.
getAllDeviceGroups Return a list of all DeviceGroup objects.
getAllDeviceProfiles Return a list of all DeviceProfile objects.
getAllDevices Return a list of all Device objects.
getAllGlobalResourceRequirements Return a list of all GlobalResourceRequirement objects.
getAllGlobalResources Return all GlobalResource objects.
getAllJobs Return a list of all Job objects.
getAllPlatforms Return a list of all Platform objects.
getAllPrivileges Return a list of all Privilege objects.
getAllPrograms Return a list of all Program objects.
getAllResourceAvailables Return a list of all ResourceAvailable objects.
getAllResourceRequirements Return a list of all ResourceRequirement objects.
getAllResources Return a list of all Resource objects.
getAllRoles Return a list of all Role objects.
getAllSchedulingDescriptors Return a list of all SchedulingDescriptor objects.
getAllServiceManagers Return a list of all ServiceManager objects.
getAllServices Return a list of all Service objects.
getAllUserGroups Return a list of all UserGroup objects.
getAllUsers Return a list of all User objects.
getApplication Return a specific Application object.
getApplicationByName Return a specific Application object by name.
getApplications Return a filtered list of Application objects.
getApplicationsByDeviceProfile Return Application objects associated with a DeviceProfile.
getApplicationsByGuid Return specific Application objects.
getApplicationsByProgram Return Application objects associated with a Program.
getCountDeviceGroupsByAgentVersion Return the number of DeviceGroups in each AgentVersion.
getCountDevicesByDeviceGroup Return the number of Devices in each DeviceGroup.
getCountDevicesByDeviceProfile Return the number of Devices in each DeviceProfile for a specific DeviceGroup.
getCountUserGroupsByRole Return the number of UserGroups in each Role.
getCountUsersByRole Return the number of Users directly in each Role.
getCountUsersByUserGroup Return the number of Users in each UserGroup.
getCredential Return a specific Credential object.
getCredentials Return a filtered list of Credential objects.
getData Return a specific Data object.
getDatas Return a filtered list of Data objects.
getDatasByDataSet Return Data objects associated with a DataSet.
getDatasById Return specific Data objects.
getDatasByWorkunit Return Data objects associated with a Workunit.
getDataSet Return a specific DataSet object.
getDataSetByName Return a specific DataSet object by name.
getDataSets Return a filtered list of DataSet objects.
getDataSetsByGuid Return specific DataSet objects.
getDataSetsByJobStepWorkunits Return the DataSet objects associated with automatic Workunit creation for a JobStep via createWorkunitsFromDataSetsAsync.
getDevice Return a specific Device object.
getDeviceCommands Return the pending DeviceCommands for a given Device or DeviceGroup.
getDeviceGroup Return a specific DeviceGroup object.
getDeviceGroupByName Return a specific DeviceGroup object by name.
getDeviceGroups Return a filtered list of DeviceGroup objects.
getDeviceGroupsByGuid Return specific DeviceGroup objects.
getDeviceGroupsByJob Return DeviceGroup objects associated with a Job.
getDeviceProfile Return a specific DeviceProfile object.
getDeviceProfiles Return a filtered list of DeviceProfile objects.
getDeviceProfilesByDeviceGroup Return DeviceProfile objects associated with a DeviceGroup.
getDeviceProfilesByGuid Return specific DeviceProfile objects.
getDevices Return a filtered list of Device objects.
getDevicesByDeviceGroup Return Device objects associated with a DeviceGroup.
getDevicesByDeviceProfile Return Device objects associated with a DeviceProfile.
getDevicesByGuid Return specific Device objects.
getDevicesByWorkunit Return the Devices that are currently working on a given Workunit.
getErrors Return a filtered list of Error objects.
getGlobalResource Return a specific GlobalResource object.
getGlobalResourceByName Return a specific GlobalResource object by its name.
getGlobalResourceRequirementsByGlobalResource Return GlobalResourceRequirement objects associated with a GlobalResource.
getGlobalResourceRequirementsByProgramModule Return GlobalResourceRequirement objects associated with a ProgramModule.
getGlobalResources Return a filtered list of GlobalResource objects.
getJob Return a specific Job object.
getJobById Return a specific Job object.
getJobs Return a filtered list of Job objects.
getJobsByApplication Return Job objects associated with a Application.
getJobsByDeviceGroup Return Job objects associated with a DeviceGroup.
getJobsByGuid Return specific Job objects.
getJobStatus Return a JobStatus object describing the state of a Job.
getJobStatusesByGuid Return specific JobStatus objects.
getJobStep Return a specific JobStep object.
getJobSteps Return a filtered list of JobStep objects.
getJobStepsByGuid Return specific JobStep objects.
getJobStepsByJob Return JobStep objects associated with a Job.
getJobStepsByProgram Return JobStep objects associated with a Program.
getJobStepStatus Return a JobStepStatus object describing the state of a JobStep.
getPlatform Return a specific Platform object.
getPlatformByName Return a specific Platform object by name.
getPlatformsById Return specific Platform objects.
getPrivilege Return a specific Privilege object.
getPrivilegeByName Return a specific Privilege object by name.
getPrivileges Return a filtered list of Privilege objects.
getPrivilegesByGuid Return specific Privilege objects.
getPrivilegesByUserGroup Return Privilege objects associated with a UserGroup.
getPrivilegesByUserOrGroupObject Return Privilege objects associated with a User or UserGroup and an object.
getProgram Return a specific Program object.
getProgramByName Return a specific Program object by name.
getProgramModule Return a specific ProgramModule object.
getProgramModules Return a filtered list of ProgramModule objects.
getProgramModulesByGuid Return specific ProgramModule objects.
getProgramModulesByProgram Return ProgramModule objects associated with a Program.
getProgramModulesByProgramVersion Return ProgramModule objects associated with a ProgramVersion.
getProgramModuleVersion Return a specific ProgramModuleVersion object.
getProgramModuleVersions Return a filtered list of ProgramModuleVersion objects.
getProgramModuleVersionsByGuid Return specific ProgramModuleVersion objects.
getProgramModuleVersionsByJobStep Return ProgramModuleVersion objects associated with a JobStep.
getProgramModuleVersionsByProgramModule Return ProgramModuleVersion objects associated with a ProgramModule.
getPrograms Return a filtered list of Program objects.
getProgramsByApplication Return Program objects associated with a Application.
getProgramsByDeviceProfile Return Program objects associated with a DeviceProfile.
getProgramsByGuid Return specific Program objects.
getProgramVersion Return a specific ProgramVersion object.
getProgramVersions Return a filtered list of ProgramVersion objects.
getProgramVersionsByGuid Return specific ProgramVersion objects.
getProgramVersionsByProgram Return ProgramVersion objects associated with a Program.
getResource Return a specific Resource object.
getResourceAvailablesByDevice Return ResourceAvailable objects associated with a Device.
getResourceAvailablesByResource Return ResourceAvailable objects associated with a Resource.
getResourceByName Return a specific Resource object by name.
getResourceRequirementsByJobStep Return ResourceRequirement objects associated with a JobStep.
getResourceRequirementsByProgramModule Return ResourceRequirement objects associated with a ProgramModule.
getResourceRequirementsByResource Return ResourceRequirement objects associated with a Resource.
getResources Return a filtered list of Resource objects.
getResourcesByGuid Return specific Resource objects.
getResult Return a specific Result object.
getResults Return a filtered list of Result objects.
getResultsById Return specific Result objects.
getResultsByJobStep Return Result objects for a specific JobStep.
getResultsByResultQueue Get Results from a result queue.
getResultsByWorkunit Return Result objects for a specific Workunit.
getRole Return a specific Role object.
getRoleByName Return a specific Role object by name.
getRoles Return a filtered list of Role objects.
getRolesByGuid Return specific Role objects.
getRolesByUserOrGroup Return Role objects associated with a User or UserGroup.
getSchedulingDescriptor Return a specific SchedulingDescriptor object.
getSchedulingDescriptorsByDeviceGroup Return the SchedulingDescriptor objects for a specific DeviceGroup.
getSchedulingDescriptorUserGroupsByDeviceGroup Return the SchedulingDescriptor objects for a specific DeviceGroup, but only those that apply specifically to UserGroups.
getSchedulingDescriptorUsersByDeviceGroup Return the SchedulingDescriptor objects for a specific DeviceGroup, but only those that apply specifically to Users.
getServerTime Return the current time according to the MP server.
getService Return a specific Service object.
getServiceManager Return a specific ServiceManager object.
getServiceManagerByName Return a specific ServiceManager object by name.
getServicesByServiceManager Return Service objects associated with a ServiceManager.
getStatsAllDeviceGroups Return statistics for all DeviceGroups.
getStatsAllJobStates Return statistics on Job states.
getStatsDevice Return statistics for a specific Device.
getStatsDeviceGroup Return statistics for a specific DeviceGroup.
getStatsDevicesByDeviceGroup Return statistics for Devices in a DeviceGroup.
getStatsJobDevices Return historical statistics about all Devices that have completed Workunits for a specific Job.
getTokenInfo Return information about the given authentication token.
getUser Return a specific User object.
getUserByName Return a specific User object by name.
getUserGroup Return a specific UserGroup object.
getUserGroupByName Return a specific UserGroup object by name.
getUserGroupPrivilegesByObject Return a list of UserOrGroupPrivileges for a given object, including only the UserGroups.
getUserGroups Return a filtered list of UserGroup objects.
getUserGroupsByGuid Return specific UserGroup objects.
getUserGroupsByObjectPrivilege Return UserGroup objects associated with an object and Privilege.
getUserGroupsByRole Return UserGroup objects associated with a Role.
getUserGroupsByUser Return UserGroup objects associated with a User.
getUserOrGroupPrivilegesByObject Return a list of UserOrGroupPrivileges for a given object.
getUserOrGroupsByObjectPrivilege Return User or UserGroup ids associated with an object and Privilege.
getUserOrGroupsByRole Return User or UserGroup ids associated with a Role.
getUserPrivilegesByObject Return a list of UserOrGroupPrivileges for a given object, including only the Users.
getUserProfile Return the UserProfile part of a User object.
getUsers Return a filtered list of User objects.
getUsersByGuid Return specific User objects.
getUsersByObjectPrivilege Return User objects associated with an object and Privilege.
getUsersByRole Return User objects directly associated with a Role.
getUsersByUserGroup Return User objects associated with a UserGroup.
getVersionInfo Return a VersionInfo object containing platform version information.
getWorkunit Return a specific Workunit object.
getWorkunits Return a filtered list of Workunit objects.
getWorkunitsByGuid Return specific Workunit objects.
getWorkunitsByJobStep Return Workunit objects associated with a JobStep.
getWorkunitStatesByJobStep Return a list of all Workunit states in a JobStep, along with the number of Workunits in each state.
getWorkunitsWithDatasByGuid Return specific Workunit objects, with their associated DataId references.
login Log in to the MP Server with particular credentials.
login2 Log in to the MP Server with particular credentials, returning extended user information.
moveDevices Move Devices from one DeviceGroup to another.
queryServiceManager Update the status for a ServiceManager.
queryServicesByServiceManager Get a list of changed Service objects since a specific time.
removeApplicationFromDeviceProfile Remove a Application object from a DeviceProfile.
removeApplicationsFromDeviceProfile Remove multiple Application objects from a DeviceProfile.
removeDeviceGroupFromJob Remove from the list of DeviceGroups on which the Job can run. A Job will run on all DeviceGroups if this list is empty.
removeDeviceGroupsFromJob Remove from the list of DeviceGroups on which the Job can run.
removePrivilegeFromUserGroup Dissociate Privilege objects from a UserGroup.
removePrivilegesFromUserGroup Dissociate multiple Privilege objects from a UserGroup.
removeProgramFromApplication Remove a Program object from a Application.
removeProgramFromDeviceProfile Remove a Program object from a DeviceProfile.
removeProgramsFromApplication Remove multiple Program objects from a Application.
removeProgramsFromDeviceProfile Remove multiple Program objects from a DeviceProfile.
removeResultsFromResultQueue Remove Results from a result queue.
removeUserFromUserGroup Remove a User object from a UserGroup.
removeUserOrGroupFromObjectPrivilege Remove a User or UserGroup object from an object for a specific Privilege.
removeUserOrGroupFromRole Remove a User or UserGroup object from a Role.
removeUserOrGroupsFromObjectPrivilege Remove multiple User or UserGroup objects from an object for a specific Privilege.
removeUserOrGroupsFromRole Remove multiple User or UserGroup objects from a Role.
removeUsersFromUserGroup Remove multiple User objects from a UserGroup.
sendDeviceCommand Send a command to a Device or DeviceGroup.
setApplicationPrograms Set the Programs associated with an Application.
setDeviceProfileApplications Set the Applications associated with a DeviceProfile.
setDeviceProfilePrograms Set the Programs associated with a DeviceProfile.
setGlobalResourceRequirement Set a GlobalResourceRequirement object.
setGlobalResourceRequirements Set several GlobalResourceRequirement objects.
setJobDeviceGroups Set the DeviceGroups associated with a Job.
setObjectPrivilegeUserAndGroups Set the Users and UserGroups associated with a specific object and Privilege.
setObjectUserOrGroupPrivileges Set the UserOrGroupPrivileges associated with a specific object.
setResourceAvailable Set a ResourceAvailable object.
setResourceAvailables Set multiple ResourceAvailable objects.
setResourceRequirement Set a ResourceRequirement object.
setResourceRequirements Set multiple ResourceRequirement objects.
setRoleUserAndGroups Set the Users and UserGroups associated with a Role.
setUserGroupPrivileges Set the Privileges associated with a UserGroup.
setUserGroupUsers Set the Users associated with a UserGroup.
setUserOrGroupRoles Set the Roles associated with a User or UserGroup.
setUserUserGroups Set the UserGroups associated with a User.
updateApplication Update a specific Application object.
updateApplications Update multiple Application objects.
updateCredential Update a specific Credential object.
updateCredentials Update multiple Credential objects.
updateDataSet Update a specific DataSet object.
updateDataSets Update multiple DataSet objects.
updateDevice Update a specific Device object.
updateDeviceGroup Update a specific DeviceGroup object.
updateDeviceGroupRestricted Update a specific DeviceGroup object, only the 'device_group_name', 'default_device_profile_gid', and 'description' fields.
updateDeviceGroups Update multiple DeviceGroup objects.
updateDeviceProfile Update a specific DeviceProfile object.
updateDeviceProfiles Update multiple DeviceProfile objects.
updateGlobalResource Update a specific GlobalResource object.
updateGlobalResources Update specific GlobalResource objects.
updateJob Update a specific Job object.
updateJobs Update multiple Job objects.
updateJobStep Update a specific JobStep object.
updateJobSteps Update multiple JobStep objects.
updateProgram Update a specific Program object.
updateProgramModule Update a specific ProgramModule object.
updateProgramModules Update multiple ProgramModule objects.
updatePrograms Update multiple Program objects.
updateProgramVersion Update a specific ProgramVersion object.
updateProgramVersions Update multiple ProgramVersion objects.
updateSchedulingDescriptor Update a specific SchedulingDescriptor object.
updateSchedulingDescriptors Update multiple SchedulingDescriptor objects.
updateService Update a specific Service object.
updateServiceManager Update a specific ServiceManager object.
updateServiceStatus Updates the status_id field of a Service object. This should only be used by a Service or Service Manager, to inform users as to its current state, such as started or stopped.
updateUser Update a specific User object.
updateUserGroup Update a specific UserGroup object.
updateUserGroups Update multiple UserGroup objects.
updateUserPassword Update the password for a specific User.
updateUserProfile Update the UserProfile part of a User object.
updateUsers Update multiple User objects.
updateWorkunitState Update the 'state_id' field of a specific Workunit.
updateWorkunitStates Update the 'state_id' field of multiple Workunit objects.

Exception Error Codes

The following values are returned for the error code in the exception record if an error occurs.

UDMGSI_ERROR_AUTHENTICATION=-1// The server was unable to validate the user account credentials.
UDMGSI_ERROR_AUTHORIZATION=-2// The authenticated user does not have permission to perform the requested operation.
UDMGSI_ERROR_MEMORY=-3// The server ran out of memory processing the request.
UDMGSI_ERROR_DATABASE=-4// The server encountered a database error processing the request.
UDMGSI_ERROR_DATA=-5// The server detected an error in the data passed to the function.
UDMGSI_ERROR_FILE=-6// The server encountered a file system error while processing the request.
UDMGSI_ERROR_STATE=-7// The requested operation cannot be performed due to the state the system is currently in.
UDMGSI_ERROR_VERSION=-8// The client library protocol version does not match the server protocol version.

Structures

Structure members marked (no-create) are ignored when the structure is passed to a create function.

Structure members marked (no-update) are ignored when the structure is passed to an update function.

Structure members marked (no-get) are to be ignored when the structure is returned from a function. Such a member will be returned blank or as a default value.

Structure members marked (required) are required to be present when the structure is passed to the function that adds such structures into the database.

The last_modified field denotes the last time the given structure was modified. A structure is considered modified whenever a user-updateable field is changed. Fields in the structure that can only be changed by the server (no-update fields) will not increment last_modified upon being changed. The last_modified field is ignored on create. On update, the last_modified field specified by the user must match the last_modified field of the record in the system. This helps to ensure that users do not accidentally overwrite changes to a structure.

The (max length) annotation indicates the maximum number of bytes permitted in the field (when the data is encoded in UTF-8). When using ASCII characters, the number of bytes is the same as the number of characters. When using non-ASCII Unicode characters, the number of bytes needed by the UTF-8 encoding of the string is greater than the number of characters. Therefore, the maximum number of characters permitted in string type fields, when using non-ASCII Unicode characters, will be less than the given number.


AgentModule

The AgentModule object describes an Agent executable for a given platform. The AgentModule belongs to an AgentVersion.

begin struct
    guidagent_module_gid // The primary unique identifier of this AgentModule object. (no-create)
    guidagent_version_gid // The version to which this object applies. (no-update)
// Validation: agent_version_gid must not be the NULL guid.
    integerplatform_id // The Platform identifier to which this object applies. (no-update)
    sha1module_hash // The name of the file. (required)
// Validation: module_hash must not be the NULL SHA1.
    longmodule_size // The size of the module. (required)
// Validation: module_size must be positive.
    dateTimecreation_time // The time this AgentModule was created. (no-create) (no-update)
end struct

See also: createAgentModule, createAgentModules, deleteAgentModule, deleteAgentModules, getAgentModule, getAgentModuleByAgentVersionPlatform, getAgentModules, getAgentModulesByGuid, getAllAgentModules


AgentModuleArrayRange

The AgentModuleArrayRange object contains an array of AgentModule objects, along with a "total" field.

begin struct
    AgentModule[]records // An array of AgentModule objects. The range of objects in the array is independent of the value in the "total" field.
    integertotal // The total number of objects that matched the criteria of the returning function. This number is calculated prior to applying the caller's range specification.
end struct

See also: getAgentModules


AgentModuleFilter

The AgentModuleFilter object is used to filter requests for AgentModules.

begin struct
    guid[]agent_module_gid_match // If this vector is nonempty, only records with agent_module_gid in this set are selected.
    guid[]agent_module_gid_not_match // Only records with agent_module_gid not in this set are selected.
    guid[]agent_version_gid_match // If this vector is nonempty, only records with agent_version_gid in this set are selected.
    guid[]agent_version_gid_not_match // Only records with agent_version_gid not in this set are selected.
    stringplatform_id_test // Indicates how the platform_id_min and platform_id_max filter fields are checked (see ADG).
    integerplatform_id_min // The value that is matched against the platform_id value when enabled.
    integerplatform_id_max // The value that is matched against the platform_id value when enabled.
    integer[]platform_id_in_set // If this vector is nonempty, only records with platform_id in this set are selected.
    integer[]platform_id_notin_set // Only records with platform_id not in this set are selected.
    sha1[]module_hash_match // If this vector is nonempty, only records with module_hash in this set are selected.
    stringmodule_size_test // Indicates how the module_size_min and module_size_max filter fields are checked (see ADG).
    longmodule_size_min // The value that is matched against the module_size value when enabled.
    longmodule_size_max // The value that is matched against the module_size value when enabled.
    long[]module_size_in_set // If this vector is nonempty, only records with module_size in this set are selected.
    long[]module_size_notin_set // Only records with module_size not in this set are selected.
    stringcreation_time_test // Indicates how the creation_time_start and creation_time_end filter fields are checked (see ADG).
    dateTimecreation_time_start // The value that is matched against the creation_time value when enabled.
    dateTimecreation_time_end // The value that is matched against the creation_time value when enabled.
end struct

See also: getAgentModules


AgentVersion

The AgentVersion object identifies a version of the Agent, and serves as a container for AgentModules.

begin struct
    guidagent_version_gid // The primary unique identifier of this AgentVersion object. (no-create)
    stringagent_version_name // The unique agent version descriptor. (max length 36)
// Validation: agent_version_name must not have leading spaces.
// Validation: agent_version_name must not have trailing spaces.
// Validation: agent_version_name must not be empty.
    dateTimecreation_time // The time this AgentVersion was created. (no-create) (no-update)
end struct

See also: createAgentVersion, createAgentVersions, deleteAgentVersion, deleteAgentVersions, getAgentModuleByAgentVersionPlatform, getAgentVersion, getAgentVersionByName, getAgentVersions, getAgentVersionsByGuid, getAllAgentVersions, getCountDeviceGroupsByAgentVersion


AgentVersionArrayRange

The AgentVersionArrayRange object contains an array of AgentVersion objects, along with a "total" field.

begin struct
    AgentVersion[]records // An array of AgentVersion objects. The range of objects in the array is independent of the value in the "total" field.
    integertotal // The total number of objects that matched the criteria of the returning function. This number is calculated prior to applying the caller's range specification.
end struct

See also: getAgentVersions


AgentVersionFilter

The AgentVersionFilter object is used to filter requests for AgentVersions.

begin struct
    guid[]agent_version_gid_match // If this vector is nonempty, only records with agent_version_gid in this set are selected.
    guid[]agent_version_gid_not_match // Only records with agent_version_gid not in this set are selected.
    stringagent_version_name_regex // If this agent_version_name is nonempty, only records with agent_version_name matching this regular expression are selected.
    stringcreation_time_test // Indicates how the creation_time_start and creation_time_end filter fields are checked (see ADG).
    dateTimecreation_time_start // The value that is matched against the creation_time value when enabled.
    dateTimecreation_time_end // The value that is matched against the creation_time value when enabled.
end struct

See also: getAgentVersions


Application

The Application object describes the usage of Programs. Programs associated with an Application may be used within a Job for the Application.

begin struct
    guidapplication_gid // The primary unique identifier of this object. (no-create)
    stringapplication_name // The unique name of the Application as displayed on the console. (max length 36)
// Validation: application_name must not have leading spaces.
// Validation: application_name must not have trailing spaces.
// Validation: application_name must not be empty.
    stringpublic_name // The name of the Application as displayed on the Agent. (max length 36)
    integerstate_id // The state of this Application.
// Valid states:
//    0 (Disabled): No new jobs accepted, no jobs will run
//    1 (Enabled, Open): New jobs accepted, jobs will run
//    2 (Suspended, Open): New jobs accepted, but no jobs will run
//    3 (Enabled, Closed): No new jobs accepted, existing jobs continue running
//    9 (Pending Delete): Delete as soon as no more jobs exist, no new jobs accepted, existing jobs continue running
    stringdescription // A free-form textual description of this Application. (max length 500)
    stringannotation // Reserved for custom use by application developers. (max length 1000)
    dateTimecreation_time // The time this Application was created. (no-create) (no-update)
    dateTimelast_modified // The time this record was last modified. See struct info.
end struct

See also: addApplicationsToDeviceProfile, addApplicationToDeviceProfile, addProgramsToApplication, addProgramToApplication, createApplication, createApplications, deleteApplication, deleteApplications, getAllApplications, getApplication, getApplicationByName, getApplications, getApplicationsByDeviceProfile, getApplicationsByGuid, getApplicationsByProgram, getJobsByApplication, getProgramsByApplication, removeApplicationFromDeviceProfile, removeApplicationsFromDeviceProfile, removeProgramFromApplication, removeProgramsFromApplication, setApplicationPrograms, setDeviceProfileApplications, updateApplication, updateApplications


ApplicationArrayRange

The ApplicationArrayRange object contains an array of Application objects, along with a "total" field.

begin struct
    Application[]records // An array of Application objects. The range of objects in the array is independent of the value in the "total" field.
    integertotal // The total number of objects that matched the criteria of the returning function. This number is calculated prior to applying the caller's range specification.
end struct

See also: getApplications


ApplicationFilter

The ApplicationFilter object is used to filter requests for Applications.

begin struct
    guid[]application_gid_match // If this vector is nonempty, only records with application_gid in this set are selected.
    guid[]application_gid_not_match // Only records with application_gid not in this set are selected.
    stringapplication_name_regex // If this application_name is nonempty, only records with application_name matching this regular expression are selected.
    stringpublic_name_regex // If this public_name is nonempty, only records with public_name matching this regular expression are selected.
    stringstate_id_test // Indicates how the state_id_min and state_id_max filter fields are checked (see ADG).
    integerstate_id_min // The value that is matched against the state_id value when enabled.
    integerstate_id_max // The value that is matched against the state_id value when enabled.
    integer[]state_id_in_set // If this vector is nonempty, only records with state_id in this set are selected.
    integer[]state_id_notin_set // Only records with state_id not in this set are selected.
    stringdescription_regex // If this description is nonempty, only records with description matching this regular expression are selected.
    stringannotation_regex // If this annotation is nonempty, only records with annotation matching this regular expression are selected.
    stringcreation_time_test // Indicates how the creation_time_start and creation_time_end filter fields are checked (see ADG).
    dateTimecreation_time_start // The value that is matched against the creation_time value when enabled.
    dateTimecreation_time_end // The value that is matched against the creation_time value when enabled.
    stringlast_modified_test // Indicates how the last_modified_start and last_modified_end filter fields are checked (see ADG).
    dateTimelast_modified_start // The value that is matched against the last_modified value when enabled.
    dateTimelast_modified_end // The value that is matched against the last_modified value when enabled.
end struct

See also: getApplications


CreateWorkunitsFromDataSetsOptions

Options for use with createWorkunitsFromDataSetsAsync. At this time, this is empty and is reserved for future expansion.

begin struct
    integercreation_mode // Select the mode for workunit creation. This parameter must be zero.
end struct

See also: createWorkunitsFromDataSetsAsync


Credential

The Credential object describes the identity that the MP Agent should switch to before running a Workunit.

begin struct
    guidcredential_gid // The primary unique identifier of this object. (no-create)
    guiddevice_group_gid // The identifier of the DeviceGroup where this credential will apply. (no-update)
// Validation: device_group_gid must not be the NULL guid.
    guiduser_gid // The user_gid of the Job submitter to whom this credential will Apply. (no-update)
// Validation: user_gid must not be the NULL guid.
    stringunix_username // The username or uid that the MP Agent will switch to if the Device is a Linux or UNIX platform. (max length 200)
// Validation: unix_username must not be empty.
    dateTimecreation_time // The time this Credential was created. (no-create) (no-update)
    dateTimelast_modified // The time this record was last modified. See struct info.
end struct

See also: createCredential, createCredentials, deleteCredential, deleteCredentials, getAllCredentials, getCredential, getCredentials, updateCredential, updateCredentials


CredentialArrayRange

The CredentialArrayRange object contains an array of Credential objects, along with a "total" field.

begin struct
    Credential[]records // An array of Credential objects. The range of objects in the array is independent of the value in the "total" field.
    integertotal // The total number of objects that matched the criteria of the returning function. This number is calculated prior to applying the caller's range specification.
end struct

See also: getCredentials


CredentialFilter

The CredentialFilter object is used to filter requests for Credentials.

begin struct
    guid[]credential_gid_match // If this vector is nonempty, only records with credential_gid in this set are selected.
    guid[]credential_gid_not_match // Only records with credential_gid not in this set are selected.
    guid[]device_group_gid_match // If this vector is nonempty, only records with device_group_gid in this set are selected.
    guid[]device_group_gid_not_match // Only records with device_group_gid not in this set are selected.
    guid[]user_gid_match // If this vector is nonempty, only records with user_gid in this set are selected.
    guid[]user_gid_not_match // Only records with user_gid not in this set are selected.
    stringunix_username_regex // If this unix_username is nonempty, only records with unix_username matching this regular expression are selected.
end struct

See also: getCredentials


Data

The Data object describes a file piece of a DataSet. It is uniquely identified within the DataSet by the index field, and can optionally contain URLs.

begin struct
    guiddata_set_gid // The identifier of the DataSet to which this Data object applies. (required)
// Validation: data_set_gid must not be the NULL guid.
    integerindex // The index field is used as the unique identifier of a Data within its DataSet. Upon creation of the Data, it can be set to any integer not already in use inside the DataSet specified by data_set_gid. (required)
    sha1file_hash // The SHA1 file hash of this Data file. (required)
// Validation: file_hash must not be the NULL SHA1.
    longfile_size // The size of the Data file, in bytes. (required)
// Validation: file_size must be positive.
    string[]urls // The URLs of the Data file. If no URLs are specified, the Data file can only be retrieved via the File Service. Any specified URL for a Data must be a string of non-zero length with a maximum of 255 characters. The following protocols are supported:
  • http:// - standard unencrypted HTTP
  • https:// - SSL encrypted HTTP (any SSL certificate is permitted)
  • ftp:// - standard unencrypted FTP. username and password may be specified as ftp://username:password@hostname/path/path/filename, otherwise anonymous access may be used with ftp://hostname/path/path/filename
  • file:// - may be Windows file shares, Windows DFS, UNIX NFS mount point, or other local disk file.
    • Windows file share (only accessible by Windows Agents). file:////servername/sharename/path/filename
    • Windows DFS share (only accessible by Win2k/WinXP Agents). file:////dfsname/sharename/path/filename
    • UNIX NFS mount point (only accessible by UNIX agents with the mount point already in /etc/fstab and already mounted). file:///mountdir/path/filename, file:///rhome/username/filename
    • Other local file (dependent on file system layout of the device's operating system), file:///c:/windows/win.ini, file:///usr/local/data/genome.db
end struct

See also: createData, createDatas, deleteData, getData, getDatas, getDatasByDataSet, getDatasById, getDatasByWorkunit


DataArrayRange

The DataArrayRange object contains an array of Data objects, along with a "total" field.

begin struct
    Data[]records // An array of Data objects. The range of objects in the array is independent of the value in the "total" field.
    integertotal // The total number of objects that matched the criteria of the returning function. This number is calculated prior to applying the caller's range specification.
end struct

See also: getDatas


DataFilter

The DataFilter object is used to filter requests for Datas.

begin struct
    guid[]data_set_gid_match // If this vector is nonempty, only records with data_set_gid in this set are selected.
    guid[]data_set_gid_not_match // Only records with data_set_gid not in this set are selected.
    stringindex_test // Indicates how the index_min and index_max filter fields are checked (see ADG).
    integerindex_min // The value that is matched against the index value when enabled.
    integerindex_max // The value that is matched against the index value when enabled.
    integer[]index_in_set // If this vector is nonempty, only records with index in this set are selected.
    integer[]index_notin_set // Only records with index not in this set are selected.
    sha1[]file_hash_match // If this vector is nonempty, only records with file_hash in this set are selected.
    stringfile_size_test // Indicates how the file_size_min and file_size_max filter fields are checked (see ADG).
    longfile_size_min // The value that is matched against the file_size value when enabled.
    longfile_size_max // The value that is matched against the file_size value when enabled.
    long[]file_size_in_set // If this vector is nonempty, only records with file_size in this set are selected.
    long[]file_size_notin_set // Only records with file_size not in this set are selected.
end struct

See also: getDatas


DataId

The DataId object is an abbreviated version of the Data object. This object is used in functions where the other Data fields are not required.

begin struct
    guiddata_set_gid // The identifier of the DataSet to which this Data object applies. (required)
    integerindex // The index field is used as the unique identifier of a Data within its DataSet. Upon creation of the Data, it can be set to any integer not already in use inside the DataSet specified by data_set_gid. (required)
end struct

See also: createWorkunit, createWorkunits, deleteData, deleteDatas, getWorkunit, getWorkunits, getWorkunitsByGuid, getWorkunitsByJobStep, getWorkunitsWithDatasByGuid


DataSet

The DataSet object defines a set of Data files along with descriptive information. The DataSet can belong to a Job, or to a JobStep, or can belong to neither (thereby being global).

begin struct
    guiddata_set_gid // The primary unique identifier of this object. (no-create)
    stringdata_set_name // The unique name of this object. (max length 200)
// Validation: data_set_name must not have leading spaces.
// Validation: data_set_name must not have trailing spaces.
// Validation: data_set_name must not be empty.
    integerpersistency // This is a hint to the MP as to how likely it is for a Device to need to reuse this data. If persistency is unspecified or 0, a Device will make no attempt to keep this Data locally on disk after using it. For values above 0, Devices will make a greater attempt to keep the Data on disk, the higher the persistency value is.
// Validation: persistency must be between 0 and 99 inclusive.
    booleanurl_first // URL-first file downloading. If set to true, then when a Device attempts to download any Datas in this DataSet which contain a URL, the Device will first attempt to download from the URL, and look to the File Service secondarily.
    guidjob_gid // The optional Job to which this DataSet belongs. Either job_gid or job_step_gid may be specified, but not both. If set, the DataSet is deleted when the Job is deleted. (no-update)
    guidjob_step_gid // The optional JobStep to which this DataSet belongs. Either job_gid or job_step_gid may be specified, but not both. If set, the DataSet is deleted when the JobStep is deleted. (no-update)
    stringannotation // A free-form field which describes this DataSet. (max length 3200)
    dateTimecreation_time // The time this DataSet was created. (no-create) (no-update)
    dateTimelast_modified // The time this record was last modified. See struct info.
end struct

See also: createDataSet, createDataSets, createWorkunitsFromDataSetsAsync, deleteDataSet, deleteDataSets, getAllDataSets, getData, getDatasByDataSet, getDatasById, getDataSet, getDataSetByName, getDataSets, getDataSetsByGuid, getDataSetsByJobStepWorkunits, updateDataSet, updateDataSets


DataSetArrayRange

The DataSetArrayRange object contains an array of DataSet objects, along with a "total" field.

begin struct
    DataSet[]records // An array of DataSet objects. The range of objects in the array is independent of the value in the "total" field.
    integertotal // The total number of objects that matched the criteria of the returning function. This number is calculated prior to applying the caller's range specification.
end struct

See also: getDataSets


DataSetFilter

The DataSetFilter object is used to filter requests for DataSets.

begin struct
    guid[]data_set_gid_match // If this vector is nonempty, only records with data_set_gid in this set are selected.
    guid[]data_set_gid_not_match // Only records with data_set_gid not in this set are selected.
    stringdata_set_name_regex // If this data_set_name is nonempty, only records with data_set_name matching this regular expression are selected.
    stringpersistency_test // Indicates how the persistency_min and persistency_max filter fields are checked (see ADG).
    integerpersistency_min // The value that is matched against the persistency value when enabled.
    integerpersistency_max // The value that is matched against the persistency value when enabled.
    integer[]persistency_in_set // If this vector is nonempty, only records with persistency in this set are selected.
    integer[]persistency_notin_set // Only records with persistency not in this set are selected.
    booleanurl_first_active // Indicates that the url_first_value filter url_first is checked.
    booleanurl_first_value // The value that is matched against the url_first value when url_first_active is true.
    guid[]job_gid_match // If this vector is nonempty, only records with job_gid in this set are selected.
    guid[]job_gid_not_match // Only records with job_gid not in this set are selected.
    guid[]job_step_gid_match // If this vector is nonempty, only records with job_step_gid in this set are selected.
    guid[]job_step_gid_not_match // Only records with job_step_gid not in this set are selected.
    stringannotation_regex // If this annotation is nonempty, only records with annotation matching this regular expression are selected.
    stringcreation_time_test // Indicates how the creation_time_start and creation_time_end filter fields are checked (see ADG).
    dateTimecreation_time_start // The value that is matched against the creation_time value when enabled.
    dateTimecreation_time_end // The value that is matched against the creation_time value when enabled.
    stringlast_modified_test // Indicates how the last_modified_start and last_modified_end filter fields are checked (see ADG).
    dateTimelast_modified_start // The value that is matched against the last_modified value when enabled.
    dateTimelast_modified_end // The value that is matched against the last_modified value when enabled.
end struct

See also: getDataSets


Device

The Device object describes an instance of an Agent, running on a physical machine as part of the Grid MP platform. A Device belongs to a single DeviceProfile.

begin struct
    guiddevice_gid // The primary unique identifier of this object. (no-create)
    guiddevice_profile_gid // The DeviceProfile to which this Device belongs. This must refer to a valid DeviceProfile.
// Validation: device_profile_gid must not be the NULL guid.
    integerstate_id // The Device state.
// Valid states:
//    0 (Disabled): This Device will not receive any more Workunits.
//    1 (Enabled): This Device may receive Workunits.
    stringdevice_name // The name of this Device. If the system-wide Device recycling feature has been turned on by the MP Administrator (off by default), each device_name is assumed to be unique. See the SAG for more info on Device recycling. (max length 255)
// Validation: device_name must not have leading spaces.
// Validation: device_name must not have trailing spaces.
// Validation: device_name must not be empty.
    stringdescription // A free-form textual description of this Device. (max length 500)
    stringlocation // The physical location of this Device (free-form text). (max length 500)
    dateTimecreation_time // The time this Device was created. (no-create) (no-update)
    dateTimelast_modified // The time this record was last modified. See struct info.
    integerplatform_id // The platform identifier (operating system) of this Device. (no-create) (no-update)
    integercpu_ncpus // Number of processors installed on the Device (1=single processor, 2=dual processor, etc). (no-create) (no-update)
// Validation: cpu_ncpus must be positive.
    integercpu_clockrate_mhz // Approximate processor speed of Device (in megahertz). (no-create) (no-update)
// Validation: cpu_clockrate_mhz must not be negative.
    integercpu_cache_bytes // Size of processor L2 cache (in bytes). (no-create) (no-update)
// Validation: cpu_cache_bytes must not be negative.
    integermemory_physical // Amount of total physical RAM installed on Device (in megabytes). (no-create) (no-update)
// Validation: memory_physical must not be negative.
    integermemory_swap // Current amount of total possible virtual memory swap space (in megabytes). (no-create) (no-update)
// Validation: memory_swap must not be negative.
    integerdisk_total // Total size of the partition that the Agent is installed on (in megabytes) (no-create) (no-update)
// Validation: disk_total must not be negative.
    stringcpu_vendor // Textual name of the manufacturer of the processor (i.e.: "Intel", "AMD" etc.) (max length 50) (no-create) (no-update)
    stringcpu_model // Textual name of the processor model (i.e.: "Pentium 4", "K6", etc) (max length 50) (no-create) (no-update)
    stringos_name // Textual name of the operating system (i.e.: "Windows XP", "Windows 98", "Linux", etc) (max length 60) (no-create) (no-update)
    stringos_version // Textual representation of the operating system version number. (max length 50) (no-create) (no-update)
    stringvendor_name // Textual name of the computer vendor, if known. (i.e.: "Dell", "Gateway", etc) (max length 250) (no-create) (no-update)
    stringvendor_model // Textual name of the computer vendor model, if known. (max length 250) (no-create) (no-update)
    stringcpu_architecture // Processor architecture type (max length 250) (no-create) (no-update)
    stringcpu_isalist // List of Instruction Set Architectures available. This space-separated list of keywords indicates processor capabilities, such as MMX extensions or the availability of an FPU. (max length 250) (no-create) (no-update)
    stringnet_adapter // List of network interface adapters installed (max length 250) (no-create) (no-update)
    integerutc_offset_minutes // The number of minutes to add to UTC to get the local time. For example CST is six hours behind UTC, so this value is -6*60 = -360. (no-create) (no-update)
    stringagent_version_name // The agent version descriptor of the Device. (max length 36) (no-create) (no-update)
    doublecpu_whetstones // The whetstone rating of the Device. (no-create) (no-update)
    integerdisk_free // The total number of free megabytes available to the agent without deleting items from the cache. (no-create) (no-update)
    dateTimelast_contact // Timestamp of when the last communication between the Device and any GridMP Service was made. (no-create) (no-update)
    stringip_addr // The last known IP address of this device. (max length 15) (no-create) (no-update)
    integeragent_status_id // The last reported status of the Agent. (no-create) (no-update)
// Valid states:
//    0 (Idle): Not running any programs, because at last Dispatch contact none were available for this Device
//    1 (Working): Actively running one or more programs
//    2 (Suspended/AC): Suspended due to AC Power loss
//    3 (Suspended/Snooze): Suspended due to requested snooze
//    4 (Suspended/Time): Suspended due to time profile settings
    integerstatus_id // The connectivity status of the Device, based on the last_contact.
// Valid states:
//    0 (Connected): Device is regularly contacting any GridMP Service.
//    1 (Disconnected): Device has not contacted any GridMP Service within the 'System: Device dormant seconds.' period.
//    2 (Dormant): Device has not contacted any GridMP Service within the 'System: Device disconnected seconds.' period.
(no-create) (no-update)
end struct

See also: cancelDeviceCommands, deleteDevice, deleteDevices, deleteResourceAvailable, getAllDevices, getDevice, getDeviceCommands, getDevices, getDevicesByDeviceGroup, getDevicesByDeviceProfile, getDevicesByGuid, getDevicesByWorkunit, getResourceAvailablesByDevice, getStatsDevice, moveDevices, updateDevice


DeviceArrayRange

The DeviceArrayRange object contains an array of Device objects, along with a "total" field.

begin struct
    Device[]records // An array of Device objects. The range of objects in the array is independent of the value in the "total" field.
    integertotal // The total number of objects that matched the criteria of the returning function. This number is calculated prior to applying the caller's range specification.
end struct

See also: getDevices


DeviceCommand

The DeviceCommand object describes a command which will be sent by the system to a Device.

begin struct
    guiddevice_gid // The Device or DeviceGroup to which this command will be sent. When used with sendDeviceCommand, a NULL guid refers to all Devices.
    integertype_id // The identifier of the command to send to the Device.
// Valid states:
//    1 (UNLINK_ALL): Unlink all cached files
//    2 (ABORT_WU): Abort specified workunit guid (in argument)
//    3 (SNOOZE): Snooze now for specified seconds (in argument)
//    4 (RELOGIN): Obtain new device gid
//    5 (REALM_URL): Set new URL for Realm Service (in argument)
//    6 (SHUTDOWN): Instruct Agent to shutdown
//    7 (BACKOFF): Instruct Agent to backoff for a specified number of seconds (in argument)
//    8 (MAX_MULTIPROC): Override maximum multiprocessor count for Program execution (in argument)
//    9 (CACHE_AHEAD): Agent should request extra workunits from Dispatch Service (in argument)
//    10 (ABORT_WU_SILENT): For internal use by Database only.
    stringparameter // The optional parameter associated with the command. (max length 128)
    dateTimecreation_time // The time this DeviceCommand was created. (no-create) (no-update)
end struct

See also: cancelDeviceCommands, getDeviceCommands, sendDeviceCommand


DeviceFilter

The DeviceFilter object is used to filter requests for Devices.

begin struct
    guid[]device_gid_match // If this vector is nonempty, only records with device_gid in this set are selected.
    guid[]device_gid_not_match // Only records with device_gid not in this set are selected.
    guid[]device_profile_gid_match // If this vector is nonempty, only records with device_profile_gid in this set are selected.
    guid[]device_profile_gid_not_match // Only records with device_profile_gid not in this set are selected.
    stringstate_id_test // Indicates how the state_id_min and state_id_max filter fields are checked (see ADG).
    integerstate_id_min // The value that is matched against the state_id value when enabled.
    integerstate_id_max // The value that is matched against the state_id value when enabled.
    integer[]state_id_in_set // If this vector is nonempty, only records with state_id in this set are selected.
    integer[]state_id_notin_set // Only records with state_id not in this set are selected.
    stringdevice_name_regex // If this device_name is nonempty, only records with device_name matching this regular expression are selected.
    stringcreation_time_test // Indicates how the creation_time_start and creation_time_end filter fields are checked (see ADG).
    dateTimecreation_time_start // The value that is matched against the creation_time value when enabled.
    dateTimecreation_time_end // The value that is matched against the creation_time value when enabled.
    stringlast_modified_test // Indicates how the last_modified_start and last_modified_end filter fields are checked (see ADG).
    dateTimelast_modified_start // The value that is matched against the last_modified value when enabled.
    dateTimelast_modified_end // The value that is matched against the last_modified value when enabled.
    stringplatform_id_test // Indicates how the platform_id_min and platform_id_max filter fields are checked (see ADG).
    integerplatform_id_min // The value that is matched against the platform_id value when enabled.
    integerplatform_id_max // The value that is matched against the platform_id value when enabled.
    integer[]platform_id_in_set // If this vector is nonempty, only records with platform_id in this set are selected.
    integer[]platform_id_notin_set // Only records with platform_id not in this set are selected.
    stringcpu_ncpus_test // Indicates how the cpu_ncpus_min and cpu_ncpus_max filter fields are checked (see ADG).
    integercpu_ncpus_min // The value that is matched against the cpu_ncpus value when enabled.
    integercpu_ncpus_max // The value that is matched against the cpu_ncpus value when enabled.
    integer[]cpu_ncpus_in_set // If this vector is nonempty, only records with cpu_ncpus in this set are selected.
    integer[]cpu_ncpus_notin_set // Only records with cpu_ncpus not in this set are selected.
    stringcpu_clockrate_mhz_test // Indicates how the cpu_clockrate_mhz_min and cpu_clockrate_mhz_max filter fields are checked (see ADG).
    integercpu_clockrate_mhz_min // The value that is matched against the cpu_clockrate_mhz value when enabled.
    integercpu_clockrate_mhz_max // The value that is matched against the cpu_clockrate_mhz value when enabled.
    integer[]cpu_clockrate_mhz_in_set // If this vector is nonempty, only records with cpu_clockrate_mhz in this set are selected.
    integer[]cpu_clockrate_mhz_notin_set // Only records with cpu_clockrate_mhz not in this set are selected.
    stringcpu_cache_bytes_test // Indicates how the cpu_cache_bytes_min and cpu_cache_bytes_max filter fields are checked (see ADG).
    integercpu_cache_bytes_min // The value that is matched against the cpu_cache_bytes value when enabled.
    integercpu_cache_bytes_max // The value that is matched against the cpu_cache_bytes value when enabled.
    integer[]cpu_cache_bytes_in_set // If this vector is nonempty, only records with cpu_cache_bytes in this set are selected.
    integer[]cpu_cache_bytes_notin_set // Only records with cpu_cache_bytes not in this set are selected.
    stringmemory_physical_test // Indicates how the memory_physical_min and memory_physical_max filter fields are checked (see ADG).
    integermemory_physical_min // The value that is matched against the memory_physical value when enabled.
    integermemory_physical_max // The value that is matched against the memory_physical value when enabled.
    integer[]memory_physical_in_set // If this vector is nonempty, only records with memory_physical in this set are selected.
    integer[]memory_physical_notin_set // Only records with memory_physical not in this set are selected.
    stringmemory_swap_test // Indicates how the memory_swap_min and memory_swap_max filter fields are checked (see ADG).
    integermemory_swap_min // The value that is matched against the memory_swap value when enabled.
    integermemory_swap_max // The value that is matched against the memory_swap value when enabled.
    integer[]memory_swap_in_set // If this vector is nonempty, only records with memory_swap in this set are selected.
    integer[]memory_swap_notin_set // Only records with memory_swap not in this set are selected.
    stringdisk_total_test // Indicates how the disk_total_min and disk_total_max filter fields are checked (see ADG).
    integerdisk_total_min // The value that is matched against the disk_total value when enabled.
    integerdisk_total_max // The value that is matched against the disk_total value when enabled.
    integer[]disk_total_in_set // If this vector is nonempty, only records with disk_total in this set are selected.
    integer[]disk_total_notin_set // Only records with disk_total not in this set are selected.
    stringcpu_vendor_regex // If this cpu_vendor is nonempty, only records with cpu_vendor matching this regular expression are selected.
    stringcpu_model_regex // If this cpu_model is nonempty, only records with cpu_model matching this regular expression are selected.
    stringos_name_regex // If this os_name is nonempty, only records with os_name matching this regular expression are selected.
    stringos_version_regex // If this os_version is nonempty, only records with os_version matching this regular expression are selected.
    stringvendor_name_regex // If this vendor_name is nonempty, only records with vendor_name matching this regular expression are selected.
    stringvendor_model_regex // If this vendor_model is nonempty, only records with vendor_model matching this regular expression are selected.
    stringcpu_architecture_regex // If this cpu_architecture is nonempty, only records with cpu_architecture matching this regular expression are selected.
    stringcpu_isalist_regex // If this cpu_isalist is nonempty, only records with cpu_isalist matching this regular expression are selected.
    stringnet_adapter_regex // If this net_adapter is nonempty, only records with net_adapter matching this regular expression are selected.
    stringutc_offset_minutes_test // Indicates how the utc_offset_minutes_min and utc_offset_minutes_max filter fields are checked (see ADG).
    integerutc_offset_minutes_min // The value that is matched against the utc_offset_minutes value when enabled.
    integerutc_offset_minutes_max // The value that is matched against the utc_offset_minutes value when enabled.
    integer[]utc_offset_minutes_in_set // If this vector is nonempty, only records with utc_offset_minutes in this set are selected.
    integer[]utc_offset_minutes_notin_set // Only records with utc_offset_minutes not in this set are selected.
    stringagent_version_name_regex // If this agent_version_name is nonempty, only records with agent_version_name matching this regular expression are selected.
    stringcpu_whetstones_test // Indicates how the cpu_whetstones_min and cpu_whetstones_max filter fields are checked (see ADG).
    doublecpu_whetstones_min // The value that is matched against the cpu_whetstones value when enabled.
    doublecpu_whetstones_max // The value that is matched against the cpu_whetstones value when enabled.
    stringdisk_free_test // Indicates how the disk_free_min and disk_free_max filter fields are checked (see ADG).
    integerdisk_free_min // The value that is matched against the disk_free value when enabled.
    integerdisk_free_max // The value that is matched against the disk_free value when enabled.
    integer[]disk_free_in_set // If this vector is nonempty, only records with disk_free in this set are selected.
    integer[]disk_free_notin_set // Only records with disk_free not in this set are selected.
    stringlast_contact_test // Indicates how the last_contact_start and last_contact_end filter fields are checked (see ADG).
    dateTimelast_contact_start // The value that is matched against the last_contact value when enabled.
    dateTimelast_contact_end // The value that is matched against the last_contact value when enabled.
    stringip_addr_regex // If this ip_addr is nonempty, only records with ip_addr matching this regular expression are selected.
    stringagent_status_id_test // Indicates how the agent_status_id_min and agent_status_id_max filter fields are checked (see ADG).
    integeragent_status_id_min // The value that is matched against the agent_status_id value when enabled.
    integeragent_status_id_max // The value that is matched against the agent_status_id value when enabled.
    integer[]agent_status_id_in_set // If this vector is nonempty, only records with agent_status_id in this set are selected.
    integer[]agent_status_id_notin_set // Only records with agent_status_id not in this set are selected.
    stringstatus_id_test // Indicates how the status_id_min and status_id_max filter fields are checked (see ADG).
    integerstatus_id_min // The value that is matched against the status_id value when enabled.
    integerstatus_id_max // The value that is matched against the status_id value when enabled.
    integer[]status_id_in_set // If this vector is nonempty, only records with status_id in this set are selected.
    integer[]status_id_notin_set // Only records with status_id not in this set are selected.
end struct

See also: getDevices


DeviceGroup

The DeviceGroup object contains DeviceProfiles, which in turn contain Devices. The DeviceGroup also specifies descriptive information, and scheduling parameters.

begin struct
    guiddevice_group_gid // The primary unique identifier of this object. (no-create)
    integerstate_id // The DeviceGroup state.
// Valid states:
//    0 (Disabled): Devices in this DeviceGroup will not be sent any more Workunits.
//    1 (Enabled): Devices in this DeviceGroup may be sent Workunits.
    stringdevice_group_name // The unique name of the DeviceGroup. (max length 36)
// Validation: device_group_name must not have leading spaces.
// Validation: device_group_name must not have trailing spaces.
// Validation: device_group_name must not be empty.
    integerpoll_interval // The number of seconds between which Devices in this DeviceGroup will poll. A value of zero will cause polling to be in conjunction with Workunit completions.
// Validation: poll_interval must not be negative.
    integerdefault_priority // The priority by which Jobs will run on this DeviceGroup if the submitting User has no associated SchedulingDescriptor. Note that the SchedulingDescriptor always takes precedence even if it is lower than the this field.
// Validation: default_priority must be between 0 and 100 inclusive.
    integermax_wu_cpu_timeout // The maximum value any JobStep's wu_cpu_timeout field may have on this DeviceGroup. Zero allows any timeout.
// Validation: max_wu_cpu_timeout must not be negative.
// Validation: max_wu_cpu_timeout must be less than or equal to max_wu_clock_timeout.
    integermax_wu_clock_timeout // The maximum value any JobStep's wu_clock_timeout field may have on this DeviceGroup. Zero allows any timeout.
// Validation: max_wu_clock_timeout must not be negative.
// Validation: max_wu_cpu_timeout must be less than or equal to max_wu_clock_timeout.
    guiddefault_device_profile_gid // The DeviceProfile which Devices with no other associated DeviceProfile will use.
    guidagent_version_gid // The version of the Agent which Devices in this DeviceGroup use.
// Validation: agent_version_gid must not be the NULL guid.
    stringdescription // The free-form textual description of this DeviceGroup. (max length 500)
    dateTimecreation_time // The time this DeviceGroup was created. (no-create) (no-update)
    dateTimelast_modified // The time this record was last modified. See struct info.
end struct

See also: addDeviceGroupsToJob, addDeviceGroupToJob, createDeviceGroup, createDeviceGroups, deleteDeviceGroup, deleteDeviceGroups, getAllDeviceGroups, getCountDeviceGroupsByAgentVersion, getCountDevicesByDeviceGroup, getCountDevicesByDeviceProfile, getDeviceGroup, getDeviceGroupByName, getDeviceGroups, getDeviceGroupsByGuid, getDeviceGroupsByJob, getDeviceProfilesByDeviceGroup, getDevicesByDeviceGroup, getJobsByDeviceGroup, getSchedulingDescriptorsByDeviceGroup, getSchedulingDescriptorUserGroupsByDeviceGroup, getSchedulingDescriptorUsersByDeviceGroup, getStatsAllDeviceGroups, getStatsDeviceGroup, getStatsDevicesByDeviceGroup, moveDevices, removeDeviceGroupFromJob, removeDeviceGroupsFromJob, setJobDeviceGroups, updateDeviceGroup, updateDeviceGroupRestricted, updateDeviceGroups


DeviceGroupArrayRange

The DeviceGroupArrayRange object contains an array of DeviceGroup objects, along with a "total" field.

begin struct
    DeviceGroup[]records // An array of DeviceGroup objects. The range of objects in the array is independent of the value in the "total" field.
    integertotal // The total number of objects that matched the criteria of the returning function. This number is calculated prior to applying the caller's range specification.
end struct

See also: getDeviceGroups


DeviceGroupFilter

The DeviceGroupFilter object is used to filter requests for DeviceGroups.

begin struct
    guid[]device_group_gid_match // If this vector is nonempty, only records with device_group_gid in this set are selected.
    guid[]device_group_gid_not_match // Only records with device_group_gid not in this set are selected.
    stringstate_id_test // Indicates how the state_id_min and state_id_max filter fields are checked (see ADG).
    integerstate_id_min // The value that is matched against the state_id value when enabled.
    integerstate_id_max // The value that is matched against the state_id value when enabled.
    integer[]state_id_in_set // If this vector is nonempty, only records with state_id in this set are selected.
    integer[]state_id_notin_set // Only records with state_id not in this set are selected.
    stringdevice_group_name_regex // If this device_group_name is nonempty, only records with device_group_name matching this regular expression are selected.
    stringpoll_interval_test // Indicates how the poll_interval_min and poll_interval_max filter fields are checked (see ADG).
    integerpoll_interval_min // The value that is matched against the poll_interval value when enabled.
    integerpoll_interval_max // The value that is matched against the poll_interval value when enabled.
    integer[]poll_interval_in_set // If this vector is nonempty, only records with poll_interval in this set are selected.
    integer[]poll_interval_notin_set // Only records with poll_interval not in this set are selected.
    stringdefault_priority_test // Indicates how the default_priority_min and default_priority_max filter fields are checked (see ADG).
    integerdefault_priority_min // The value that is matched against the default_priority value when enabled.
    integerdefault_priority_max // The value that is matched against the default_priority value when enabled.
    integer[]default_priority_in_set // If this vector is nonempty, only records with default_priority in this set are selected.
    integer[]default_priority_notin_set // Only records with default_priority not in this set are selected.
    stringmax_wu_cpu_timeout_test // Indicates how the max_wu_cpu_timeout_min and max_wu_cpu_timeout_max filter fields are checked (see ADG).
    integermax_wu_cpu_timeout_min // The value that is matched against the max_wu_cpu_timeout value when enabled.
    integermax_wu_cpu_timeout_max // The value that is matched against the max_wu_cpu_timeout value when enabled.
    integer[]max_wu_cpu_timeout_in_set // If this vector is nonempty, only records with max_wu_cpu_timeout in this set are selected.
    integer[]max_wu_cpu_timeout_notin_set // Only records with max_wu_cpu_timeout not in this set are selected.
    stringmax_wu_clock_timeout_test // Indicates how the max_wu_clock_timeout_min and max_wu_clock_timeout_max filter fields are checked (see ADG).
    integermax_wu_clock_timeout_min // The value that is matched against the max_wu_clock_timeout value when enabled.
    integermax_wu_clock_timeout_max // The value that is matched against the max_wu_clock_timeout value when enabled.
    integer[]max_wu_clock_timeout_in_set // If this vector is nonempty, only records with max_wu_clock_timeout in this set are selected.
    integer[]max_wu_clock_timeout_notin_set // Only records with max_wu_clock_timeout not in this set are selected.
    guid[]default_device_profile_gid_match // If this vector is nonempty, only records with default_device_profile_gid in this set are selected.
    guid[]default_device_profile_gid_not_match // Only records with default_device_profile_gid not in this set are selected.
    guid[]agent_version_gid_match // If this vector is nonempty, only records with agent_version_gid in this set are selected.
    guid[]agent_version_gid_not_match // Only records with agent_version_gid not in this set are selected.
    stringdescription_regex // If this description is nonempty, only records with description matching this regular expression are selected.
    stringcreation_time_test // Indicates how the creation_time_start and creation_time_end filter fields are checked (see ADG).
    dateTimecreation_time_start // The value that is matched against the creation_time value when enabled.
    dateTimecreation_time_end // The value that is matched against the creation_time value when enabled.
    stringlast_modified_test // Indicates how the last_modified_start and last_modified_end filter fields are checked (see ADG).
    dateTimelast_modified_start // The value that is matched against the last_modified value when enabled.
    dateTimelast_modified_end // The value that is matched against the last_modified value when enabled.
end struct

See also: getDeviceGroups


DeviceProfile

The DeviceProfile object contains Device objects along with scheduling specifications. The DeviceProfile belongs to a DeviceGroup.

begin struct
    guiddevice_profile_gid // The primary unique identifier of this object. (no-create)
    guiddevice_group_gid // The DeviceGroup to which this DeviceProfile belongs. (no-update)
// Validation: device_group_gid must not be the NULL guid.
    stringdevice_profile_name // The name of this DeviceProfile. This case-insensitive string must be unique within a DeviceGroup. (max length 36)
// Validation: device_profile_name must not have leading spaces.
// Validation: device_profile_name must not have trailing spaces.
// Validation: device_profile_name must not be empty.
    stringexec_schedule // Each character is a '-' or '+'. A '-' prohibits execution during that hour whereas a '+' allows it. The week starts at 00:00 on Monday and ends at the 23:00 hour on Sunday. The empty string is treated specially, and means execution may happen at all times during the week. (max length 168)
// Validation: exec_schedule must be either empty or 168 characters consisting of only '-' and '+'.
    stringcomm_schedule // Each character is a '-' or '+'. A '-' prohibits communication during that hour whereas a '+' allows it. The week starts at 00:00 on Monday and ends at the 23:00 hour on Sunday. The empty string is treated specially, and means communication may happen at all times during the week. (max length 168)
// Validation: comm_schedule must be either empty or 168 characters consisting of only '-' and '+'.
    integermax_disk_mbytes // The maximum number of megabytes the Agent is allowed to use on the associated Device. Zero disables max_disk_mbytes checking.
// Validation: max_disk_mbytes must be nonnegative
    integermax_disk_percent // The percent of the total disk the Agent is allowed to use. Only the partition on which the Agent resides is counted. Zero disables max_disk_percent checking.
// Validation: max_disk_percent must be between 0 and 100 inclusive
    integermin_disk_free_mbytes // The minimum number of megabytes the Agent must leave free on the disk of the associated Device. Only the partition on which the Agent resides is counted.
// Validation: min_disk_free_mbytes must be nonnegative
    integermin_disk_free_percent // The percent of the total disk the Agent must leave free. Only the partition on which the Agent resides is counted.
// Validation: min_disk_free_percent must be between 0 and 100 inclusive
    booleanrun_new_applications // If this flag is true, then new Applications are run automatically on this DeviceProfile. Otherwise they are not run. See addApplicationToDeviceProfile and removeApplicationFromDeviceProfile. (required)
    booleanrun_new_programs // If this flag is true, then new Programs are run automatically on this DeviceProfile. Otherwise they are not run. See addProgramToDeviceProfile and removeProgramFromDeviceProfile. (required)
    booleanmonitor_user_activity // If true, then the Agent should actively monitor user activity and potentially trigger Program suspension.
    integermonitor_cpu_usage_agent_max // If non-zero, then specifies the threshold for CPU utilization by non-Agent processes at which Program suspension will potentially be triggered.
// Validation: monitor_cpu_usage_agent_max must be between 0 and 100 inclusive
    integermonitor_memory_used_percent_max // If non-zero, then specifies the threshold for system-wide RAM utilization at which Program suspension will be potentially triggered.
// Validation: monitor_memory_used_percent_max must be between 0 and 100 inclusive
    booleanmonitor_disk_use // If true, then the Agent should actively monitor disk utilization while Programs are running, otherwise only the disk cache utilization will be enforced while fetching Data files. When enabled and disk utilization has exceeded the configured limits, disk cache clearing will first be attempted, followed by Program abortion if disk usage is still too high.
    integermonitor_disk_page_rate_max // If non-zero, then specifies the system-wide disk paging rate (in pages/sec) threshold at which Program suspension will potentially be triggered.
// Validation: monitor_disk_page_rate_max must be nonnegative
    booleankeep_agent_priority // If true, then the Agent will not run Programs at idle priority on the Device and will instead run the Program at the unaltered priority of the Agent process itself.
    dateTimecreation_time // The time this DeviceProfile was created. (no-create) (no-update)
    dateTimelast_modified // The time this record was last modified. See struct info.
end struct

See also: addApplicationsToDeviceProfile, addApplicationToDeviceProfile, addProgramsToDeviceProfile, addProgramToDeviceProfile, createDeviceProfile, createDeviceProfiles, deleteDeviceProfile, deleteDeviceProfiles, getAllDeviceProfiles, getApplicationsByDeviceProfile, getCountDevicesByDeviceProfile, getDeviceProfile, getDeviceProfiles, getDeviceProfilesByDeviceGroup, getDeviceProfilesByGuid, getDevicesByDeviceProfile, getProgramsByDeviceProfile, moveDevices, removeApplicationFromDeviceProfile, removeApplicationsFromDeviceProfile, removeProgramFromDeviceProfile, removeProgramsFromDeviceProfile, setDeviceProfileApplications, setDeviceProfilePrograms, updateDeviceProfile, updateDeviceProfiles


DeviceProfileArrayRange

The DeviceProfileArrayRange object contains an array of DeviceProfile objects, along with a "total" field.

begin struct
    DeviceProfile[]records // An array of DeviceProfile objects. The range of objects in the array is independent of the value in the "total" field.
    integertotal // The total number of objects that matched the criteria of the returning function. This number is calculated prior to applying the caller's range specification.
end struct

See also: getDeviceProfiles


DeviceProfileFilter

The DeviceProfileFilter object is used to filter requests for DeviceProfiles.

begin struct
    guid[]device_profile_gid_match // If this vector is nonempty, only records with device_profile_gid in this set are selected.
    guid[]device_profile_gid_not_match // Only records with device_profile_gid not in this set are selected.
    guid[]device_group_gid_match // If this vector is nonempty, only records with device_group_gid in this set are selected.
    guid[]device_group_gid_not_match // Only records with device_group_gid not in this set are selected.
    stringdevice_profile_name_regex // If this device_profile_name is nonempty, only records with device_profile_name matching this regular expression are selected.
    stringexec_schedule_regex // If this exec_schedule is nonempty, only records with exec_schedule matching this regular expression are selected.
    stringcomm_schedule_regex // If this comm_schedule is nonempty, only records with comm_schedule matching this regular expression are selected.
    stringmax_disk_mbytes_test // Indicates how the max_disk_mbytes_min and max_disk_mbytes_max filter fields are checked (see ADG).
    integermax_disk_mbytes_min // The value that is matched against the max_disk_mbytes value when enabled.
    integermax_disk_mbytes_max // The value that is matched against the max_disk_mbytes value when enabled.
    integer[]max_disk_mbytes_in_set // If this vector is nonempty, only records with max_disk_mbytes in this set are selected.
    integer[]max_disk_mbytes_notin_set // Only records with max_disk_mbytes not in this set are selected.
    stringmax_disk_percent_test // Indicates how the max_disk_percent_min and max_disk_percent_max filter fields are checked (see ADG).
    integermax_disk_percent_min // The value that is matched against the max_disk_percent value when enabled.
    integermax_disk_percent_max // The value that is matched against the max_disk_percent value when enabled.
    integer[]max_disk_percent_in_set // If this vector is nonempty, only records with max_disk_percent in this set are selected.
    integer[]max_disk_percent_notin_set // Only records with max_disk_percent not in this set are selected.
    stringmin_disk_free_mbytes_test // Indicates how the min_disk_free_mbytes_min and min_disk_free_mbytes_max filter fields are checked (see ADG).
    integermin_disk_free_mbytes_min // The value that is matched against the min_disk_free_mbytes value when enabled.
    integermin_disk_free_mbytes_max // The value that is matched against the min_disk_free_mbytes value when enabled.
    integer[]min_disk_free_mbytes_in_set // If this vector is nonempty, only records with min_disk_free_mbytes in this set are selected.
    integer[]min_disk_free_mbytes_notin_set // Only records with min_disk_free_mbytes not in this set are selected.
    stringmin_disk_free_percent_test // Indicates how the min_disk_free_percent_min and min_disk_free_percent_max filter fields are checked (see ADG).
    integermin_disk_free_percent_min // The value that is matched against the min_disk_free_percent value when enabled.
    integermin_disk_free_percent_max // The value that is matched against the min_disk_free_percent value when enabled.
    integer[]min_disk_free_percent_in_set // If this vector is nonempty, only records with min_disk_free_percent in this set are selected.
    integer[]min_disk_free_percent_notin_set // Only records with min_disk_free_percent not in this set are selected.
    booleanrun_new_applications_active // Indicates that the run_new_applications_value filter run_new_applications is checked.
    booleanrun_new_applications_value // The value that is matched against the run_new_applications value when run_new_applications_active is true.
    booleanrun_new_programs_active // Indicates that the run_new_programs_value filter run_new_programs is checked.
    booleanrun_new_programs_value // The value that is matched against the run_new_programs value when run_new_programs_active is true.
    stringcreation_time_test // Indicates how the creation_time_start and creation_time_end filter fields are checked (see ADG).
    dateTimecreation_time_start // The value that is matched against the creation_time value when enabled.
    dateTimecreation_time_end // The value that is matched against the creation_time value when enabled.
    stringlast_modified_test // Indicates how the last_modified_start and last_modified_end filter fields are checked (see ADG).
    dateTimelast_modified_start // The value that is matched against the last_modified value when enabled.
    dateTimelast_modified_end // The value that is matched against the last_modified value when enabled.
end struct

See also: getDeviceProfiles


Error

The Error object describes information about an error reported within the system. For example, if the program being executed by an Agent terminates unexpectedly, the Agent will report an Error.

begin struct
    dateTimewhen // The time at which this error was generated.
    stringsource // The source of the error. Valid values are 'A' for Agent, 'U' for Unknown, 'D' for Database. (max length 1)
    guiddevice_gid // The Device to which this object applies. This identifier may potentially not exist if the corresponding Device has been deleted.
    guiddevice_group_gid // The DeviceGroup to which the device_gid belongs. This identifier may potentially not exist if the corresponding DeviceGroup has been deleted.
    stringdevice_group_name // The name of the DeviceGroup to which the device_gid belongs. (max length 36)
    guidprogram_gid // The Program identifier to which this object applies. This identifier may potentially not exist if the corresponding Program has been deleted.
    stringprogram_name // The Program name to which this object applies. (max length 36)
    guidworkunit_gid // The Workunit to which this object applies. This identifier may potentially not exist if the corresponding Workunit has been deleted.
    guidjob_gid // The Job to which this object applies. This identifier may potentially not exist if the corresponding Job has been deleted.
    guidjob_step_gid // The JobStep to which this object applies. This identifier may potentially not exist if the corresponding JobStep has been deleted.
    integerplatform_id // The Platform to which this object applies.
    stringplatform_name // The name of the Platform to which this object applies. (max length 32)
    stringagent_version // Version of the core agent the Device was running. (max length 36)
    integerstatus // A numeric code, reserved for internal use, corresponding to a particular message in the details field.
    stringdetails // Any additional information provided by the source of the error. (max length 1000)
    dateTimecreation_time // The time when this object was created. (no-create) (no-update)
    sha1error_hash // The SHA1 hash of additional log file information associated with this Error.
    longerror_size // The size of additional log file information associated with this Error.
end struct

See also: deleteErrors, getErrors


ErrorArrayRange

The ErrorArrayRange object contains an array of Error objects, along with a "total" field.

begin struct
    Error[]records // An array of Error objects. The range of objects in the array is independent of the value in the "total" field.
    integertotal // The total number of objects that matched the criteria of the returning function. This number is calculated prior to applying the caller's range specification.
end struct

See also: getErrors


ErrorFilter

The ErrorFilter object is used to filter requests for Errors.

begin struct
    stringwhen_test // Indicates how the when_start and when_end filter fields are checked (see ADG).
    dateTimewhen_start // The value that is matched against the when value when enabled.
    dateTimewhen_end // The value that is matched against the when value when enabled.
    stringsource_regex // If this source is nonempty, only records with source matching this regular expression are selected.
    guid[]device_gid_match // If this vector is nonempty, only records with device_gid in this set are selected.
    guid[]device_gid_not_match // Only records with device_gid not in this set are selected.
    guid[]device_group_gid_match // If this vector is nonempty, only records with device_group_gid in this set are selected.
    guid[]device_group_gid_not_match // Only records with device_group_gid not in this set are selected.
    stringdevice_group_name_regex // If this device_group_name is nonempty, only records with device_group_name matching this regular expression are selected.
    guid[]program_gid_match // If this vector is nonempty, only records with program_gid in this set are selected.
    guid[]program_gid_not_match // Only records with program_gid not in this set are selected.
    stringprogram_name_regex // If this program_name is nonempty, only records with program_name matching this regular expression are selected.
    guid[]workunit_gid_match // If this vector is nonempty, only records with workunit_gid in this set are selected.
    guid[]workunit_gid_not_match // Only records with workunit_gid not in this set are selected.
    guid[]job_gid_match // If this vector is nonempty, only records with job_gid in this set are selected.
    guid[]job_gid_not_match // Only records with job_gid not in this set are selected.
    guid[]job_step_gid_match // If this vector is nonempty, only records with job_step_gid in this set are selected.
    guid[]job_step_gid_not_match // Only records with job_step_gid not in this set are selected.
    stringplatform_id_test // Indicates how the platform_id_min and platform_id_max filter fields are checked (see ADG).
    integerplatform_id_min // The value that is matched against the platform_id value when enabled.
    integerplatform_id_max // The value that is matched against the platform_id value when enabled.
    integer[]platform_id_in_set // If this vector is nonempty, only records with platform_id in this set are selected.
    integer[]platform_id_notin_set // Only records with platform_id not in this set are selected.
    stringplatform_name_regex // If this platform_name is nonempty, only records with platform_name matching this regular expression are selected.
    stringagent_version_regex // If this agent_version is nonempty, only records with agent_version matching this regular expression are selected.
    stringstatus_test // Indicates how the status_min and status_max filter fields are checked (see ADG).
    integerstatus_min // The value that is matched against the status value when enabled.
    integerstatus_max // The value that is matched against the status value when enabled.
    integer[]status_in_set // If this vector is nonempty, only records with status in this set are selected.
    integer[]status_notin_set // Only records with status not in this set are selected.
    stringdetails_regex // If this details is nonempty, only records with details matching this regular expression are selected.
    sha1[]error_hash_match // If this vector is nonempty, only records with error_hash in this set are selected.
    stringerror_size_test // Indicates how the error_size_min and error_size_max filter fields are checked (see ADG).
    longerror_size_min // The value that is matched against the error_size value when enabled.
    longerror_size_max // The value that is matched against the error_size value when enabled.
    long[]error_size_in_set // If this vector is nonempty, only records with error_size in this set are selected.
    long[]error_size_notin_set // Only records with error_size not in this set are selected.
end struct

See also: getErrors


Exception

The Exception object describes an error as returned from a function call. It is returned in an array, as part of a function call which performs multiple operations. The order in the returned array of Exceptions corresponds to the order of operations passed in to the function call. In this way, the caller can determine which operation, if any, failed.

begin struct
    integerexception_code // The unique integer identifier of this Exception, as listed in the Exception Error Codes. If the number is zero, no error occurred.
    stringexception_str // The textual description of the error. (max length 500)
end struct

See also: addApplicationsToDeviceProfile, addDeviceGroupsToJob, addPrivilegesToUserGroup, addProgramsToApplication, addProgramsToDeviceProfile, addUserOrGroupsToObjectPrivilege, addUserOrGroupsToRole, addUsersToUserGroup, createDatas, deleteAgentModules, deleteAgentVersions, deleteApplications, deleteCredentials, deleteDatas, deleteDataSets, deleteDeviceGroups, deleteDeviceProfiles, deleteDevices, deleteGlobalResources, deleteJobs, deleteJobSteps, deleteProgramModules, deleteProgramModuleVersions, deletePrograms, deleteProgramVersions, deleteResources, deleteResults, deleteSchedulingDescriptors, deleteServices, deleteUserGroups, deleteUsers, deleteWorkunits, removeApplicationsFromDeviceProfile, removeDeviceGroupsFromJob, removePrivilegesFromUserGroup, removeProgramsFromApplication, removeProgramsFromDeviceProfile, removeUserOrGroupsFromObjectPrivilege, removeUserOrGroupsFromRole, removeUsersFromUserGroup, setGlobalResourceRequirements, setResourceAvailables, setResourceRequirements, updateApplications, updateCredentials, updateDataSets, updateDeviceGroups, updateDeviceProfiles, updateGlobalResources, updateJobs, updateJobSteps, updateProgramModules, updatePrograms, updateProgramVersions, updateSchedulingDescriptors, updateUserGroups, updateUsers, updateWorkunitStates


ExceptionOrGuid

The ExceptionOrGuid object is identical to the Exception object, with the addition of the 'gid' field. It is used by calls which would normally return an array of guids. If no error occurred, the guid is set.

begin struct
    integerexception_code // The unique integer identifier of this Exception, as listed in the Exception Error Codes. If the number is zero, no error occurred.
    stringexception_str // The textual description of the error. (max length 500)
    guidgid // The guid, as returned by the function call.
end struct

See also: createAgentModules, createAgentVersions, createApplications, createCredentials, createDataSets, createDeviceGroups, createDeviceProfiles, createGlobalResources, createJobs, createJobSteps, createJobStepsWithResourceRequirements, createProgramModules, createProgramModuleVersions, createPrograms, createProgramVersions, createResources, createSchedulingDescriptors, createServices, createUserGroups, createUsers, createWorkunits


GlobalResource

The GlobalResource object is used to limit the number of concurrent instances of any ProgramModule which requires it. This object has a count of the total available to the system, and an in_use field, which is incremented when a relevant Workunit is scheduled, and decremented when that Workunit times out, errors out, or returns successfully. The amount by which the in_use field is changed is controlled by the GlobalResourceRequirement object and is specified on a per ProgramModule basis. There are also Resource objects which are used to express a property that a Device can provide and a ProgramModule require. Note that GlobalResources have no relationship with Devices, and are assumed to be usable by all Devices. Use Resource and GlobalResource together to express the notion of something which is only available to some Devices, yet also has a limited total global count.

begin struct
    guidglobal_resource_gid // The primary unique identifier of this object. (no-create)
    stringglobal_resource_name // A globally unique, human readable name which describes the actual resource this object tracks. (max length 64) (no-update) (required)
// Validation: global_resource_name must not have leading spaces.
// Validation: global_resource_name must not have trailing spaces.
// Validation: global_resource_name must not be empty.
    integercount // The amount of this GlobalResource available across the entire system. (required)
// Validation: Count must be >= 1.
    integertotal_in_use // The amount of this GlobalResource currently in use, initialized to 0. When a Workunit requiring this GlobalResource is scheduled, the total_in_use field is incremented by the GlobalResourceRequirement.value. When the Workunit times out, errors out, or completes successfully, the total_in_use field is decremented back by the same value. (no-create) (no-update)
    dateTimecreation_time // The time this GlobalResource was created. (no-create) (no-update)
    dateTimelast_modified // The time this record was last modified. See struct info.
end struct

See also: createGlobalResource, createGlobalResources, deleteGlobalResource, deleteGlobalResourceRequirement, deleteGlobalResources, getAllGlobalResources, getGlobalResource, getGlobalResourceByName, getGlobalResourceRequirementsByGlobalResource, getGlobalResources, updateGlobalResource, updateGlobalResources


GlobalResourceArrayRange

The GlobalResourceArrayRange object contains an array of GlobalResource objects, along with a "total" field.

begin struct
    GlobalResource[]records // An array of GlobalResource objects. The range of objects in the array is independent of the value in the "total" field.
    integertotal // The total number of objects that matched the criteria of the returning function. This number is calculated prior to applying the caller's range specification.
end struct

See also: getGlobalResources


GlobalResourceFilter

The GlobalResourceFilter object is used to filter requests for GlobalResources.

begin struct
    guid[]global_resource_gid_match // If this vector is nonempty, only records with global_resource_gid in this set are selected.
    guid[]global_resource_gid_not_match // Only records with global_resource_gid not in this set are selected.
    stringglobal_resource_name_regex // If this global_resource_name is nonempty, only records with global_resource_name matching this regular expression are selected.
    stringcount_test // Indicates how the count_min and count_max filter fields are checked (see ADG).
    integercount_min // The value that is matched against the count value when enabled.
    integercount_max // The value that is matched against the count value when enabled.
    integer[]count_in_set // If this vector is nonempty, only records with count in this set are selected.
    integer[]count_notin_set // Only records with count not in this set are selected.
    stringtotal_in_use_test // Indicates how the total_in_use_min and total_in_use_max filter fields are checked (see ADG).
    integertotal_in_use_min // The value that is matched against the total_in_use value when enabled.
    integertotal_in_use_max // The value that is matched against the total_in_use value when enabled.
    integer[]total_in_use_in_set // If this vector is nonempty, only records with total_in_use in this set are selected.
    integer[]total_in_use_notin_set // Only records with total_in_use not in this set are selected.
    stringcreation_time_test // Indicates how the creation_time_start and creation_time_end filter fields are checked (see ADG).
    dateTimecreation_time_start // The value that is matched against the creation_time value when enabled.
    dateTimecreation_time_end // The value that is matched against the creation_time value when enabled.
    stringlast_modified_test // Indicates how the last_modified_start and last_modified_end filter fields are checked (see ADG).
    dateTimelast_modified_start // The value that is matched against the last_modified value when enabled.
    dateTimelast_modified_end // The value that is matched against the last_modified value when enabled.
end struct

See also: getGlobalResources


GlobalResourceRequirement

ProgramModule objects express requirements for GlobalResources through GlobalResourceRequirement objects. JobSteps which use this ProgramModule inherit all of its GlobalResourceRequirements. See the description for GlobalResource for more information.

begin struct
    guidprogram_module_gid // The identifier of the ProgramModule which requires this GlobalResource. (required)
    guidglobal_resource_gid // The identifier of the required GlobalResource. (required)
    integeramount_required // The amount of the required GlobalResource.
// Validation: amount_required must be positive.
end struct

See also: deleteGlobalResourceRequirement, getAllGlobalResourceRequirements, getGlobalResourceRequirementsByGlobalResource, getGlobalResourceRequirementsByProgramModule, setGlobalResourceRequirement, setGlobalResourceRequirements


GuidNameCount

The GuidNameCount object contains counts of other objects in the system.

begin struct
    guidgid // The guid this object refers to.
    stringname // The name of the object referred to. (max length 256)
    integercount // The count corresponding to the guid.
end struct

See also: getCountDeviceGroupsByAgentVersion, getCountDevicesByDeviceGroup, getCountDevicesByDeviceProfile, getCountUserGroupsByRole, getCountUsersByRole, getCountUsersByUserGroup


IdNameCount

The IdNameCount object contains counts of other objects in the system.

begin struct
    integerid // The identifier this object refers to.
    stringname // The name of the object referred to. (max length 256)
    integercount // The count corresponding to the id.
end struct

See also: getStatsAllJobStates, getWorkunitStatesByJobStep


Job

The Job is an instance of an Application. This object has scheduling and identification properties, and serves as a container for JobSteps.

begin struct
    guidjob_gid // The primary unique identifier of this Job object. (no-create)
    integerjob_id // An alternate unique identifier of this Job object. This is intended to be a small integer easily readable and recognizable by humans, and is only used in the getJobById function. (no-create) (no-update)
    guidapplication_gid // The primary unique identifier of the Application to which this Job belongs. (no-update)
// Validation: application_gid must not be the NULL guid.
    guidcreator_gid // The primary unique identifier of the User that created this Job object. (no-create) (no-update)
// Validation: creator_gid must not be the NULL guid.
    stringdescription // The description of this Job object. (max length 500)
    integerstate_id // The state of this object. (required)
// Valid states:
//    0 (Disabled): This Job has not been enabled yet, and will not run. This state is deprecated.
//    1 (Enabled): This Job object is enabled.
//    2 (Suspended): This Job has been suspended and will not run.
//    3 (Completed): This Job has completed.
//    4 (Failed): This Job has failed.
    dateTimestart_time // The time at which the Job is scheduled to start. Not specifying a value, or specifying 1970-01-01T00:00:00 means the Job starts immediately upon activation.
// Validation: start_time must be less than end_time
    dateTimeend_time // The time at which this Job expires. Not specifying a value, or specifying 1970-01-01T00:00:00 means the Job continues to execute indefinitely (if work is available).
// Validation: start_time must be less than end_time
    integerpriority // The priority of this Job over other Jobs submitted by this User. Larger values of this field indicate higher priority. If this field is not set or zero, then a default priority of 10 is assumed. Note that JobSteps that make up this Job can be executed in any order and are all treated equally with respect to accounting for Job priority.
// Validation: priority must be between 1 and 100 inclusive.
    stringannotation // An annotation field. (max length 1000)
    dateTimecreation_time // The time this Job was created. (no-create) (no-update)
    dateTimelast_modified // The time this record was last modified. See struct info.
end struct

See also: addDeviceGroupsToJob, addDeviceGroupToJob, createJob, createJob2, createJobs, deleteJob, deleteJobs, getAllJobs, getDeviceGroupsByJob, getJob, getJobById, getJobs, getJobsByApplication, getJobsByDeviceGroup, getJobsByGuid, getJobStatus, getJobStatusesByGuid, getJobStepsByJob, getStatsJobDevices, removeDeviceGroupFromJob, removeDeviceGroupsFromJob, setJobDeviceGroups, updateJob, updateJobs


JobArrayRange

The JobArrayRange object contains an array of Job objects, along with a "total" field.

begin struct
    Job[]records // An array of Job objects. The range of objects in the array is independent of the value in the "total" field.
    integertotal // The total number of objects that matched the criteria of the returning function. This number is calculated prior to applying the caller's range specification.
end struct

See also: getJobs


JobFilter

The JobFilter object is used to filter requests for Jobs.

begin struct
    guid[]job_gid_match // If this vector is nonempty, only records with job_gid in this set are selected.
    guid[]job_gid_not_match // Only records with job_gid not in this set are selected.
    stringjob_id_test // Indicates how the job_id_min and job_id_max filter fields are checked (see ADG).
    integerjob_id_min // The value that is matched against the job_id value when enabled.
    integerjob_id_max // The value that is matched against the job_id value when enabled.
    integer[]job_id_in_set // If this vector is nonempty, only records with job_id in this set are selected.
    integer[]job_id_notin_set // Only records with job_id not in this set are selected.
    guid[]application_gid_match // If this vector is nonempty, only records with application_gid in this set are selected.
    guid[]application_gid_not_match // Only records with application_gid not in this set are selected.
    guid[]creator_gid_match // If this vector is nonempty, only records with creator_gid in this set are selected.
    guid[]creator_gid_not_match // Only records with creator_gid not in this set are selected.
    stringdescription_regex // If this description is nonempty, only records with description matching this regular expression are selected.
    stringstate_id_test // Indicates how the state_id_min and state_id_max filter fields are checked (see ADG).
    integerstate_id_min // The value that is matched against the state_id value when enabled.
    integerstate_id_max // The value that is matched against the state_id value when enabled.
    integer[]state_id_in_set // If this vector is nonempty, only records with state_id in this set are selected.
    integer[]state_id_notin_set // Only records with state_id not in this set are selected.
    stringstart_time_test // Indicates how the start_time_start and start_time_end filter fields are checked (see ADG).
    dateTimestart_time_start // The value that is matched against the start_time value when enabled.
    dateTimestart_time_end // The value that is matched against the start_time value when enabled.
    stringend_time_test // Indicates how the end_time_start and end_time_end filter fields are checked (see ADG).
    dateTimeend_time_start // The value that is matched against the end_time value when enabled.
    dateTimeend_time_end // The value that is matched against the end_time value when enabled.
    stringpriority_test // Indicates how the priority_min and priority_max filter fields are checked (see ADG).
    integerpriority_min // The value that is matched against the priority value when enabled.
    integerpriority_max // The value that is matched against the priority value when enabled.
    integer[]priority_in_set // If this vector is nonempty, only records with priority in this set are selected.
    integer[]priority_notin_set // Only records with priority not in this set are selected.
    stringannotation_regex // If this annotation is nonempty, only records with annotation matching this regular expression are selected.
    stringcreation_time_test // Indicates how the creation_time_start and creation_time_end filter fields are checked (see ADG).
    dateTimecreation_time_start // The value that is matched against the creation_time value when enabled.
    dateTimecreation_time_end // The value that is matched against the creation_time value when enabled.
    stringlast_modified_test // Indicates how the last_modified_start and last_modified_end filter fields are checked (see ADG).
    dateTimelast_modified_start // The value that is matched against the last_modified value when enabled.
    dateTimelast_modified_end // The value that is matched against the last_modified value when enabled.
end struct

See also: getJobs


JobGuidAndId

The JobGuidAndId object contains a job guid and a job id as returned by the createJob2 function.

begin struct
    guidgid // The guid this object refers to.
    integerid // The id corresponding to the guid.
end struct

See also: createJob2


JobStatus

JobStatus describes additional information about a Job, which is not contained in the Job object.

begin struct
    guidjob_gid // The primary unique identifier of the Job object.
    dateTimegenerated // The time at which the statistics in this JobStatus were valid.
    booleanrunnable // This flag indicates whether any of the JobSteps are eligible to be scheduled in the MP Server. It is true if any of the JobStep.state_id are ENABLED_OPEN or ENABLED_CLOSED; and if the Job.state_id is ENABLED; and if the Program.state_id is ENABLED, CLOSED, or PENDING_DELETE; and if the Application.state_id is ENABLED, CLOSED, or PENDING_DELETE; and if the current time is within the Job start and end times.
    doublecompleted_percent // The weighted average percent completion of work in each JobStep. Calculated by the number of Results for the JobStep divided by (the number of Workunits * JobStep.num_results). If num_results is -1, meaning "infinite redundancy", then completed_percent will always be zero.
    integerworkunits_total // Number of Workunits currently in the Job. Deleting a Workunit decrements this count.
    integerworkunits_added // Number of Workunits added to the Job. Deleting a Workunit does not affect this count.
    integerworkunits_completed // Number of Workunits marked as completed.
    integerdispatch_total // Number of times Workunits have been dispatched. Can be strictly less than results_received + errors_total, since one instance of execution can cause more than one Error.
    integerresults_successful_available // Number of successful results currently in the Job. Deleting a successful Result decrements this count.
    integerresults_unsuccessful_available // Number of unsuccessful results currently in the Job. Deleting an unsuccessful Result decrements this count.
    integerresults_available // Number of successful and unsuccessful results currently in the Job. Deleting a Result decrements this count.
    integerresults_successful_received // Number of successful results returned for the Job. Deleting a Result does not affect this count.
    integerresults_unsuccessful_received // Number of unsuccessful results returned for the Job. Deleting a Result does not affect this count.
    integerresults_received // Number of successful and unsuccessful results returned for the Job. Deleting a Result does not affect this count.
    integerresults_wu_delete // Number of results returned for Workunits that have been deleted.
    integererrors_total // Number of errors currently in the Job.
    integercpu_seconds // Total CPU time for the Job.
    doublepoints // Total points for the Job.
    dateTimefirst_dispatch // Time the first Workunit was dispatched.
    dateTimelast_dispatch // Last time a Workunit was dispatched.
    dateTimefirst_result // Time the first Result was received.
    dateTimelast_result // Last time a Result was received.
end struct

See also: getJobStatus, getJobStatusesByGuid


JobStep

The JobStep is an instance of the execution of a Program. JobSteps belong to a single Job, and also describe scheduling information.

begin struct
    guidjob_step_gid // The primary unique identifier of this JobStep object. (no-create)
    guidjob_gid // The identifier of the Job this JobStep belongs to. (no-update)
    integerstate_id // The state of this object. (required)
// Valid states:
//    0 (Disabled): This JobStep has not been enabled yet, and will not run.
//    1 (Enabled, Open): This JobStep object is active, and is accepting new Workunits.
//    2 (Suspended, Open): This JobStep has been suspended and will not run, though it is accepting new Workunits.
//    3 (Completed): This JobStep has completed.
//    4 (Enabled, Closed): This JobStep object is active, but is not accepting new Workunits.
//    5 (Suspended, Closed): This JobStep has been suspended and will not run. It will not accept new Workunits.
//    6 (Failed): This JobStep has failed.
    guidprogram_gid // The identifier of the Program with which this JobStep is associated. (no-update)
    guidprogram_version_gid // The identifier of the ProgramVersion with which this JobStep is associated. When creating a JobStep, this member is optional and will default to the default ProgramVersion for the specified Program.
    integernum_results // The number of results desired for each Workunit. When met, the Workunit state transitions to the Completed state. Use -1 in this field to run the Workunit until the max_errors threshold has been met.
// Validation: num_results must be either -1 or positive.
// Validation: num_results must be less than or equal to 32767.
    integermax_errors // The number of errors tolerated for each Workunit. When met, the Workunit state transitions to the Failed state.
// Validation: max_errors must between 1 and 32767 inclusive.
    integermax_concurrent // The maximum number of instances of a Workunit which can be dispatched at any one time. Within a JobStep, each Workunit will be scheduled k times before any is scheduled k+1 times, though no guarantee is made about the order of scheduling among different JobSteps, even if they belong to the same Job.
// Validation: max_concurrent must be between 1 and 32767 inclusive.
    integerwu_cpu_timeout // The maximum number of CPU seconds allowed for Workunits in this JobStep. If it is non-zero, the JobStep will not be scheduled on DeviceGroups whose max_wu_cpu_timeout field is less than this field. If zero is specified, the JobStep will be scheduled on all available DeviceGroups, however the JobStep will still be subject to the constraints specified by the max_wu_cpu_timeout field for the DeviceGroup.
// Validation: wu_cpu_timeout must be greater than or equal to 0.
// Validation: wu_cpu_timeout must be less than or equal to wu_clock_timeout.
    integerwu_clock_timeout // The maximum number of wall clock seconds allowed for Workunits in this JobStep. If it is non-zero, the JobStep will not be scheduled on DeviceGroups whose max_wu_clock_timeout field is less than this field. If zero is specified, the JobStep will be scheduled on all available DeviceGroups, however the JobStep will still be subject to the constraints specified by the max_wu_clock_timeout field for the DeviceGroup.
// Validation: wu_clock_timeout must be greater than or equal to 0.
// Validation: wu_cpu_timeout must be less than or equal to wu_clock_timeout.
    booleanwu_generate_done // The automatic Workunit generator will set this flag to true when it is done inserting Workunits. (no-create) (no-update)
    dateTimecreation_time // The time this JobStep was created. (no-create) (no-update)
    dateTimelast_modified // The time this record was last modified. See struct info.
end struct

See also: createJobStep, createJobSteps, createJobStepsWithResourceRequirements, createJobStepWithResourceRequirements, createResultQueue, createWorkunitsFromDataSetsAsync, deleteJobStep, deleteJobSteps, getDataSetsByJobStepWorkunits, getJobStep, getJobSteps, getJobStepsByGuid, getJobStepsByJob, getJobStepsByProgram, getJobStepStatus, getProgramModuleVersionsByJobStep, getResourceRequirementsByJobStep, getResultsByJobStep, getWorkunitsByJobStep, getWorkunitStatesByJobStep, updateJobStep, updateJobSteps


JobStepArrayRange

The JobStepArrayRange object contains an array of JobStep objects, along with a "total" field.

begin struct
    JobStep[]records // An array of JobStep objects. The range of objects in the array is independent of the value in the "total" field.
    integertotal // The total number of objects that matched the criteria of the returning function. This number is calculated prior to applying the caller's range specification.
end struct

See also: getJobSteps


JobStepFilter

The JobStepFilter object is used to filter requests for JobSteps.

begin struct
    guid[]job_step_gid_match // If this vector is nonempty, only records with job_step_gid in this set are selected.
    guid[]job_step_gid_not_match // Only records with job_step_gid not in this set are selected.
    guid[]job_gid_match // If this vector is nonempty, only records with job_gid in this set are selected.
    guid[]job_gid_not_match // Only records with job_gid not in this set are selected.
    stringstate_id_test // Indicates how the state_id_min and state_id_max filter fields are checked (see ADG).
    integerstate_id_min // The value that is matched against the state_id value when enabled.
    integerstate_id_max // The value that is matched against the state_id value when enabled.
    integer[]state_id_in_set // If this vector is nonempty, only records with state_id in this set are selected.
    integer[]state_id_notin_set // Only records with state_id not in this set are selected.
    guid[]program_gid_match // If this vector is nonempty, only records with program_gid in this set are selected.
    guid[]program_gid_not_match // Only records with program_gid not in this set are selected.
    guid[]program_version_gid_match // If this vector is nonempty, only records with program_version_gid in this set are selected.
    guid[]program_version_gid_not_match // Only records with program_version_gid not in this set are selected.
    stringnum_results_test // Indicates how the num_results_min and num_results_max filter fields are checked (see ADG).
    integernum_results_min // The value that is matched against the num_results value when enabled.
    integernum_results_max // The value that is matched against the num_results value when enabled.
    integer[]num_results_in_set // If this vector is nonempty, only records with num_results in this set are selected.
    integer[]num_results_notin_set // Only records with num_results not in this set are selected.
    stringmax_errors_test // Indicates how the max_errors_min and max_errors_max filter fields are checked (see ADG).
    integermax_errors_min // The value that is matched against the max_errors value when enabled.
    integermax_errors_max // The value that is matched against the max_errors value when enabled.
    integer[]max_errors_in_set // If this vector is nonempty, only records with max_errors in this set are selected.
    integer[]max_errors_notin_set // Only records with max_errors not in this set are selected.
    stringmax_concurrent_test // Indicates how the max_concurrent_min and max_concurrent_max filter fields are checked (see ADG).
    integermax_concurrent_min // The value that is matched against the max_concurrent value when enabled.
    integermax_concurrent_max // The value that is matched against the max_concurrent value when enabled.
    integer[]max_concurrent_in_set // If this vector is nonempty, only records with max_concurrent in this set are selected.
    integer[]max_concurrent_notin_set // Only records with max_concurrent not in this set are selected.
    stringwu_cpu_timeout_test // Indicates how the wu_cpu_timeout_min and wu_cpu_timeout_max filter fields are checked (see ADG).
    integerwu_cpu_timeout_min // The value that is matched against the wu_cpu_timeout value when enabled.
    integerwu_cpu_timeout_max // The value that is matched against the wu_cpu_timeout value when enabled.
    integer[]wu_cpu_timeout_in_set // If this vector is nonempty, only records with wu_cpu_timeout in this set are selected.
    integer[]wu_cpu_timeout_notin_set // Only records with wu_cpu_timeout not in this set are selected.
    stringwu_clock_timeout_test // Indicates how the wu_clock_timeout_min and wu_clock_timeout_max filter fields are checked (see ADG).
    integerwu_clock_timeout_min // The value that is matched against the wu_clock_timeout value when enabled.
    integerwu_clock_timeout_max // The value that is matched against the wu_clock_timeout value when enabled.
    integer[]wu_clock_timeout_in_set // If this vector is nonempty, only records with wu_clock_timeout in this set are selected.
    integer[]wu_clock_timeout_notin_set // Only records with wu_clock_timeout not in this set are selected.
    booleanwu_generate_done_active // Indicates that the wu_generate_done_value filter wu_generate_done is checked.
    booleanwu_generate_done_value // The value that is matched against the wu_generate_done value when wu_generate_done_active is true.
    stringcreation_time_test // Indicates how the creation_time_start and creation_time_end filter fields are checked (see ADG).
    dateTimecreation_time_start // The value that is matched against the creation_time value when enabled.
    dateTimecreation_time_end // The value that is matched against the creation_time value when enabled.
    stringlast_modified_test // Indicates how the last_modified_start and last_modified_end filter fields are checked (see ADG).
    dateTimelast_modified_start // The value that is matched against the last_modified value when enabled.
    dateTimelast_modified_end // The value that is matched against the last_modified value when enabled.
end struct

See also: getJobSteps


JobStepStatus

JobStepStatus describes additional information about a JobStep, which is not contained in the JobStep object.

begin struct
    guidjob_step_gid // The primary unique identifier of the JobStep object.
    dateTimegenerated // The time at which the statistics in this JobStepStatus were valid.
    booleanrunnable // This flag indicates whether the JobStep is eligible to be scheduled in the MP Server. It is true if the JobStep.state_id is ENABLED_OPEN or ENABLED_CLOSED; and if the Job.state_id is ENABLED; and if the Program.state_id is ENABLED, CLOSED, or PENDING_DELETE; and if the Application.state_id is ENABLED, CLOSED, or PENDING_DELETE; and if the current time is within the Job start and end times.
    doublecompleted_percent // The percent completion of work in the JobStep. Calculated by the number of Results for the JobStep divided by (the number of Workunits * JobStep.num_results). If num_results is -1, meaning "infinite redundancy", then completed_percent will always be zero.
    integerworkunits_total // Number of Workunits currently in the JobStep. Deleting a Workunit decrements this count.
    integerworkunits_added // Number of Workunits added to the JobStep. Deleting a Workunit does not affect this count.
    integerworkunits_completed // Number of Workunits marked as completed.
    integerdispatch_total // Number of times Workunits have been dispatched. Can be strictly less than results_received + errors_total, since one instance of execution can cause more than one Error.
    integerresults_successful_available // Number of successful results currently in the JobStep. Deleting a successful Result decrements this count.
    integerresults_unsuccessful_available // Number of unsuccessful results currently in the JobStep. Deleting an unsuccessful Result decrements this count.
    integerresults_available // Number of successful and unsuccessful results currently in the JobStep. Deleting a Result decrements this count.
    integerresults_successful_received // Number of successful results returned for the JobStep. Deleting a Result does not affect this count.
    integerresults_unsuccessful_received // Number of unsuccessful results returned for the JobStep. Deleting a Result does not affect this count.
    integerresults_received // Number of successful and unsuccessful results returned for the JobStep. Deleting a Result does not affect this count.
    integerresults_wu_delete // Number of results returned for Workunits that have been deleted.
    integererrors_total // Number of errors currently in the JobStep.
    integercpu_seconds // Total CPU time for the JobStep.
    doublepoints // Total points for the JobStep.
    dateTimefirst_dispatch // Time the first Workunit was dispatched.
    dateTimelast_dispatch // Last time a Workunit was dispatched.
    dateTimefirst_result // Time the first Result was received.
    dateTimelast_result // Last time a Result was received.
end struct

See also: getJobStepStatus


LoginInfo

The LoginInfo object describes authorization info, as returned by login2.

begin struct
    stringauthkey // The opaque security token. (max length 100)
    Useruser // The User affiliated with this LoginInfo.
    Role[]roles // An array of Roles to which this User belongs, including inherited Roles resulting from membership to other enabled UserGroups.
    Privilege[]privileges // An array of Privileges representing whether the user holds the indicated privilege on ANY object in the system.
    integerauth_timeout // The timeout in seconds for which the security token is valid.
end struct

See also: login2


Platform

A Platform identifies a Platform within the system. Platforms uniquely describe execution environments for Devices.

begin struct
    integerplatform_id // The primary unique identifier of this Platform object.
    stringplatform_name // The name of this Platform. (max length 32)
end struct

See also: getAgentModuleByAgentVersionPlatform, getAllPlatforms, getPlatform, getPlatformByName, getPlatformsById


Privilege

A Privilege describes a security access relationship in the system. Privileges are used to tie Users to other objects, in order to grant security permissions.

begin struct
    guidprivilege_gid // The primary unique identifier of this object. (no-create)
    stringprivilege_name // The name of this Privilege. (max length 36)
    stringdescription // The free-form textual description of this Privilege. (max length 200)
end struct

See also: accessCheckObject, accessCheckObjects, addPrivilegesToUserGroup, addPrivilegeToUserGroup, addUserOrGroupsToObjectPrivilege, addUserOrGroupToObjectPrivilege, getAllPrivileges, getPrivilege, getPrivilegeByName, getPrivileges, getPrivilegesByGuid, getPrivilegesByUserGroup, getPrivilegesByUserOrGroupObject, getUserGroupPrivilegesByObject, getUserGroupsByObjectPrivilege, getUserOrGroupPrivilegesByObject, getUserOrGroupsByObjectPrivilege, getUserPrivilegesByObject, getUsersByObjectPrivilege, login2, removePrivilegeFromUserGroup, removePrivilegesFromUserGroup, removeUserOrGroupFromObjectPrivilege, removeUserOrGroupsFromObjectPrivilege, setObjectPrivilegeUserAndGroups, setObjectUserOrGroupPrivileges, setUserGroupPrivileges


PrivilegeArrayRange

The PrivilegeArrayRange object contains an array of Privilege objects, along with a "total" field.

begin struct
    Privilege[]records // An array of Privilege objects. The range of objects in the array is independent of the value in the "total" field.
    integertotal // The total number of objects that matched the criteria of the returning function. This number is calculated prior to applying the caller's range specification.
end struct

See also: getPrivileges


PrivilegeFilter

The PrivilegeFilter object is used to filter requests for Privileges.

begin struct
    guid[]privilege_gid_match // If this vector is nonempty, only records with privilege_gid in this set are selected.
    guid[]privilege_gid_not_match // Only records with privilege_gid not in this set are selected.
    stringprivilege_name_regex // If this privilege_name is nonempty, only records with privilege_name matching this regular expression are selected.
    stringdescription_regex // If this description is nonempty, only records with description matching this regular expression are selected.
end struct

See also: getPrivileges


Program

The Program is the highest level object in the system which describes executables that may be used in Workunits sent to Devices. A Program contains ProgramVersions, and may define one of the ProgramVersions as current.

begin struct
    guidprogram_gid // The primary unique identifier of this Program object. (no-create)
    stringprogram_name // The unique name of this Program. (max length 36)
// Validation: program_name must not have leading spaces.
// Validation: program_name must not have trailing spaces.
// Validation: program_name must not be empty.
    integerstate_id // The state of this object.
// Valid states:
//    0 (Disabled): No new job steps accepted, no job steps will run
//    1 (Enabled, Open): New job steps accepted, job steps will run
//    2 (Suspended, Open): New job steps accepted, but no job steps will run
//    3 (Enabled, Closed): No new job steps accepted, existing job steps continue running
//    9 (Pending Delete): Delete as soon as no more job steps exist, no new job steps accepted, existing job steps continue running
    integerschedule_type_id // The scheduling policy that should be used when dispatching Workunits for this Program (0 for "shared" scheduling, 1 for "gang" scheduling). (no-update)
// Valid states:
//    0 (Shared): Shared scheduled (default)
//    1 (Gang): Gang scheduled (MPI)
    guidcurrent_version_gid // The identifier of the current ProgramVersion for this Program. This field may be the null GUID if there is no current ProgramVersion. If NULL, it will automatically be set to the guid of the next ProgramVersion which is created.
    dateTimecreation_time // The time this Program was created. (no-create) (no-update)
    dateTimelast_modified // The time this record was last modified. See struct info.
    stringdescription // A description of this Program. (max length 500)
    stringannotation // Reserved for custom use by application developers. (max length 1000)
end struct

See also: addProgramsToApplication, addProgramsToDeviceProfile, addProgramToApplication, addProgramToDeviceProfile, createProgram, createPrograms, deleteProgram, deletePrograms, getAllPrograms, getApplicationsByProgram, getJobStepsByProgram, getProgram, getProgramByName, getProgramModulesByProgram, getPrograms, getProgramsByApplication, getProgramsByDeviceProfile, getProgramsByGuid, getProgramVersionsByProgram, removeProgramFromApplication, removeProgramFromDeviceProfile, removeProgramsFromApplication, removeProgramsFromDeviceProfile, setApplicationPrograms, setDeviceProfilePrograms, updateProgram, updatePrograms


ProgramArrayRange

The ProgramArrayRange object contains an array of Program objects, along with a "total" field.

begin struct
    Program[]records // An array of Program objects. The range of objects in the array is independent of the value in the "total" field.
    integertotal // The total number of objects that matched the criteria of the returning function. This number is calculated prior to applying the caller's range specification.
end struct

See also: getPrograms


ProgramFilter

The ProgramFilter object is used to filter requests for Programs.

begin struct
    guid[]program_gid_match // If this vector is nonempty, only records with program_gid in this set are selected.
    guid[]program_gid_not_match // Only records with program_gid not in this set are selected.
    stringprogram_name_regex // If this program_name is nonempty, only records with program_name matching this regular expression are selected.
    stringstate_id_test // Indicates how the state_id_min and state_id_max filter fields are checked (see ADG).
    integerstate_id_min // The value that is matched against the state_id value when enabled.
    integerstate_id_max // The value that is matched against the state_id value when enabled.
    integer[]state_id_in_set // If this vector is nonempty, only records with state_id in this set are selected.
    integer[]state_id_notin_set // Only records with state_id not in this set are selected.
    stringschedule_type_id_test // Indicates how the schedule_type_id_min and schedule_type_id_max filter fields are checked (see ADG).
    integerschedule_type_id_min // The value that is matched against the schedule_type_id value when enabled.
    integerschedule_type_id_max // The value that is matched against the schedule_type_id value when enabled.
    integer[]schedule_type_id_in_set // If this vector is nonempty, only records with schedule_type_id in this set are selected.
    integer[]schedule_type_id_notin_set // Only records with schedule_type_id not in this set are selected.
    guid[]current_version_gid_match // If this vector is nonempty, only records with current_version_gid in this set are selected.
    guid[]current_version_gid_not_match // Only records with current_version_gid not in this set are selected.
    stringcreation_time_test // Indicates how the creation_time_start and creation_time_end filter fields are checked (see ADG).
    dateTimecreation_time_start // The value that is matched against the creation_time value when enabled.
    dateTimecreation_time_end // The value that is matched against the creation_time value when enabled.
    stringlast_modified_test // Indicates how the last_modified_start and last_modified_end filter fields are checked (see ADG).
    dateTimelast_modified_start // The value that is matched against the last_modified value when enabled.
    dateTimelast_modified_end // The value that is matched against the last_modified value when enabled.
    stringdescription_regex // If this description is nonempty, only records with description matching this regular expression are selected.
    stringannotation_regex // If this annotation is nonempty, only records with annotation matching this regular expression are selected.
end struct

See also: getPrograms


ProgramModule

The ProgramModule describes the ProgramVersion for a given Platform in the system. A ProgramModule belongs to a single ProgramVersion and contains ProgramModuleVersions.

begin struct
    guidprogram_module_gid // The primary unique identifier of this ProgramModule object.
    guidprogram_version_gid // The ProgramVersion identifier to which this object applies. Must point to a valid ProgramVersion. (no-update)
    integerplatform_id // The Platform identifier to which this object applies. Must point to a valid Platform. (no-update)
    dateTimecreation_time // The time this ProgramModule was created. (no-create) (no-update)
    dateTimelast_modified // The time this record was last modified. See struct info.
    guidcurrent_version_gid // The identifier of the current ProgramModuleVersion for this Program. This field may be the null GUID if there is no current ProgramModuleVersion. If NULL, it will automatically be set to the guid of the next ProgramModuleVersion which is created.
    stringdescription // The free-form textual description of this ProgramModule. (max length 500)
end struct

See also: createProgramModule, createProgramModules, deleteGlobalResourceRequirement, deleteProgramModule, deleteProgramModules, deleteResourceRequirement, getGlobalResourceRequirementsByProgramModule, getProgramModule, getProgramModules, getProgramModulesByGuid, getProgramModulesByProgram, getProgramModulesByProgramVersion, getProgramModuleVersionsByProgramModule, getResourceRequirementsByProgramModule, updateProgramModule, updateProgramModules


ProgramModuleArrayRange

The ProgramModuleArrayRange object contains an array of ProgramModule objects, along with a "total" field.

begin struct
    ProgramModule[]records // An array of ProgramModule objects. The range of objects in the array is independent of the value in the "total" field.
    integertotal // The total number of objects that matched the criteria of the returning function. This number is calculated prior to applying the caller's range specification.
end struct

See also: getProgramModules


ProgramModuleFilter

The ProgramModuleFilter object is used to filter requests for ProgramModules.

begin struct
    guid[]program_module_gid_match // If this vector is nonempty, only records with program_module_gid in this set are selected.
    guid[]program_module_gid_not_match // Only records with program_module_gid not in this set are selected.
    guid[]program_version_gid_match // If this vector is nonempty, only records with program_version_gid in this set are selected.
    guid[]program_version_gid_not_match // Only records with program_version_gid not in this set are selected.
    stringplatform_id_test // Indicates how the platform_id_min and platform_id_max filter fields are checked (see ADG).
    integerplatform_id_min // The value that is matched against the platform_id value when enabled.
    integerplatform_id_max // The value that is matched against the platform_id value when enabled.
    integer[]platform_id_in_set // If this vector is nonempty, only records with platform_id in this set are selected.
    integer[]platform_id_notin_set // Only records with platform_id not in this set are selected.
    stringcreation_time_test // Indicates how the creation_time_start and creation_time_end filter fields are checked (see ADG).
    dateTimecreation_time_start // The value that is matched against the creation_time value when enabled.
    dateTimecreation_time_end // The value that is matched against the creation_time value when enabled.
    stringlast_modified_test // Indicates how the last_modified_start and last_modified_end filter fields are checked (see ADG).
    dateTimelast_modified_start // The value that is matched against the last_modified value when enabled.
    dateTimelast_modified_end // The value that is matched against the last_modified value when enabled.
    guid[]current_version_gid_match // If this vector is nonempty, only records with current_version_gid in this set are selected.
    guid[]current_version_gid_not_match // Only records with current_version_gid not in this set are selected.
    stringdescription_regex // If this description is nonempty, only records with description matching this regular expression are selected.
end struct

See also: getProgramModules


ProgramModuleVersion

The ProgramModuleVersion defines file-level information for the executable of a Program in the system. A ProgramModuleVersion belongs to a single ProgramModule.

begin struct
    guidprogram_module_version_gid // The primary unique identifier of this ProgramModuleVersion. (no-create)
    guidprogram_module_gid // The identifier of the ProgramModule to which this ProgramModuleVersion belongs. (no-update)
// Validation: program_module_gid must not be the NULL guid.
    stringprogram_module_version // The version of ProgramModule. This should be whatever versioning system the original software uses. This case-sensitive string must be unique within a ProgramModule. (max length 50)
// Validation: program_module_version must not have leading spaces.
// Validation: program_module_version must not have trailing spaces.
// Validation: program_module_version must not be empty.
    sha1executable_hash // The sha1 of the program module file. (required)
// Validation: executable_hash must not be the NULL SHA1.
    longexecutable_size // The size of the ProgramModule file in bytes. (required)
// Validation: executable_size must be positive.
    dateTimecreation_time // The time this ProgramModuleVersion was created. (no-create) (no-update)
    stringoriginal_filename // This is a user-specified annotative field. It is intended to denote the original executable filename on disk that this ProgramModuleVersion had, prior to being uploaded into the Grid MP platform. (However it can hold any additional descriptive information, if the need arises.) (max length 260)
    stringdescription // The free-form textual description of the ProgramModuleVersion. (max length 500)
end struct

See also: createProgramModuleVersion, createProgramModuleVersions, deleteProgramModuleVersion, deleteProgramModuleVersions, getProgramModuleVersion, getProgramModuleVersions, getProgramModuleVersionsByGuid, getProgramModuleVersionsByJobStep, getProgramModuleVersionsByProgramModule


ProgramModuleVersionArrayRange

The ProgramModuleVersionArrayRange object contains an array of ProgramModuleVersion objects, along with a "total" field.

begin struct
    ProgramModuleVersion[]records // An array of ProgramModuleVersion objects. The range of objects in the array is independent of the value in the "total" field.
    integertotal // The total number of objects that matched the criteria of the returning function. This number is calculated prior to applying the caller's range specification.
end struct

See also: getProgramModuleVersions


ProgramModuleVersionFilter

The ProgramModuleVersionFilter object is used to filter requests for ProgramModuleVersions.

begin struct
    guid[]program_module_version_gid_match // If this vector is nonempty, only records with program_module_version_gid in this set are selected.
    guid[]program_module_version_gid_not_match // Only records with program_module_version_gid not in this set are selected.
    guid[]program_module_gid_match // If this vector is nonempty, only records with program_module_gid in this set are selected.
    guid[]program_module_gid_not_match // Only records with program_module_gid not in this set are selected.
    stringprogram_module_version_regex // If this program_module_version is nonempty, only records with program_module_version matching this regular expression are selected.
    sha1[]executable_hash_match // If this vector is nonempty, only records with executable_hash in this set are selected.
    stringexecutable_size_test // Indicates how the executable_size_min and executable_size_max filter fields are checked (see ADG).
    longexecutable_size_min // The value that is matched against the executable_size value when enabled.
    longexecutable_size_max // The value that is matched against the executable_size value when enabled.
    long[]executable_size_in_set // If this vector is nonempty, only records with executable_size in this set are selected.
    long[]executable_size_notin_set // Only records with executable_size not in this set are selected.
    stringcreation_time_test // Indicates how the creation_time_start and creation_time_end filter fields are checked (see ADG).
    dateTimecreation_time_start // The value that is matched against the creation_time value when enabled.
    dateTimecreation_time_end // The value that is matched against the creation_time value when enabled.
    stringoriginal_filename_regex // If this original_filename is nonempty, only records with original_filename matching this regular expression are selected.
    stringdescription_regex // If this description is nonempty, only records with description matching this regular expression are selected.
end struct

See also: getProgramModuleVersions


ProgramVersion

The ProgramVersion describes scheduling information for a version of a Program in the system. A ProgramVersion belongs to a single Program and contains ProgramModules.

begin struct
    guidprogram_version_gid // The primary unique identifier of this ProgramVersion. (no-create)
    guidprogram_gid // The identifier of the Program object to which this ProgramVersion belongs. (no-update)
// Validation: program_gid must not be the NULL guid.
    stringprogram_version // The version of the Program. This should use whatever versioning system the original software uses. This case-sensitive string must be unique within a Program. (max length 50)
// Validation: program_version must not have leading spaces.
// Validation: program_version must not have trailing spaces.
// Validation: program_version must not be empty.
    integerstate_id // The state of the ProgramVersion.
// Valid states:
//    0 (Disabled): No JobSteps can be created with this ProgramVersion.
//    1 (Enabled): JobSteps can be created with this ProgramVersion.
    dateTimecreation_time // The time this ProgramVersion was created. (no-create) (no-update)
    dateTimelast_modified // The time this record was last modified. See struct info.
    stringdescription // The free-form textual description of this object. (max length 500)
end struct

See also: createProgramVersion, createProgramVersions, deleteProgramVersion, deleteProgramVersions, getProgramModulesByProgramVersion, getProgramVersion, getProgramVersions, getProgramVersionsByGuid, getProgramVersionsByProgram, updateProgramVersion, updateProgramVersions


ProgramVersionArrayRange

The ProgramVersionArrayRange object contains an array of ProgramVersion objects, along with a "total" field.

begin struct
    ProgramVersion[]records // An array of ProgramVersion objects. The range of objects in the array is independent of the value in the "total" field.
    integertotal // The total number of objects that matched the criteria of the returning function. This number is calculated prior to applying the caller's range specification.
end struct

See also: getProgramVersions


ProgramVersionFilter

The ProgramVersionFilter object is used to filter requests for ProgramVersions.

begin struct
    guid[]program_version_gid_match // If this vector is nonempty, only records with program_version_gid in this set are selected.
    guid[]program_version_gid_not_match // Only records with program_version_gid not in this set are selected.
    guid[]program_gid_match // If this vector is nonempty, only records with program_gid in this set are selected.
    guid[]program_gid_not_match // Only records with program_gid not in this set are selected.
    stringprogram_version_regex // If this program_version is nonempty, only records with program_version matching this regular expression are selected.
    stringstate_id_test // Indicates how the state_id_min and state_id_max filter fields are checked (see ADG).
    integerstate_id_min // The value that is matched against the state_id value when enabled.
    integerstate_id_max // The value that is matched against the state_id value when enabled.
    integer[]state_id_in_set // If this vector is nonempty, only records with state_id in this set are selected.
    integer[]state_id_notin_set // Only records with state_id not in this set are selected.
    stringcreation_time_test // Indicates how the creation_time_start and creation_time_end filter fields are checked (see ADG).
    dateTimecreation_time_start // The value that is matched against the creation_time value when enabled.
    dateTimecreation_time_end // The value that is matched against the creation_time value when enabled.
    stringlast_modified_test // Indicates how the last_modified_start and last_modified_end filter fields are checked (see ADG).
    dateTimelast_modified_start // The value that is matched against the last_modified value when enabled.
    dateTimelast_modified_end // The value that is matched against the last_modified value when enabled.
    stringdescription_regex // If this description is nonempty, only records with description matching this regular expression are selected.
end struct

See also: getProgramVersions


Resource

The Resource object represents a property that Devices can provide (ResourceAvailable) and that ProgramModules can require (ResourceRequirement). Some Resources are maintained by the system and are marked as such by the predefined flag. A list of all predefined Resources can be obtained by calling getAllResources, and looking at the objects with the predefined field set. There are also GlobalResources which have global counts, and are used to limit the number of concurrent instances of any ProgramModule which requires a particular GlobalResource. Note that Resource objects do not have the notion of a global pool. Use Resource and GlobalResource together to express the notion of something which is only available to some Devices, yet also has a limited total global count.

begin struct
    guidresource_gid // The primary unique identifier of this object. (no-create)
    stringresource_name // A globally unique, human readable name which describes the actual resource this object tracks. (max length 64) (required)
// Validation: resource_name must not have leading spaces.
// Validation: resource_name must not have trailing spaces.
// Validation: resource_name must not be empty.
    booleanpredefined // 1 if the Resource is system maintained, 0 if the Resource was created by a User. (no-create) (no-update)
    dateTimecreation_time // The time this Resource was created. (no-create) (no-update)
    dateTimelast_modified // The time this record was last modified. See struct info.
end struct

See also: createGlobalResource, createResource, createResources, deleteGlobalResource, deleteResource, deleteResourceAvailable, deleteResourceRequirement, deleteResources, getAllResources, getGlobalResource, getGlobalResourceRequirementsByGlobalResource, getResource, getResourceAvailablesByResource, getResourceByName, getResourceRequirementsByResource, getResources, getResourcesByGuid, updateGlobalResource


ResourceArrayRange

The ResourceArrayRange object contains an array of Resource objects, along with a "total" field.

begin struct
    Resource[]records // An array of Resource objects. The range of objects in the array is independent of the value in the "total" field.
    integertotal // The total number of objects that matched the criteria of the returning function. This number is calculated prior to applying the caller's range specification.
end struct

See also: getResources


ResourceAvailable

Devices can provide Resources for use by Jobs. The ResourceAvailable object expresses the amount available of a given Resource for a given Device. See the description of the Resource and ResourceRequirement objects for more information.

begin struct
    guiddevice_gid // The identifier of the Device which has the Resource. (required)
    guidresource_gid // The identifier of the Resource which is available to the Device. The Resource cannot be a predefined Resource, as those are maintained by the system. (required)
    integeramount_available // The amount of the Resource available to the Device.
end struct

See also: deleteResourceAvailable, getAllResourceAvailables, getResourceAvailablesByDevice, getResourceAvailablesByResource, setResourceAvailable, setResourceAvailables


ResourceFilter

The ResourceFilter object is used to filter requests for Resources.

begin struct
    guid[]resource_gid_match // If this vector is nonempty, only records with resource_gid in this set are selected.
    guid[]resource_gid_not_match // Only records with resource_gid not in this set are selected.
    stringresource_name_regex // If this resource_name is nonempty, only records with resource_name matching this regular expression are selected.
    booleanpredefined_active // Indicates that the predefined_value filter predefined is checked.
    booleanpredefined_value // The value that is matched against the predefined value when predefined_active is true.
    stringcreation_time_test // Indicates how the creation_time_start and creation_time_end filter fields are checked (see ADG).
    dateTimecreation_time_start // The value that is matched against the creation_time value when enabled.
    dateTimecreation_time_end // The value that is matched against the creation_time value when enabled.
    stringlast_modified_test // Indicates how the last_modified_start and last_modified_end filter fields are checked (see ADG).
    dateTimelast_modified_start // The value that is matched against the last_modified value when enabled.
    dateTimelast_modified_end // The value that is matched against the last_modified value when enabled.
end struct

See also: getResources


ResourceRequirement

ProgramModule objects express numeric requirements for Resources through ResourceRequirement objects. JobSteps which use this ProgramModule inherit all of its ResourceRequirements, though they can be overridden. The requirement can be one of any six comparison operations (for example, "greater than"). During scheduling, the amount_required is compared with the amount_available field of the Device's ResourceAvailable object for this Resource using the specified operation. If the operation is satisfied, then the ResourceRequirement is met, and will not prohibit the JobStep from running. For example, if the amount_required is 5, and the operation is "greater than", only a Device which can provide 6 or more of this Resource could be scheduled.

begin struct
    guidprogram_module_gid // The identifier of the ProgramModule which requires this Resource. JobSteps which use this ProgramModule inherit this ResourceRequirement. (required)
    guidresource_gid // The identifier of the required Resource. (required)
    integeroperation // Specifies the comparison operation used to determine whether or not a particular Device satisfies this requirement.
// Valid states:
//    0 (): not compared to
//    1 (>): greater than
//    2 (>=): greater than or equal to
//    3 (<): less than
//    4 (<=): less than or equal to
//    5 (=): equal to
//    6 (<>): not equal to
    integeramount_required // This amount with which to compare the amount a Device provides.
end struct

See also: createJobStepsWithResourceRequirements, createJobStepWithResourceRequirements, deleteGlobalResourceRequirement, deleteResourceRequirement, getAllGlobalResourceRequirements, getAllResourceRequirements, getGlobalResourceRequirementsByGlobalResource, getGlobalResourceRequirementsByProgramModule, getResourceRequirementsByJobStep, getResourceRequirementsByProgramModule, getResourceRequirementsByResource, setGlobalResourceRequirement, setGlobalResourceRequirements, setResourceRequirement, setResourceRequirements


Result

The Result object describes the result of the execution of a Workunit on a particular Device. Results belong to a single JobStep.

begin struct
    integerresult_uid // The primary unique identifier of this Result object.
    guidprogram_gid // The identifier of the Program for which this Result was returned.
    guidjob_gid // The identifier of the Job for which this Result was returned.
    guidjob_step_gid // The identifier of the JobStep for which this Result was returned.
    guidworkunit_gid // The identifier of the Workunit for which this Result was returned.
    integerworkunit_index // The index of the Workunit for which this Result was returned.
    guiddevice_gid // The identifier of the Device which returned this result.
    integerplatform_id // The identifier of the Platform of the Device.
    integercpu_seconds // The number of seconds of CPU time consumed by the program module in creating this result.
    dateTimereceived // The time at which this Result was received by the server.
    dateTimesent // The time the Device was sent the Workunit for this Result.
    booleansuccess // True if this Result is considered successful.
    integerexit_code // The actual exit code from the program.
    stringfailure_info // Additional failure information, if success is false. (max length 1000)
    sha1result_hash // The SHA1 of this Result file.
    longresult_size // The file size of this Result file.
end struct

See also: createResultQueue, deleteResult, deleteResultQueue, deleteResults, getResult, getResults, getResultsById, getResultsByJobStep, getResultsByResultQueue, getResultsByWorkunit, removeResultsFromResultQueue


ResultArrayRange

The ResultArrayRange object contains an array of Result objects, along with a "total" field.

begin struct
    Result[]records // An array of Result objects. The range of objects in the array is independent of the value in the "total" field.
    integertotal // The total number of objects that matched the criteria of the returning function. This number is calculated prior to applying the caller's range specification.
end struct

See also: getResults


ResultFilter

The ResultFilter object is used to filter requests for Results.

begin struct
    stringresult_uid_test // Indicates how the result_uid_min and result_uid_max filter fields are checked (see ADG).
    integerresult_uid_min // The value that is matched against the result_uid value when enabled.
    integerresult_uid_max // The value that is matched against the result_uid value when enabled.
    integer[]result_uid_in_set // If this vector is nonempty, only records with result_uid in this set are selected.
    integer[]result_uid_notin_set // Only records with result_uid not in this set are selected.
    guid[]program_gid_match // If this vector is nonempty, only records with program_gid in this set are selected.
    guid[]program_gid_not_match // Only records with program_gid not in this set are selected.
    guid[]job_gid_match // If this vector is nonempty, only records with job_gid in this set are selected.
    guid[]job_gid_not_match // Only records with job_gid not in this set are selected.
    guid[]job_step_gid_match // If this vector is nonempty, only records with job_step_gid in this set are selected.
    guid[]job_step_gid_not_match // Only records with job_step_gid not in this set are selected.
    guid[]workunit_gid_match // If this vector is nonempty, only records with workunit_gid in this set are selected.
    guid[]workunit_gid_not_match // Only records with workunit_gid not in this set are selected.
    stringworkunit_index_test // Indicates how the workunit_index_min and workunit_index_max filter fields are checked (see ADG).
    integerworkunit_index_min // The value that is matched against the workunit_index value when enabled.
    integerworkunit_index_max // The value that is matched against the workunit_index value when enabled.
    integer[]workunit_index_in_set // If this vector is nonempty, only records with workunit_index in this set are selected.
    integer[]workunit_index_notin_set // Only records with workunit_index not in this set are selected.
    guid[]device_gid_match // If this vector is nonempty, only records with device_gid in this set are selected.
    guid[]device_gid_not_match // Only records with device_gid not in this set are selected.
    stringplatform_id_test // Indicates how the platform_id_min and platform_id_max filter fields are checked (see ADG).
    integerplatform_id_min // The value that is matched against the platform_id value when enabled.
    integerplatform_id_max // The value that is matched against the platform_id value when enabled.
    integer[]platform_id_in_set // If this vector is nonempty, only records with platform_id in this set are selected.
    integer[]platform_id_notin_set // Only records with platform_id not in this set are selected.
    stringcpu_seconds_test // Indicates how the cpu_seconds_min and cpu_seconds_max filter fields are checked (see ADG).
    integercpu_seconds_min // The value that is matched against the cpu_seconds value when enabled.
    integercpu_seconds_max // The value that is matched against the cpu_seconds value when enabled.
    integer[]cpu_seconds_in_set // If this vector is nonempty, only records with cpu_seconds in this set are selected.
    integer[]cpu_seconds_notin_set // Only records with cpu_seconds not in this set are selected.
    stringreceived_test // Indicates how the received_start and received_end filter fields are checked (see ADG).
    dateTimereceived_start // The value that is matched against the received value when enabled.
    dateTimereceived_end // The value that is matched against the received value when enabled.
    stringsent_test // Indicates how the sent_start and sent_end filter fields are checked (see ADG).
    dateTimesent_start // The value that is matched against the sent value when enabled.
    dateTimesent_end // The value that is matched against the sent value when enabled.
    booleansuccess_active // Indicates that the success_value filter success is checked.
    booleansuccess_value // The value that is matched against the success value when success_active is true.
    stringexit_code_test // Indicates how the exit_code_min and exit_code_max filter fields are checked (see ADG).
    integerexit_code_min // The value that is matched against the exit_code value when enabled.
    integerexit_code_max // The value that is matched against the exit_code value when enabled.
    integer[]exit_code_in_set // If this vector is nonempty, only records with exit_code in this set are selected.
    integer[]exit_code_notin_set // Only records with exit_code not in this set are selected.
    stringfailure_info_regex // If this failure_info is nonempty, only records with failure_info matching this regular expression are selected.
    sha1[]result_hash_match // If this vector is nonempty, only records with result_hash in this set are selected.
    stringresult_size_test // Indicates how the result_size_min and result_size_max filter fields are checked (see ADG).
    longresult_size_min // The value that is matched against the result_size value when enabled.
    longresult_size_max // The value that is matched against the result_size value when enabled.
    long[]result_size_in_set // If this vector is nonempty, only records with result_size in this set are selected.
    long[]result_size_notin_set // Only records with result_size not in this set are selected.
end struct

See also: getResults


Role

The Role object describes an access control permission that may be associated with a User or UserGroup in order to grant the ability to perform certain actions.

begin struct
    guidrole_gid // The primary unique identifier of this object.
    stringrole_name // The name of this Role. (max length 36)
    stringdescription // The free-form textual description of this Role. (max length 200)
end struct

See also: accessCheck, addUserOrGroupsToRole, addUserOrGroupToRole, getAllRoles, getCountUserGroupsByRole, getCountUsersByRole, getRole, getRoleByName, getRoles, getRolesByGuid, getRolesByUserOrGroup, getUserGroupsByRole, getUserOrGroupsByRole, getUsersByRole, login2, removeUserOrGroupFromRole, removeUserOrGroupsFromRole, setRoleUserAndGroups, setUserOrGroupRoles


RoleArrayRange

The RoleArrayRange object contains an array of Role objects, along with a "total" field.

begin struct
    Role[]records // An array of Role objects. The range of objects in the array is independent of the value in the "total" field.
    integertotal // The total number of objects that matched the criteria of the returning function. This number is calculated prior to applying the caller's range specification.
end struct

See also: getRoles


RoleFilter

The RoleFilter object is used to filter requests for Roles.

begin struct
    guid[]role_gid_match // If this vector is nonempty, only records with role_gid in this set are selected.
    guid[]role_gid_not_match // Only records with role_gid not in this set are selected.
    stringrole_name_regex // If this role_name is nonempty, only records with role_name matching this regular expression are selected.
    stringdescription_regex // If this description is nonempty, only records with description matching this regular expression are selected.
end struct

See also: getRoles


SchedulingDescriptor

The SchedulingDescriptor object describes the scheduling priority for a User or UserGroup, on an associated DeviceGroup.

begin struct
    guidscheduling_descriptor_gid // The primary unique identifier of this object. (no-create)
    guiddevice_group_gid // The identifier of the DeviceGroup to which this object belongs. (no-update)
// Validation: device_group_gid must not be the NULL guid.
    guiduser_or_group_gid // The identifier of the User or UserGroup to which this object applies. (no-update)
// Validation: user_or_group_gid must not be the NULL guid.
    integerpriority // The priority with which the set of this User's Jobs will run. (But note that each individual Job may get a varying slice of this User's allocation of throughput, as determined by Job.priority field.) Zero denies access. (required)
// Validation: priority must be between 0 and 100 inclusive.
    dateTimecreation_time // The time this SchedulingDescriptor was created. (no-create) (no-update)
    dateTimelast_modified // The time this record was last modified. See struct info.
end struct

See also: createSchedulingDescriptor, createSchedulingDescriptors, deleteSchedulingDescriptor, deleteSchedulingDescriptors, getAllSchedulingDescriptors, getSchedulingDescriptor, getSchedulingDescriptorsByDeviceGroup, getSchedulingDescriptorUserGroupsByDeviceGroup, getSchedulingDescriptorUsersByDeviceGroup, updateSchedulingDescriptor, updateSchedulingDescriptors


Service

The Service object describes status information about a Service within the system. The Service object also provides a way to send commands to a Service. A Service may or may not belong to a ServiceManager.

begin struct
    guidservice_gid // The primary unique identifier of this object. (no-create)
    guidservice_manager_gid // GUID of the ServiceManager for this Service. May be null to indicate an orphaned Service. (no-update)
    stringservice_name // The name of the Service. Unique in combination with service_manager_gid. (max length 36)
// Validation: service_name must not have leading spaces.
// Validation: service_name must not have trailing spaces.
// Validation: service_name must not be empty.
    integertype_id // The Service type.
// Valid states:
//    0 (Unknown service):
//    4 (Realm Service): Handles Device registration and logins.
//    5 (Dispatch Service): Dispatches Workunits to Devices.
//    6 (Poll Service): Gathers periodic status information from Devices.
//    7 (File Service): Sends/recieves files for Devices and Users..
//    8 (Application Service): Application specific support.
    stringurl // The Service URL. (max length 200)
    integerrequest_id // The current request for the given Service. Changing this makes a request for the given Service to take an action.
// Valid states:
//    1 (Start): Service requested to start.
//    2 (Stop): Service requested to stop.
//    3 (Restart): Service requested to restart.
    integerstatus_id // The current status for the given Service. This field should only be changed by the Service itself or by the Service Manager. This field informs users what state the Service is currently in.
// Valid states:
//    1 (Starting): Service requested to start. Responding to request.
//    2 (Running): Service currently up and running.
//    3 (Restarting): Service requested to restart. Responding to request.
//    4 (Stopping): Service requested to stop. Responding to request.
//    5 (Stopped): Service is offline.
//    6 (Error): Service has encountered an error.
    dateTimestart_time // Time that the Service last started. This field will always report a time, even if the Service isn't currently running. When a service is first added, this will be set to the time the Service Manager registered the service with the system.
    dateTimelast_ping // Time of the last ping sent by this Service. This is updated by the Realm, Dispatch, and Poll Service periodically. (no-create) (no-update)
    integerconns_max // Maximum number of simultaneous incoming connections supported by the Service. (no-create) (no-update)
    integerconns_used // Number of simultaneous incoming connections currently connected to the Service. (no-create) (no-update)
    integerthreads_max // Allocated maximum number of worker threads for processing active connections. (no-create) (no-update)
    integerthreads_used // Number of threads that are currently processing active connections. (no-create) (no-update)
    doublerpc_count // Cumulative number of connection requests serviced since startup. (no-create) (no-update)
    doublebytes_in // Cumulative number of request payload bytes read from processed connections. (no-create) (no-update)
    doublebytes_out // Cumulative number of response payload bytes sent during connection processing. (no-create) (no-update)
    doublerpcs_sec // Average rate of new connections since the last ping update. (no-create) (no-update)
    doublebytes_sec_in // Average rate of incoming request payload data since the last ping update. (no-create) (no-update)
    doublebytes_sec_out // Average rate of outgoing response payload data since the last ping update. (no-create) (no-update)
    dateTimelast_modified // The time this record was last modified. See struct info.
end struct

See also: createService, createServices, deleteService, deleteServices, getAllServices, getService, getServicesByServiceManager, queryServicesByServiceManager, updateService, updateServiceStatus


ServiceManager

The ServiceManager object describes status information about a Service Manager within the system. The ServiceManager object also provides a way to send commands to a Service Manager. A ServiceManager contains zero or more Services.

begin struct
    guidservice_manager_gid // The primary unique identifier of this object. (no-create)
    stringservice_manager_name // The unique name of this ServiceManager. (max length 36)
// Validation: service_manager_name must not have leading spaces.
// Validation: service_manager_name must not have trailing spaces.
// Validation: service_manager_name must not be empty.
    dateTimestart_time // Time that the Service Manager last started. This field will always report a time, even if the Service Manager isn't currently running. When a Service Manager is first added, this will be set to the time the Service Manager registered itself with the system.
    dateTimelast_poll // Time that the Service Manager last polled the system. Initialized to the time the ServiceManager was created. (no-create)
    dateTimelast_modified // The time this record was last modified. See struct info.
end struct

See also: createServiceManager, deleteServiceManager, getAllServiceManagers, getServiceManager, getServiceManagerByName, getServicesByServiceManager, queryServiceManager, queryServicesByServiceManager, updateServiceManager


StatsDevice

The StatsDevice object describes more information about a Device, not contained in the Device object.

begin struct
    guiddevice_gid // The identifier of this Device object.
    stringdevice_name // The name of this Device object. (max length 255)
    integerstate_id // The Device state.
    stringstate_name // Descriptive text corresponding to state_id. This text is for informational and display purposes only, and client programs should not rely on the contents of this field as it may be subject to changes or localization. (max length 100)
    integerstatus_id // The connectivity status of the Device, based on the last_contact.
// Valid states:
//    0 (Connected): Device is regularly contacting any GridMP Service.
//    1 (Disconnected): Device has not contacted any GridMP Service within the 'System: Device dormant seconds.' period.
//    2 (Dormant): Device has not contacted any GridMP Service within the 'System: Device disconnected seconds.' period.
    stringstatus_name // Descriptive text corresponding to status_id. (max length 100)
    guiddevice_group_gid // The identifier of the DeviceGroup to which this Device belongs.
    stringdevice_group_name // The name of the DeviceGroup to which this Device belongs. (max length 36)
    StatsDeviceWorkunit[]stats_device_workunits // Array containing details about all Workunits currently being executed on the Device at the time of the last Poll communication.
    doublecpu_whetstones // The whetstone rating of the Device.
    integermemory_physical // Amount of total physical RAM installed on Device (in megabytes).
    integerdisk_total // Total size of the partition that the Agent is installed on (in megabytes).
    integerdisk_free // The total number of free megabytes available to the agent without deleting items from the cache.
    integerdisk_usage_agent // The total number of megabytes used by the Agent on the Device. This includes any files cached on the Agent, such as Datas or Program files, and any file on disk in the Agent directory during execution of a Workunit.
    dateTimelast_contact // Timestamp of when the last communication between the Device and any GridMP Service was made.
    stringip_addr // Network TCP/IP address of the Device when the last communication with any GridMP Service was made. (max length 15)
    integercpu_usage_agent // Total CPU used by Agent and all currently running Programs launched by the Agent (may be greater than 100% if multiproc).
    integeruser_activity_seconds // Elapsed time (in seconds, at the time of the last Poll Service communication) since the last detected interactive user activity on the Device. In some environments, the Agent will report a value of 86313600 seconds (ie: 999 days) when an idle activity duration cannot be authoritatively measured.
    integercpu_usage_other // Total CPU used by external processes running on the machine (may be greater than 100% if multiproc).
    integermemory_used_percent // Overall percentage of physical memory being used by all processes on the entire Device, including non-Agent processes.
    integerdisk_page_rate // System disk paging rate (in pages/sec) reported during the last Poll Service communication. This figure represents the overall disk activity by the entire Device, including non-Agent processes.
    integersuspended_seconds // If non-zero, then this specifies long (in seconds, at the time of the last Poll Service communication) the Agent has most recently been unable to execute Workunits (due to device load thresholds, execution schedule, or manually triggered snooze).
    stringsuspended_reason // If the workunit is currently suspended/snoozed, specifies a brief description of why it is not executing. (max length 32)
end struct

See also: getStatsDevice, getStatsDevicesByDeviceGroup


StatsDeviceGroup

The StatsDeviceGroup object describes more information about a DeviceGroup, not contained in the DeviceGroup object.

begin struct
    guiddevice_group_gid // The primary unique identifier of this object.
    stringdevice_group_name // The unique name of the DeviceGroup. (max length 36)
    integerstate_id // The DeviceGroup state.
// Valid states:
//    0 (Disabled): Devices in this DeviceGroup will not be sent any more Workunits.
//    1 (Enabled): Devices in this DeviceGroup may be sent Workunits.
    stringstate_name // Descriptive text corresponding to state_id. This text is for informational and display purposes only, and client programs should not rely on the contents of this field as it may be subject to changes or localization. (max length 100)
    integerdevices_total // Total number of Devices belonging to the DeviceGroup regardless of connectivity status
    integerdevices_connected // Number of Devices belonging to the DeviceGroup that have a connectivity status of "CONNECTED"
    integerdevices_disconnected // Number of Devices belonging to the DeviceGroup that have a connectivity status of "DISCONNECTED"
    integerdevices_dormant // Number of Devices belonging to the DeviceGroup that have a connectivity status of "DORMANT"
    doublewhetstones_average // Average whetstone measurement of all Devices belonging to the DeviceGroup.
    integermemory_average // Average amount of physical RAM available within all Devices belonging to the DeviceGroup, measured in megabytes.
end struct

See also: getStatsAllDeviceGroups, getStatsDeviceGroup


StatsDeviceWorkunit

The StatsDeviceWorkunit object belongs to a StatsDevice object, and contains information about the execution of a Workunit on a particular Device.

begin struct
    guidprogram_gid // The identifier of the Program object to which this Workunit belongs.
    stringprogram_name // The name of the Program object to which this Workunit belong. (max length 36)
    guidjob_gid // The identifier of the Job object to which this Workunit belongs.
    integerjob_id // The identifier of the Job object to which this Workunit belongs.
    guidworkunit_gid // The identifier of the Workunit object that is being executed.
    integercpu_seconds_total // Total number of CPU seconds that the Device has spent processing this Workunit since the time it was dispatched to the Device. If the Device has not contacted the Poll Service to report data after receiving this Workunit, then cpu_seconds_total will be -1.
end struct

See also: getStatsDevice, getStatsDevicesByDeviceGroup


StatsJobDevices

The StatsJobDevices object describes information on a Device, as it pertains to a particular Job.

begin struct
    guiddevice_gid // The identifier of this Device object.
    stringdevice_name // The name of this Device object. (max length 255)
    guiddevice_group_gid // The identifier of the DeviceGroup to which this Device belongs.
    stringdevice_group_name // The name of the DeviceGroup to which this Device belongs. (max length 36)
    integerstate_id // The Device state.
// Valid states:
//    0 (Disabled): This Device will not receive any more Workunits.
//    1 (Enabled): This Device may receive Workunits.
    stringstate_name // Descriptive text corresponding to state_id. This text is for informational and display purposes only, and client programs should not rely on the contents of this field as it may be subject to changes or localization. (max length 100)
    integerresults // Total number of results that this Device has completed within the specified Job.
    integercpu_seconds // Total amount of CPU time (measured in seconds) that this Device has completed within the specified Job.
    dateTimelast_contact // Timestamp of when the last communication between the Device and any GridMP Service was made.
end struct

See also: getStatsJobDevices


User

The User object describes login information about a user of the system. A User may belong to zero or more UserGroups. Users are associated with a single UserProfile. Users may also be associated with Roles and Privileges in order to grant security access to actions within the system.

begin struct
    guiduser_gid // The primary unique identifier of this User object. (no-create)
    stringuser_name // The unique user name. (max length 36)
// Validation: user_name must not have leading spaces.
// Validation: user_name must not have trailing spaces.
// Validation: user_name must not be empty.
    stringpassword // The user password. You can only update this field with updateUserPassword. (max length 60) (no-update) (no-get)
// Validation: password must not have leading spaces.
// Validation: password must not have trailing spaces.
// Validation: User.password must be at least 6 characters in length and contain both letters and numbers.
    integerstate_id // The state of the User object.
// Valid states:
//    0 (Disabled): The User is not allowed to log in to the system.
//    1 (Enabled): The User is allowed to log in to the system.
    dateTimecreation_time // The time this User was created. (no-create) (no-update)
    dateTimelast_modified // The time this record was last modified. See struct info.
end struct

See also: addUserOrGroupsToObjectPrivilege, addUserOrGroupsToRole, addUserOrGroupToObjectPrivilege, addUserOrGroupToRole, addUsersToUserGroup, addUserToUserGroup, createUser, createUsers, deleteUser, deleteUsers, getAllUsers, getPrivilegesByUserOrGroupObject, getRolesByUserOrGroup, getTokenInfo, getUser, getUserByName, getUserGroupsByUser, getUserOrGroupPrivilegesByObject, getUserOrGroupsByObjectPrivilege, getUserOrGroupsByRole, getUserProfile, getUsers, getUsersByGuid, getUsersByObjectPrivilege, getUsersByRole, getUsersByUserGroup, login2, removeUserFromUserGroup, removeUserOrGroupFromObjectPrivilege, removeUserOrGroupFromRole, removeUserOrGroupsFromObjectPrivilege, removeUserOrGroupsFromRole, removeUsersFromUserGroup, setObjectUserOrGroupPrivileges, setUserGroupUsers, setUserOrGroupRoles, setUserUserGroups, updateUser, updateUserPassword, updateUsers


UserArrayRange

The UserArrayRange object contains an array of User objects, along with a "total" field.

begin struct
    User[]records // An array of User objects. The range of objects in the array is independent of the value in the "total" field.
    integertotal // The total number of objects that matched the criteria of the returning function. This number is calculated prior to applying the caller's range specification.
end struct

See also: getUsers


UserFilter

The UserFilter object is used to filter requests for Users.

begin struct
    guid[]user_gid_match // If this vector is nonempty, only records with user_gid in this set are selected.
    guid[]user_gid_not_match // Only records with user_gid not in this set are selected.
    stringuser_name_regex // If this user_name is nonempty, only records with user_name matching this regular expression are selected.
    stringstate_id_test // Indicates how the state_id_min and state_id_max filter fields are checked (see ADG).
    integerstate_id_min // The value that is matched against the state_id value when enabled.
    integerstate_id_max // The value that is matched against the state_id value when enabled.
    integer[]state_id_in_set // If this vector is nonempty, only records with state_id in this set are selected.
    integer[]state_id_notin_set // Only records with state_id not in this set are selected.
    stringcreation_time_test // Indicates how the creation_time_start and creation_time_end filter fields are checked (see ADG).
    dateTimecreation_time_start // The value that is matched against the creation_time value when enabled.
    dateTimecreation_time_end // The value that is matched against the creation_time value when enabled.
    stringlast_modified_test // Indicates how the last_modified_start and last_modified_end filter fields are checked (see ADG).
    dateTimelast_modified_start // The value that is matched against the last_modified value when enabled.
    dateTimelast_modified_end // The value that is matched against the last_modified value when enabled.
end struct

See also: getUsers


UserGroup

UserGroups organize Users within the system. UserGroups may also be associated with Roles and Privileges in order to grant security access to actions within the system.

begin struct
    guiduser_group_gid // The primary unique identifier of this UserGroup object. (no-create)
    integerstate_id // The state of the UserGroup object.
// Valid states:
//    0 (Disabled): Users cannot access roles and privileges granted to them through this UserGroup.
//    1 (Enabled): Users can access all roles and privileges granted to them through this UserGroup.
    stringuser_group_name // The unique name of the UserGroup object. (max length 36)
// Validation: user_group_name must not have leading spaces.
// Validation: user_group_name must not have trailing spaces.
// Validation: user_group_name must not be empty.
    stringdescription // A short description of the UserGroup object. (max length 50)
    stringannotation // A longer free-form annotation of the UserGroup object. (max length 1000)
    dateTimecreation_time // The time this UserGroup was created. (no-create) (no-update)
    dateTimelast_modified // The time this record was last modified. See struct info.
end struct

See also: addPrivilegesToUserGroup, addPrivilegeToUserGroup, addUsersToUserGroup, addUserToUserGroup, createUserGroup, createUserGroups, deleteUserGroup, deleteUserGroups, getAllUserGroups, getCountUserGroupsByRole, getCountUsersByUserGroup, getPrivilegesByUserGroup, getSchedulingDescriptorUserGroupsByDeviceGroup, getUserGroup, getUserGroupByName, getUserGroupPrivilegesByObject, getUserGroups, getUserGroupsByGuid, getUserGroupsByObjectPrivilege, getUserGroupsByRole, getUserGroupsByUser, getUsersByUserGroup, removePrivilegeFromUserGroup, removePrivilegesFromUserGroup, removeUserFromUserGroup, removeUsersFromUserGroup, setUserGroupPrivileges, setUserGroupUsers, setUserUserGroups, updateUserGroup, updateUserGroups


UserGroupArrayRange

The UserGroupArrayRange object contains an array of UserGroup objects, along with a "total" field.

begin struct
    UserGroup[]records // An array of UserGroup objects. The range of objects in the array is independent of the value in the "total" field.
    integertotal // The total number of objects that matched the criteria of the returning function. This number is calculated prior to applying the caller's range specification.
end struct

See also: getUserGroups


UserGroupFilter

The UserGroupFilter object is used to filter requests for UserGroups.

begin struct
    guid[]user_group_gid_match // If this vector is nonempty, only records with user_group_gid in this set are selected.
    guid[]user_group_gid_not_match // Only records with user_group_gid not in this set are selected.
    stringstate_id_test // Indicates how the state_id_min and state_id_max filter fields are checked (see ADG).
    integerstate_id_min // The value that is matched against the state_id value when enabled.
    integerstate_id_max // The value that is matched against the state_id value when enabled.
    integer[]state_id_in_set // If this vector is nonempty, only records with state_id in this set are selected.
    integer[]state_id_notin_set // Only records with state_id not in this set are selected.
    stringuser_group_name_regex // If this user_group_name is nonempty, only records with user_group_name matching this regular expression are selected.
    stringdescription_regex // If this description is nonempty, only records with description matching this regular expression are selected.
    stringannotation_regex // If this annotation is nonempty, only records with annotation matching this regular expression are selected.
    stringcreation_time_test // Indicates how the creation_time_start and creation_time_end filter fields are checked (see ADG).
    dateTimecreation_time_start // The value that is matched against the creation_time value when enabled.
    dateTimecreation_time_end // The value that is matched against the creation_time value when enabled.
    stringlast_modified_test // Indicates how the last_modified_start and last_modified_end filter fields are checked (see ADG).
    dateTimelast_modified_start // The value that is matched against the last_modified value when enabled.
    dateTimelast_modified_end // The value that is matched against the last_modified value when enabled.
end struct

See also: getUserGroups


UserOrGroupPrivilege

The UserOrGroupPrivilege object associates a Privilege with a User or UserGroup in the system. In doing so, the User or UserGroup is granted security access in accordance with the Privilege.

begin struct
    guiduser_or_group_gid // The User or UserGroup to which this object associates.
    guidprivilege_gid // The Privilege to which this object associates.
    booleangrantable // Whether the User who holds this Privilege can grant it to others.
end struct

See also: getUserGroupPrivilegesByObject, getUserOrGroupPrivilegesByObject, getUserPrivilegesByObject, setObjectUserOrGroupPrivileges


UserProfile

The UserProfile describes additional user information not contained in the User object.

begin struct
    guiduser_gid // The primary unique identifier of the User to which this object belongs.
    stringemail_addr // The email address for the User (max length 70)
    stringreal_name // The name of the User. (max length 400)
    stringpostal_addr // The postal address of the User. (max length 1000)
    stringtelephone // The telephone number of the User. (max length 100)
    stringorg_info // The organization to which this User belongs. (max length 400)
    stringpersonal_info // Personal information about the User. (max length 2000)
    dateTimecreation_time // The time this UserProfile was created. (no-create) (no-update)
    dateTimelast_modified // The time this record was last modified. See struct info.
end struct

See also: getUserProfile, updateUserProfile


VersionInfo

The VersionInfo object describes version information about the RPC server.

begin struct
    integerrpc_version // The version number of the RPC server.
    integerprotocol_version // The version number of the RPC protocol.
end struct

See also: getVersionInfo


Workunit

The Workunit describes the smallest schedulable piece of work in the system. It is created by an instance of a Program running against Datas. Workunits belong to a single JobStep, and generate Results upon successful completion.

begin struct
    guidworkunit_gid // The primary unique identifier of this Workunit object. (no-create)
    guidjob_gid // The identifier of the Job with which this Workunit is associated. (no-create) (no-update)
    guidjob_step_gid // The identifier of the JobStep with which this Workunit is associated. (no-update)
    integerindex // The index of this Workunit. This value must be unique within its JobStep.
    DataId[]datas // The ids of the zero or more Data objects associated with this Workunit. This array is only used during Workunit creation, with createWorkunit or createWorkunits. After creation, this array may be obtained through getDatasByWorkunit or getWorkunitsWithDatasByGuid.
    dateTimelast_sent // The timestamp at which this Workunit object was last sent to a Device. (no-create) (no-update)
    integerresults_successful_received // Number of successful Results returned for the Workunit. Deleting a Result does not affect this count. (no-create) (no-update)
    integerresults_unsuccessful_received // Number of unsuccessful Results returned for the Workunit. Deleting a Result does not affect this count. (no-create) (no-update)
    integerresults_received // Number of successful and unsuccessful Results returned for the Workunit. Deleting a Result does not affect this count. (no-create) (no-update)
    integererrors_received // The number of Errors received for this Workunit. (no-create) (no-update)
    integerstate_id // The state of this Workunit. (required)
// Valid states:
//    0 (Disabled): The Workunit is disabled and will not run.
//    1 (Enabled): The Workunit is enabled and ready to run.
//    2 (Completed): The Workunit has met its required number of results, and will no longer be run.
//    3 (Failed): The Workunit has generated the maximum number of errors, and will no longer be run.
end struct

See also: createWorkunit, createWorkunits, createWorkunitsFromDataSetsAsync, deleteWorkunit, deleteWorkunits, getDatasByWorkunit, getDataSetsByJobStepWorkunits, getDevicesByWorkunit, getResultsByWorkunit, getWorkunit, getWorkunits, getWorkunitsByGuid, getWorkunitsByJobStep, getWorkunitStatesByJobStep, getWorkunitsWithDatasByGuid, updateWorkunitState, updateWorkunitStates


WorkunitArrayRange

The WorkunitArrayRange object contains an array of Workunit objects, along with a "total" field.

begin struct
    Workunit[]records // An array of Workunit objects. The range of objects in the array is independent of the value in the "total" field.
    integertotal // The total number of objects that matched the criteria of the returning function. This number is calculated prior to applying the caller's range specification.
end struct

See also: getWorkunits


WorkunitFilter

The WorkunitFilter object is used to filter requests for Workunits.

begin struct
    guid[]workunit_gid_match // If this vector is nonempty, only records with workunit_gid in this set are selected.
    guid[]workunit_gid_not_match // Only records with workunit_gid not in this set are selected.
    guid[]job_gid_match // If this vector is nonempty, only records with job_gid in this set are selected.
    guid[]job_gid_not_match // Only records with job_gid not in this set are selected.
    guid[]job_step_gid_match // If this vector is nonempty, only records with job_step_gid in this set are selected.
    guid[]job_step_gid_not_match // Only records with job_step_gid not in this set are selected.
    stringindex_test // Indicates how the index_min and index_max filter fields are checked (see ADG).
    integerindex_min // The value that is matched against the index value when enabled.
    integerindex_max // The value that is matched against the index value when enabled.
    integer[]index_in_set // If this vector is nonempty, only records with index in this set are selected.
    integer[]index_notin_set // Only records with index not in this set are selected.
    stringlast_sent_test // Indicates how the last_sent_start and last_sent_end filter fields are checked (see ADG).
    dateTimelast_sent_start // The value that is matched against the last_sent value when enabled.
    dateTimelast_sent_end // The value that is matched against the last_sent value when enabled.
    stringresults_successful_received_test // Indicates how the results_successful_received_min and results_successful_received_max filter fields are checked (see ADG).
    integerresults_successful_received_min // The value that is matched against the results_successful_received value when enabled.
    integerresults_successful_received_max // The value that is matched against the results_successful_received value when enabled.
    integer[]results_successful_received_in_set // If this vector is nonempty, only records with results_successful_received in this set are selected.
    integer[]results_successful_received_notin_set // Only records with results_successful_received not in this set are selected.
    stringresults_unsuccessful_received_test // Indicates how the results_unsuccessful_received_min and results_unsuccessful_received_max filter fields are checked (see ADG).
    integerresults_unsuccessful_received_min // The value that is matched against the results_unsuccessful_received value when enabled.
    integerresults_unsuccessful_received_max // The value that is matched against the results_unsuccessful_received value when enabled.
    integer[]results_unsuccessful_received_in_set // If this vector is nonempty, only records with results_unsuccessful_received in this set are selected.
    integer[]results_unsuccessful_received_notin_set // Only records with results_unsuccessful_received not in this set are selected.
    stringresults_received_test // Indicates how the results_received_min and results_received_max filter fields are checked (see ADG).
    integerresults_received_min // The value that is matched against the results_received value when enabled.
    integerresults_received_max // The value that is matched against the results_received value when enabled.
    integer[]results_received_in_set // If this vector is nonempty, only records with results_received in this set are selected.
    integer[]results_received_notin_set // Only records with results_received not in this set are selected.
    stringerrors_received_test // Indicates how the errors_received_min and errors_received_max filter fields are checked (see ADG).
    integererrors_received_min // The value that is matched against the errors_received value when enabled.
    integererrors_received_max // The value that is matched against the errors_received value when enabled.
    integer[]errors_received_in_set // If this vector is nonempty, only records with errors_received in this set are selected.
    integer[]errors_received_notin_set // Only records with errors_received not in this set are selected.
    stringstate_id_test // Indicates how the state_id_min and state_id_max filter fields are checked (see ADG).
    integerstate_id_min // The value that is matched against the state_id value when enabled.
    integerstate_id_max // The value that is matched against the state_id value when enabled.
    integer[]state_id_in_set // If this vector is nonempty, only records with state_id in this set are selected.
    integer[]state_id_notin_set // Only records with state_id not in this set are selected.
end struct

See also: getWorkunits


Functions

Filtering and Paging

Certain classes of records can grow too large to be effectively handled with a GetAllXxx function. For these types of records there are a set of "filtering and paging" functions, with names such as getDevices. Each of these functions takes the same pattern of parameters:

DeviceFilter filter
A filtering specification that selects some subset of all records. The filter fields are discussed below.
string order
The order in which the records are returned. The order spec is either an empty string, which means the same order that the records happen to be returned from the DBMS, or a column name optionally followed by a space and either "asc" or "desc" to indicate a sort order. If only a column name is given, the records are returned in ascending sort order on that column.
integer start
The offset into the filtered and sorted set of records to start returning the result set. The first record is at offset 0.
integer count
The maximum number of records to return in the result set. Fewer records than this number will be returned if the end of the record set is reached before the requested count. Use the special value -1 to request an unlimited number of records. Asking for zero records will return no records.

The filter specification is a record structure that is similar to the target record structure. For target fields that have been marked as filterable, the following filter fields are available:

Target field type Filter fields Description
boolean field_active Indicates that the field_value filter field is checked.
field_value The value that is matched against the field value when field_active is true.
double field_test Indicates how the field_min and field_max filter fields are checked (see note below).
field_min The value that is matched against the field value when enabled.
field_max The value that is matched against the field value when enabled.
guid field_match If this vector is nonempty, only records with field in this set are selected.
field_not_match Only records with field not in this set are selected.
integer field_test Indicates how the field_min and field_max filter fields are checked (see note below).
field_min The value that is matched against the field value when enabled.
field_max The value that is matched against the field value when enabled.
field_in_set If this vector is nonempty, only records with field in this set are selected.
field_notin_set Only records with field not in this set are selected.
string field_regex If this field is nonempty, only records with field matching this regular expression are selected.
dateTime field_test Indicates how the field_start and field_end filter fields are checked (see note below).
field_start The value that is matched against the field value when enabled.
field_end The value that is matched against the field value when enabled.

The filter field names ending in _test can be one of nine string values:

The regular expressions in field names ending in _regex are implemented using PCRE, the Perl Compatible Regular Expression library. References:

When more than one filter condition is specified in a filter, all specified filter conditions must match for the record to be returned.

The return value of the filter functions is an "ArrayRange" type, for example DeviceArrayRange. This structure type always has two fields, records and total. The records field is an array of target type values, ie. of Device. The total field is the total number of records found after applying the requested filter, but before using the start and count values.


accessCheck

Check whether the calling User has a given Role.

Synopsis

boolean accessCheck(string authkey, guid role_gid)

Parameters

authkey

The user authentication key returned from login().

role_gid

The unique identifier of the Role to query.

Return Value

True if the User has the Role. False otherwise. An exception is thrown if the function fails.

Description

This function checks whether the calling User, specified by authkey, has access to the Role specified by role_gid. The Role may be granted directly to the User or available to the User via a UserGroup.

Access Control

This function has no specific access control requirements.


accessCheckObject

Check whether the current user has a particular Privilege for a specific object.

Synopsis

boolean accessCheckObject(string authkey, guid privilege_gid, guid object_gid)

Parameters

authkey

The user authentication key returned from login().

privilege_gid

The unique identifier of the Privilege to query.

object_gid

The unique identifier of the object to query.

Return Value

The return value is true if the user has the given Privilege for the specified object. An exception is thrown if the function fails.

Description

Returns true or false if the calling user has a privilege_gid for an object_gid. If the calling user has the MP Administrator role, this function returns true unless the given object does not exist, in which case it returns false. This function throws an exception if the privilege_gid does not refer to a valid privilege.

Access Control

This function has no specific access control requirements.


accessCheckObjects

Check whether the current user has a particular Privilege for a specific set of objects.

Synopsis

boolean[] accessCheckObjects(string authkey, guid privilege_gid, guid[] object_gids)

Parameters

authkey

The user authentication key returned from login().

privilege_gid

The unique identifier of the Privilege to query.

object_gids

The unique identifers of the objects to query.

Return Value

The return value is true if the user has the given Privilege for the specified object. An exception is thrown if the function fails.

Description

Returns a true or false for each object_gid for which a user has a privilege_gid. See accessCheckObject for additional conditions.

Access Control

This function has no specific access control requirements.


addApplicationsToDeviceProfile

Add multiple Application objects to a DeviceProfile.

Synopsis

Exception[] addApplicationsToDeviceProfile(string authkey, guid[] application_gids, guid device_profile_gid)

Parameters

authkey

The user authentication key returned from login().

application_gids

The unique ids of the Application objects to add.

device_profile_gid

The primary unique identifier of the DeviceProfile object.

Return Value

Returns an array of Exceptions, corresponding to the status of each item in the input array.

Description

This function associates Applications with a DeviceProfile. Devices which use the DeviceProfile are then allowed to run the specified Applications. See run_new_applications in DeviceProfile. This function will succeed if requested to add an association that already exists.

Access Control

This function requires the calling user have Update Device Group privileges on the DeviceGroup.

See Also

addApplicationToDeviceProfile, getApplicationsByDeviceProfile, removeApplicationFromDeviceProfile, removeApplicationsFromDeviceProfile, setDeviceProfileApplications


addApplicationToDeviceProfile

Add a Application object to a DeviceProfile.

Synopsis

void addApplicationToDeviceProfile(string authkey, guid application_gid, guid device_profile_gid)

Parameters

authkey

The user authentication key returned from login().

application_gid

The primary unique identifier of the Application object to add.

device_profile_gid

The primary unique identifier of the DeviceProfile object.

Return Value

The return value is undefined. An exception is thrown if the function fails.

Description

This function associates an Application with a DeviceProfile. Devices which use the DeviceProfile are then allowed to run the specified Application. See run_new_applications in DeviceProfile. This function will succeed if requested to add an association that already exists.

Access Control

This function requires the calling user have Update Device Group privileges on the DeviceGroup.

See Also

addApplicationsToDeviceProfile, getApplicationsByDeviceProfile, removeApplicationFromDeviceProfile, removeApplicationsFromDeviceProfile, setDeviceProfileApplications


addDeviceGroupsToJob

Add to the list of DeviceGroups on which the Job can run.

Synopsis

Exception[] addDeviceGroupsToJob(string authkey, guid[] device_group_gids, guid job_gid)

Parameters

authkey

The user authentication key returned from login().

device_group_gids

The DeviceGroups on which to run.

job_gid

The Job to affect.

Return Value

Returns an array of Exceptions, corresponding to the status of each item in the input array.

Description

Note that as a special case, a Job will run on all DeviceGroups if this list is empty. This function will succeed if requested to add an association that already exists.

Access Control

This function requires the calling user have Update Job privileges on the Job.

See Also

addDeviceGroupToJob, getDeviceGroupsByJob, getJobsByDeviceGroup, removeDeviceGroupFromJob, removeDeviceGroupsFromJob, setJobDeviceGroups


addDeviceGroupToJob

Add to the list of DeviceGroups on which the Job can run.

Synopsis

void addDeviceGroupToJob(string authkey, guid device_group_gid, guid job_gid)

Parameters

authkey

The user authentication key returned from login().

device_group_gid

The DeviceGroup on which to run.

job_gid

The Job to affect.

Return Value

The return value is undefined. An exception is thrown if the function fails.

Description

A Job will run on all DeviceGroups if this list is empty. This function will succeed if requested to add an association that already exists.

Access Control

This function requires the calling user have Update Job privileges on the Job.

See Also

addDeviceGroupsToJob, getDeviceGroupsByJob, getJobsByDeviceGroup, removeDeviceGroupFromJob, removeDeviceGroupsFromJob, setJobDeviceGroups


addPrivilegesToUserGroup

Associate multiple Privilege objects with a UserGroup.

Synopsis

Exception[] addPrivilegesToUserGroup(string authkey, guid[] privilege_gids, guid user_group_gid)

Parameters

authkey

The user authentication key returned from login().

privilege_gids

The unique ids of the Privilege objects to add.

user_group_gid

The primary unique identifier of the UserGroup object.

Return Value

Returns an array of Exceptions, corresponding to the status of each item in the input array.

Description

This function will succeed if requested to add an association that already exists.

Access Control

This function is restricted to users with the MP Administrator role only.

See Also

addPrivilegeToUserGroup, getPrivilegesByUserGroup, getUserGroupPrivilegesByObject, getUserGroupsByObjectPrivilege, removePrivilegeFromUserGroup, removePrivilegesFromUserGroup, setUserGroupPrivileges


addPrivilegeToUserGroup

Associate Privilege objects with a UserGroup.

Synopsis

void addPrivilegeToUserGroup(string authkey, guid privilege_gid, guid user_group_gid)

Parameters

authkey

The user authentication key returned from login().

privilege_gid

The unique id of the Privilege object to add.

user_group_gid

The primary unique identifier of the UserGroup object.

Return Value

The return value is undefined. An exception is thrown if the function fails.

Description

This function will succeed if requested to add an association that already exists.

Access Control

This function is restricted to users with the MP Administrator role only.

See Also

addPrivilegesToUserGroup, getPrivilegesByUserGroup, getUserGroupPrivilegesByObject, getUserGroupsByObjectPrivilege, removePrivilegeFromUserGroup, removePrivilegesFromUserGroup, setUserGroupPrivileges


addProgramsToApplication

Add multiple Program objects to a Application.

Synopsis

Exception[] addProgramsToApplication(string authkey, guid[] program_gids, guid application_gid)

Parameters

authkey

The user authentication key returned from login().

program_gids

The unique ids of the Program objects to add.

application_gid

The primary unique identifier of the Application object.

Return Value

Returns an array of Exceptions, corresponding to the status of each item in the input array.

Description

Programs must be added to an Application before they can be instantiated as JobSteps. This function will succeed if requested to add an association that already exists.

Access Control

This function requires the calling user have Update Application privileges on the Application.

See Also

addProgramToApplication, getApplicationsByProgram, getProgramsByApplication, removeProgramFromApplication, removeProgramsFromApplication, setApplicationPrograms


addProgramsToDeviceProfile

Add multiple Program objects to a DeviceProfile.

Synopsis

Exception[] addProgramsToDeviceProfile(string authkey, guid[] program_gids, guid device_profile_gid)

Parameters

authkey

The user authentication key returned from login().

program_gids

The unique ids of the Program objects to add.

device_profile_gid

The primary unique identifier of the DeviceProfile object.

Return Value

Returns an array of Exceptions, corresponding to the status of each item in the input array.

Description

This function associates Programs with a DeviceProfile. Devices which use the DeviceProfile are then allowed to run the specified Programs. See run_new_programs in DeviceProfile. This function will succeed if requested to add an association that already exists.

Access Control

This function requires the calling user have Update Device Group privileges on the DeviceGroup.

See Also

addProgramToDeviceProfile, getProgramsByDeviceProfile, removeProgramFromDeviceProfile, removeProgramsFromDeviceProfile, setDeviceProfilePrograms


addProgramToApplication

Add a Program object to a Application.

Synopsis

void addProgramToApplication(string authkey, guid program_gid, guid application_gid)

Parameters

authkey

The user authentication key returned from login().

program_gid

The primary unique identifier of the Program object to add.

application_gid

The primary unique identifier of the Application object.

Return Value

The return value is undefined. An exception is thrown if the function fails.

Description

Programs must be added to an Application before they can be instantiated as JobSteps. This function will succeed if requested to add an association that already exists.

Access Control

This function requires the calling user have Update Application privileges on the Application.

See Also

addProgramsToApplication, getApplicationsByProgram, getProgramsByApplication, removeProgramFromApplication, removeProgramsFromApplication, setApplicationPrograms


addProgramToDeviceProfile

Add a Program object to a DeviceProfile.

Synopsis

void addProgramToDeviceProfile(string authkey, guid program_gid, guid device_profile_gid)

Parameters

authkey

The user authentication key returned from login().

program_gid

The primary unique identifier of the Program object to add.

device_profile_gid

The primary unique identifier of the DeviceProfile object.

Return Value

The return value is undefined. An exception is thrown if the function fails.

Description

This function associates a Program with a DeviceProfile. Devices which use the DeviceProfile are then allowed to run the specified Program. See run_new_programs in DeviceProfile. This function will succeed if requested to add an association that already exists.

Access Control

This function requires the calling user have Update Device Group privileges on the DeviceGroup.

See Also

addProgramsToDeviceProfile, getProgramsByDeviceProfile, removeProgramFromDeviceProfile, removeProgramsFromDeviceProfile, setDeviceProfilePrograms


addUserOrGroupsToObjectPrivilege

Add multiple User objects to an object with a specific Privilege.

Synopsis

Exception[] addUserOrGroupsToObjectPrivilege(string authkey, guid[] user_or_group_gids, guid object_gid, guid privilege_gid, boolean grantable)

Parameters

authkey

The user authentication key returned from login().

user_or_group_gids

The unique ids of the User or UserGroup objects to add.

object_gid

The primary unique identifier of the object. See addUserOrGroupToObjectPrivilege.

privilege_gid

The primary unique identifier of the Privilege object.

grantable

Whether the User who holds this Privilege can grant it to others.

Return Value

Returns an array of Exceptions, corresponding to the status of each item in the input array.

Description

This function gives Users a Privilege to perform some action on an Object. This function will succeed if requested to add an association that already exists.

Access Control

This function may be called by either an administrator, or a user who already has a grantable privilege on the object.

See Also

addPrivilegesToUserGroup, addPrivilegeToUserGroup, addUserOrGroupToObjectPrivilege, getPrivilegesByUserGroup, getPrivilegesByUserOrGroupObject, getUserGroupPrivilegesByObject, getUserGroupsByObjectPrivilege, getUserOrGroupPrivilegesByObject, getUserOrGroupsByObjectPrivilege, getUserPrivilegesByObject, getUsersByObjectPrivilege, removePrivilegeFromUserGroup, removePrivilegesFromUserGroup, removeUserOrGroupFromObjectPrivilege, removeUserOrGroupsFromObjectPrivilege, setObjectPrivilegeUserAndGroups, setObjectUserOrGroupPrivileges, setUserGroupPrivileges


addUserOrGroupsToRole

Add multiple User or UserGroup objects to a Role.

Synopsis

Exception[] addUserOrGroupsToRole(string authkey, guid[] user_or_group_gids, guid role_gid)

Parameters

authkey

The user authentication key returned from login().

user_or_group_gids

The unique ids of the User or UserGroup objects to add.

role_gid

The primary unique identifier of the Role object.

Return Value

Returns an array of Exceptions, corresponding to the status of each item in the input array.

Description

Use this function to grant additional security to Users or UserGroups. This function will succeed if requested to add an association that already exists.

Access Control

This function is restricted to users with the MP Administrator role only.

See Also

addUserOrGroupToRole, getCountUserGroupsByRole, getCountUsersByRole, getRolesByUserOrGroup, getUserGroupsByRole, getUserOrGroupsByRole, getUsersByRole, removeUserOrGroupFromRole, removeUserOrGroupsFromRole, setRoleUserAndGroups, setUserOrGroupRoles


addUserOrGroupToObjectPrivilege

Add a User or UserGroup object to an object with a specific Privilege.

Synopsis

void addUserOrGroupToObjectPrivilege(string authkey, guid user_or_group_gid, guid object_gid, guid privilege_gid, boolean grantable)

Parameters

authkey

The user authentication key returned from login().

user_or_group_gid

The primary unique identifier of the User or UserGroup object to add.

object_gid

The primary unique identifier of the object. The types of objects that accept access control privileges are: Application, Program, Job, DeviceGroup, DataSet, Resource, and GlobalResource. The privileges associated with each object type are: Application: Read Application, Update Application, Delete Application, Create Job; Program: Read Program, Update Program, Delete Program; Job: Read Job, Update Job, Delete Job; DeviceGroup: Read Device Group, Update Device Group, Delete Device Group; DataSet: Read Data, Update Data, Delete Data; Resource, GlobalResource: Manage Resource.

privilege_gid

The primary unique identifier of the Privilege object.

grantable

Whether the User who holds this Privilege can grant it to others.

Return Value

The return value is undefined. An exception is thrown if the function fails.

Description

Use this function to grant additional security to Users or UserGroups. This function will succeed if requested to add an association that already exists.

Access Control

This function may be called by either an administrator, or a user who already has a grantable privilege on the object.

See Also

addPrivilegesToUserGroup, addPrivilegeToUserGroup, addUserOrGroupsToObjectPrivilege, getPrivilegesByUserGroup, getPrivilegesByUserOrGroupObject, getUserGroupPrivilegesByObject, getUserGroupsByObjectPrivilege, getUserOrGroupPrivilegesByObject, getUserOrGroupsByObjectPrivilege, getUserPrivilegesByObject, getUsersByObjectPrivilege, removePrivilegeFromUserGroup, removePrivilegesFromUserGroup, removeUserOrGroupFromObjectPrivilege, removeUserOrGroupsFromObjectPrivilege, setObjectPrivilegeUserAndGroups, setObjectUserOrGroupPrivileges, setUserGroupPrivileges


addUserOrGroupToRole

Add a User or UserGroup object to a Role.

Synopsis

void addUserOrGroupToRole(string authkey, guid user_or_group_gid, guid role_gid)

Parameters

authkey

The user authentication key returned from login().

user_or_group_gid

The primary unique identifier of the User or UserGroup object to add.

role_gid

The primary unique identifier of the Role object.

Return Value

The return value is undefined. An exception is thrown if the function fails.

Description

Use this function to grant additional security to Users or UserGroups. This function will succeed if requested to add an association that already exists.

Access Control

This function is restricted to users with the MP Administrator role only.

See Also

addUserOrGroupsToRole, getCountUserGroupsByRole, getCountUsersByRole, getRolesByUserOrGroup, getUserGroupsByRole, getUserOrGroupsByRole, getUsersByRole, removeUserOrGroupFromRole, removeUserOrGroupsFromRole, setRoleUserAndGroups, setUserOrGroupRoles


addUsersToUserGroup

Add multiple User objects to a UserGroup.

Synopsis

Exception[] addUsersToUserGroup(string authkey, guid[] user_gids, guid user_group_gid)

Parameters

authkey

The user authentication key returned from login().

user_gids

The unique ids of the User objects to add.

user_group_gid

The primary unique identifier of the UserGroup object.

Return Value

Returns an array of Exceptions, corresponding to the status of each item in the input array.

Description

Use this function to group Users into groups. A User may be in more than one group or none at all. This function will succeed if requested to add an association that already exists.

Access Control

This function is restricted to users with the MP Administrator role only.

See Also

addPrivilegesToUserGroup, addPrivilegeToUserGroup, addUserToUserGroup, createUserGroup, createUserGroups, deleteUserGroup, deleteUserGroups, getAllUserGroups, getCountUserGroupsByRole, getCountUsersByUserGroup, getPrivilegesByUserGroup, getSchedulingDescriptorUserGroupsByDeviceGroup, getUserGroup, getUserGroupByName, getUserGroupPrivilegesByObject, getUserGroups, getUserGroupsByGuid, getUserGroupsByObjectPrivilege, getUserGroupsByRole, getUserGroupsByUser, getUsersByUserGroup, removePrivilegeFromUserGroup, removePrivilegesFromUserGroup, removeUserFromUserGroup, removeUsersFromUserGroup, setUserGroupPrivileges, setUserGroupUsers, setUserUserGroups, updateUserGroup, updateUserGroups


addUserToUserGroup

Add a User object to a UserGroup.

Synopsis

void addUserToUserGroup(string authkey, guid user_gid, guid user_group_gid)

Parameters

authkey

The user authentication key returned from login().

user_gid

The primary unique identifier of the User object to add.

user_group_gid

The primary unique identifier of the UserGroup object.

Return Value

The return value is undefined. An exception is thrown if the function fails.

Description

Use this function to group Users into groups. A User may be in more than one group or none at all. This function will succeed if requested to add an association that already exists.

Access Control

This function is restricted to users with the MP Administrator role only.

See Also

addPrivilegesToUserGroup, addPrivilegeToUserGroup, addUsersToUserGroup, createUserGroup, createUserGroups, deleteUserGroup, deleteUserGroups, getAllUserGroups, getCountUserGroupsByRole, getCountUsersByUserGroup, getPrivilegesByUserGroup, getSchedulingDescriptorUserGroupsByDeviceGroup, getUserGroup, getUserGroupByName, getUserGroupPrivilegesByObject, getUserGroups, getUserGroupsByGuid, getUserGroupsByObjectPrivilege, getUserGroupsByRole, getUserGroupsByUser, getUsersByUserGroup, removePrivilegeFromUserGroup, removePrivilegesFromUserGroup, removeUserFromUserGroup, removeUsersFromUserGroup, setUserGroupPrivileges, setUserGroupUsers, setUserUserGroups, updateUserGroup, updateUserGroups


cancelDeviceCommands

Cancel any outstanding commands for a Device or DeviceGroup.

Synopsis

void cancelDeviceCommands(string authkey, guid device_gid)

Parameters

authkey

The user authentication key returned from login().

device_gid

The primary unique identifier of the Device or DeviceGroup. If this is the null guid, all outstanding commands for all Devices are cancelled.

Return Value

The return value is undefined. An exception is thrown if the function fails.

Access Control

If device_gid is the null guid, this function requires the MP Administrator role. If device_gid refers to a device group or device, the calling user must have the ability to manage the device group.

See Also

getDeviceCommands, sendDeviceCommand


createAgentModule

Create a new AgentModule object.

Synopsis

guid createAgentModule(string authkey, AgentModule agent_module)

Parameters

authkey

The user authentication key returned from login().

agent_module

The AgentModule object to add.

Return Value

The return value is the identifier of the new AgentModule object. An exception is thrown if the function fails.

Description

This is only used to upgrade the Agent software.

Access Control

This function is restricted to users with the MP Administrator role only.

See Also

createAgentModules, deleteAgentModule, deleteAgentModules, getAgentModule, getAgentModuleByAgentVersionPlatform, getAgentModules, getAgentModulesByGuid, getAllAgentModules


createAgentModules

Create multiple new AgentModule objects.

Synopsis

ExceptionOrGuid[] createAgentModules(string authkey, AgentModule[] agent_modules)

Parameters

authkey

The user authentication key returned from login().

agent_modules

The AgentModule objects to add.

Return Value

Returns an array of Exceptions or guids, corresponding to the error status, or the new guid of each item in the input array.

Description

This is only used to upgrade the Agent software.

Access Control

This function is restricted to users with the MP Administrator role only.

See Also

createAgentModule, createAgentVersions, createApplications, createCredentials, createDataSets, createDeviceGroups, createDeviceProfiles, createGlobalResources, createJobs, createJobSteps, createJobStepsWithResourceRequirements, createProgramModules, createProgramModuleVersions, createPrograms, createProgramVersions, createResources, createSchedulingDescriptors, createServices, createUserGroups, createUsers, createWorkunits, deleteAgentModule, deleteAgentModules, getAgentModule, getAgentModuleByAgentVersionPlatform, getAgentModules, getAgentModulesByGuid, getAllAgentModules


createAgentVersion

Create a new AgentVersion object.

Synopsis

guid createAgentVersion(string authkey, AgentVersion agent_version)

Parameters

authkey

The user authentication key returned from login().

agent_version

The AgentVersion object to add.

Return Value

The return value is the identifier of the new AgentVersion object. An exception is thrown if the function fails.

Description

This is only used to upgrade the Agent software.

Access Control

This function is restricted to users with the MP Administrator role only.

See Also

createAgentVersions, deleteAgentVersion, deleteAgentVersions, getAgentModuleByAgentVersionPlatform, getAgentVersion, getAgentVersionByName, getAgentVersions, getAgentVersionsByGuid, getAllAgentVersions, getCountDeviceGroupsByAgentVersion


createAgentVersions

Create multiple new AgentVersion objects.

Synopsis

ExceptionOrGuid[] createAgentVersions(string authkey, AgentVersion[] agent_versions)

Parameters

authkey

The user authentication key returned from login().

agent_versions

The AgentVersion objects to add.

Return Value

Returns an array of Exceptions or guids, corresponding to the error status, or the new guid of each item in the input array.

Description

This is only used to upgrade the Agent software.

Access Control

This function is restricted to users with the MP Administrator role only.

See Also

createAgentModules, createAgentVersion, createApplications, createCredentials, createDataSets, createDeviceGroups, createDeviceProfiles, createGlobalResources, createJobs, createJobSteps, createJobStepsWithResourceRequirements, createProgramModules, createProgramModuleVersions, createPrograms, createProgramVersions, createResources, createSchedulingDescriptors, createServices, createUserGroups, createUsers, createWorkunits, deleteAgentVersion, deleteAgentVersions, getAgentModuleByAgentVersionPlatform, getAgentVersion, getAgentVersionByName, getAgentVersions, getAgentVersionsByGuid, getAllAgentVersions, getCountDeviceGroupsByAgentVersion


createApplication

Create a new Application object.

Synopsis

guid createApplication(string authkey, Application application)

Parameters

authkey

The user authentication key returned from login().

application

The Application object to add.

Return Value

The return value is the identifier of the new Application object. An exception is thrown if the function fails.

Description

This function adds a new Application object to the system. Note that the application_name specified to this function must be unique within the system. If another Application exists with the same name, this function will fail. This may happen even if the calling user cannot view the other application due to access control. Applications may be created in any state except PENDING_DELETE.

Access Control

This function requires the calling user have the Application Creator role.

See Also

addApplicationsToDeviceProfile, addApplicationToDeviceProfile, addProgramsToApplication, addProgramToApplication, createApplications, deleteApplication, deleteApplications, getAllApplications, getApplication, getApplicationByName, getApplications, getApplicationsByDeviceProfile, getApplicationsByGuid, getApplicationsByProgram, getJobsByApplication, getProgramsByApplication, removeApplicationFromDeviceProfile, removeApplicationsFromDeviceProfile, removeProgramFromApplication, removeProgramsFromApplication, setApplicationPrograms, setDeviceProfileApplications, updateApplication, updateApplications


createApplications

Create multiple new Application objects.

Synopsis

ExceptionOrGuid[] createApplications(string authkey, Application[] applications)

Parameters

authkey

The user authentication key returned from login().

applications

The Application objects to add.

Return Value

Returns an array of Exceptions or guids, corresponding to the error status, or the new guid of each item in the input array.

Description

This function adds multiple new Application objects to the system.

Access Control

This function requires the calling user have the Application Creator role.

See Also

addApplicationsToDeviceProfile, addApplicationToDeviceProfile, addProgramsToApplication, addProgramToApplication, createAgentModules, createAgentVersions, createApplication, createCredentials, createDataSets, createDeviceGroups, createDeviceProfiles, createGlobalResources, createJobs, createJobSteps, createJobStepsWithResourceRequirements, createProgramModules, createProgramModuleVersions, createPrograms, createProgramVersions, createResources, createSchedulingDescriptors, createServices, createUserGroups, createUsers, createWorkunits, deleteApplication, deleteApplications, getAllApplications, getApplication, getApplicationByName, getApplications, getApplicationsByDeviceProfile, getApplicationsByGuid, getApplicationsByProgram, getJobsByApplication, getProgramsByApplication, removeApplicationFromDeviceProfile, removeApplicationsFromDeviceProfile, removeProgramFromApplication, removeProgramsFromApplication, setApplicationPrograms, setDeviceProfileApplications, updateApplication, updateApplications


createCredential

Create a new Credential object.

Synopsis

guid createCredential(string authkey, Credential credential)

Parameters

authkey

The user authentication key returned from login().

credential

The Credential object to add.

Return Value

The return value is the identifier of the new Credential object. An exception is thrown if the function fails.

Description

Create a new Credential object.

Access Control

This function requires the calling user have Update Device Group privileges on the DeviceGroup.

See Also

createCredentials, deleteCredential, deleteCredentials, getAllCredentials, getCredential, getCredentials, updateCredential, updateCredentials


createCredentials

Create multiple new Credential objects.

Synopsis

ExceptionOrGuid[] createCredentials(string authkey, Credential[] credentials)

Parameters

authkey

The user authentication key returned from login().

credentials

The Credential objects to add.

Return Value

Returns an array of Exceptions or guids, corresponding to the error status, or the new guid of each item in the input array.

Description

This function adds multiple new Credential objects to the system.

Access Control

This function requires the calling user have Update Device Group privileges on the DeviceGroup.

See Also

createAgentModules, createAgentVersions, createApplications, createCredential, createDataSets, createDeviceGroups, createDeviceProfiles, createGlobalResources, createJobs, createJobSteps, createJobStepsWithResourceRequirements, createProgramModules, createProgramModuleVersions, createPrograms, createProgramVersions, createResources, createSchedulingDescriptors, createServices, createUserGroups, createUsers, createWorkunits, deleteCredential, deleteCredentials, getAllCredentials, getCredential, getCredentials, updateCredential, updateCredentials


createData

Create a new Data object.

Synopsis

void createData(string authkey, Data data)

Parameters

authkey

The user authentication key returned from login().

data

The Data object to add.

Return Value

The return value is undefined. An exception is thrown if the function fails.

Description

This function adds a new Data object to the system.

Access Control

This function requires the calling user have Update Data privileges on the DataSet.

See Also

createDatas, createDataSet, createDataSets, createWorkunitsFromDataSetsAsync, deleteData, deleteDatas, deleteDataSet, deleteDataSets, getAllDataSets, getData, getDatas, getDatasByDataSet, getDatasById, getDatasByWorkunit, getDataSet, getDataSetByName, getDataSets, getDataSetsByGuid, getDataSetsByJobStepWorkunits, getWorkunitsWithDatasByGuid, updateDataSet, updateDataSets


createDatas

Create multiple new Data objects.

Synopsis

Exception[] createDatas(string authkey, Data[] datas)

Parameters

authkey

The user authentication key returned from login().

datas

The Data objects to add.

Return Value

Returns an array of Exceptions, corresponding to the status of each item in the input array.

Description

This function adds multiple new Data objects to the system.

Access Control

This function requires the calling user have Update Data privileges on the DataSet.

See Also

createData, createDataSet, createDataSets, createWorkunitsFromDataSetsAsync, deleteData, deleteDatas, deleteDataSet, deleteDataSets, getAllDataSets, getData, getDatas, getDatasByDataSet, getDatasById, getDatasByWorkunit, getDataSet, getDataSetByName, getDataSets, getDataSetsByGuid, getDataSetsByJobStepWorkunits, getWorkunitsWithDatasByGuid, updateDataSet, updateDataSets


createDataSet

Create a new DataSet object.

Synopsis

guid createDataSet(string authkey, DataSet data_set)

Parameters

authkey

The user authentication key returned from login().

data_set

The DataSet object to add.

Return Value

The return value is the identifier of the new DataSet object. An exception is thrown if the function fails.

Description

This function adds a new DataSet object to the system. Note that the data_set_name specified to this function must be unique within the system. If another DataSet exists with the same name, this function will fail. This may happen even if the calling user cannot view the other data set due to access control.

Access Control

If a Job or JobStep is specified in the DataSet object, the calling user must have the Manage Job privilege on the Job. Otherwise, the user must have the MP Administrator role.

See Also

createDataSets, createWorkunitsFromDataSetsAsync, deleteDataSet, deleteDataSets, getAllDataSets, getDatasByDataSet, getDataSet, getDataSetByName, getDataSets, getDataSetsByGuid, getDataSetsByJobStepWorkunits, updateDataSet, updateDataSets


createDataSets

Create multiple new DataSet objects.

Synopsis

ExceptionOrGuid[] createDataSets(string authkey, DataSet[] data_sets)

Parameters

authkey

The user authentication key returned from login().

data_sets

The DataSet objects to add.

Return Value

Returns an array of Exceptions or guids, corresponding to the error status, or the new guid of each item in the input array.

Description

This function adds multiple new DataSet objects to the system.

Access Control

If a Job or JobStep is specified in the DataSet object, the calling user must have the Manage Job privilege on the Job. Otherwise, the user must have the MP Administrator role.

See Also

createAgentModules, createAgentVersions, createApplications, createCredentials, createDataSet, createDeviceGroups, createDeviceProfiles, createGlobalResources, createJobs, createJobSteps, createJobStepsWithResourceRequirements, createProgramModules, createProgramModuleVersions, createPrograms, createProgramVersions, createResources, createSchedulingDescriptors, createServices, createUserGroups, createUsers, createWorkunits, createWorkunitsFromDataSetsAsync, deleteDataSet, deleteDataSets, getAllDataSets, getDatasByDataSet, getDataSet, getDataSetByName, getDataSets, getDataSetsByGuid, getDataSetsByJobStepWorkunits, updateDataSet, updateDataSets


createDeviceGroup

Create a new DeviceGroup object.

Synopsis

guid createDeviceGroup(string authkey, DeviceGroup device_group)

Parameters

authkey

The user authentication key returned from login().

device_group

The DeviceGroup object to add.

Return Value

The return value is the identifier of the new DeviceGroup object. An exception is thrown if the function fails.

Description

This function adds a new DeviceGroup object to the system. The 'device_group_gid' field of the DeviceGroup object is ignored on input. The 'default_device_profile_gid' field of the DeviceGroup object is ignored on input, and a copy of the default DeviceGroup's default DeviceProfile is created instead. The gid assigned to the object is the return value of the function. Note that the device_group_name specified to this function must be unique within the system. If another DeviceGroup exists with the same name, this function will fail. This may happen even if the calling user cannot view the other device group due to access control.

Access Control

This function requires the calling user have the Device Group Creator role.

See Also

addDeviceGroupsToJob, addDeviceGroupToJob, createDeviceGroups, deleteDeviceGroup, deleteDeviceGroups, getAllDeviceGroups, getCountDeviceGroupsByAgentVersion, getCountDevicesByDeviceGroup, getDeviceGroup, getDeviceGroupByName, getDeviceGroups, getDeviceGroupsByGuid, getDeviceGroupsByJob, getDeviceProfilesByDeviceGroup, getDevicesByDeviceGroup, getJobsByDeviceGroup, getSchedulingDescriptorsByDeviceGroup, getSchedulingDescriptorUserGroupsByDeviceGroup, getSchedulingDescriptorUsersByDeviceGroup, getStatsAllDeviceGroups, getStatsDeviceGroup, getStatsDevicesByDeviceGroup, removeDeviceGroupFromJob, removeDeviceGroupsFromJob, setJobDeviceGroups, updateDeviceGroup, updateDeviceGroupRestricted, updateDeviceGroups


createDeviceGroups

Create multiple new DeviceGroup objects.

Synopsis

ExceptionOrGuid[] createDeviceGroups(string authkey, DeviceGroup[] device_groups)

Parameters

authkey

The user authentication key returned from login().

device_groups

The DeviceGroup objects to add.

Return Value

Returns an array of Exceptions or guids, corresponding to the error status, or the new guid of each item in the input array.

Description

This function adds a multiple new DeviceGroup objects to the system. The 'device_group_gid' field of the DeviceGroup objects are ignored on input. The 'default_device_profile_gid' field of the DeviceGroup objects are ignored on input, and copies of the default DeviceGroup's default DeviceProfile are created instead. The gid assigned to each object is in the return value of the function.

Access Control

This function requires the calling user have the Device Group Creator role.

See Also

addDeviceGroupsToJob, addDeviceGroupToJob, createAgentModules, createAgentVersions, createApplications, createCredentials, createDataSets, createDeviceGroup, createDeviceProfiles, createGlobalResources, createJobs, createJobSteps, createJobStepsWithResourceRequirements, createProgramModules, createProgramModuleVersions, createPrograms, createProgramVersions, createResources, createSchedulingDescriptors, createServices, createUserGroups, createUsers, createWorkunits, deleteDeviceGroup, deleteDeviceGroups, getAllDeviceGroups, getCountDeviceGroupsByAgentVersion, getCountDevicesByDeviceGroup, getDeviceGroup, getDeviceGroupByName, getDeviceGroups, getDeviceGroupsByGuid, getDeviceGroupsByJob, getDeviceProfilesByDeviceGroup, getDevicesByDeviceGroup, getJobsByDeviceGroup, getSchedulingDescriptorsByDeviceGroup, getSchedulingDescriptorUserGroupsByDeviceGroup, getSchedulingDescriptorUsersByDeviceGroup, getStatsAllDeviceGroups, getStatsDeviceGroup, getStatsDevicesByDeviceGroup, removeDeviceGroupFromJob, removeDeviceGroupsFromJob, setJobDeviceGroups, updateDeviceGroup, updateDeviceGroupRestricted, updateDeviceGroups


createDeviceProfile

Create a new DeviceProfile object.

Synopsis

guid createDeviceProfile(string authkey, DeviceProfile device_profile)

Parameters

authkey

The user authentication key returned from login().

device_profile

The DeviceProfile object to add.

Return Value

The return value is the identifier of the new DeviceProfile object. An exception is thrown if the function fails.

Description

This function adds a new DeviceProfile object to the system.

Access Control

This function requires the calling user have Update Device Group privileges on the DeviceGroup.

See Also

addApplicationsToDeviceProfile, addApplicationToDeviceProfile, addProgramsToDeviceProfile, addProgramToDeviceProfile, createDeviceProfiles, deleteDeviceProfile, deleteDeviceProfiles, getAllDeviceProfiles, getApplicationsByDeviceProfile, getCountDevicesByDeviceProfile, getDeviceProfile, getDeviceProfiles, getDeviceProfilesByDeviceGroup, getDeviceProfilesByGuid, getDevicesByDeviceProfile, getProgramsByDeviceProfile, removeApplicationFromDeviceProfile, removeApplicationsFromDeviceProfile, removeProgramFromDeviceProfile, removeProgramsFromDeviceProfile, setDeviceProfileApplications, setDeviceProfilePrograms, updateDeviceProfile, updateDeviceProfiles


createDeviceProfiles

Create multiple new DeviceProfile objects.

Synopsis

ExceptionOrGuid[] createDeviceProfiles(string authkey, DeviceProfile[] device_profiles)

Parameters

authkey

The user authentication key returned from login().

device_profiles

The DeviceProfile objects to add.

Return Value

Returns an array of Exceptions or guids, corresponding to the error status, or the new guid of each item in the input array.

Description

This function adds multiple new DeviceProfile objects to the system.

Access Control

This function requires the calling user have Update Device Group privileges on the DeviceGroup.

See Also

addApplicationsToDeviceProfile, addApplicationToDeviceProfile, addProgramsToDeviceProfile, addProgramToDeviceProfile, createAgentModules, createAgentVersions, createApplications, createCredentials, createDataSets, createDeviceGroups, createDeviceProfile, createGlobalResources, createJobs, createJobSteps, createJobStepsWithResourceRequirements, createProgramModules, createProgramModuleVersions, createPrograms, createProgramVersions, createResources, createSchedulingDescriptors, createServices, createUserGroups, createUsers, createWorkunits, deleteDeviceProfile, deleteDeviceProfiles, getAllDeviceProfiles, getApplicationsByDeviceProfile, getCountDevicesByDeviceProfile, getDeviceProfile, getDeviceProfiles, getDeviceProfilesByDeviceGroup, getDeviceProfilesByGuid, getDevicesByDeviceProfile, getProgramsByDeviceProfile, removeApplicationFromDeviceProfile, removeApplicationsFromDeviceProfile, removeProgramFromDeviceProfile, removeProgramsFromDeviceProfile, setDeviceProfileApplications, setDeviceProfilePrograms, updateDeviceProfile, updateDeviceProfiles


createGlobalResource

Create a new GlobalResource object.

Synopsis

guid createGlobalResource(string authkey, GlobalResource global_resource)

Parameters

authkey

The user authentication key returned from login().

global_resource

The GlobalResource object to add.

Return Value

The return value is the identifier of the new GlobalResource object. An exception is thrown if the function fails.

Description

This function adds a new GlobalResource object to the system.

Access Control

This function requires the calling user have the Resource Creator role.

See Also

createGlobalResources, deleteGlobalResource, deleteGlobalResourceRequirement, deleteGlobalResources, getAllGlobalResourceRequirements, getAllGlobalResources, getGlobalResource, getGlobalResourceByName, getGlobalResourceRequirementsByGlobalResource, getGlobalResourceRequirementsByProgramModule, getGlobalResources, setGlobalResourceRequirement, setGlobalResourceRequirements, updateGlobalResource, updateGlobalResources


createGlobalResources

Create multiple new GlobalResource objects.

Synopsis

ExceptionOrGuid[] createGlobalResources(string authkey, GlobalResource[] global_resources)

Parameters

authkey

The user authentication key returned from login().

global_resources

The GlobalResource objects to add.

Return Value

Returns an array of Exceptions or guids, corresponding to the error status, or the new guid of each item in the input array.

Description

This function adds multiple new GlobalResource objects to the system.

Access Control

This function requires the calling user have the Resource Creator role.

See Also

createAgentModules, createAgentVersions, createApplications, createCredentials, createDataSets, createDeviceGroups, createDeviceProfiles, createGlobalResource, createJobs, createJobSteps, createJobStepsWithResourceRequirements, createProgramModules, createProgramModuleVersions, createPrograms, createProgramVersions, createResources, createSchedulingDescriptors, createServices, createUserGroups, createUsers, createWorkunits, deleteGlobalResource, deleteGlobalResourceRequirement, deleteGlobalResources, getAllGlobalResourceRequirements, getAllGlobalResources, getGlobalResource, getGlobalResourceByName, getGlobalResourceRequirementsByGlobalResource, getGlobalResourceRequirementsByProgramModule, getGlobalResources, setGlobalResourceRequirement, setGlobalResourceRequirements, updateGlobalResource, updateGlobalResources


createJob

Create a new Job object.

Synopsis

guid createJob(string authkey, Job job)

Parameters

authkey

The user authentication key returned from login().

job

The Job object to add.

Return Value

The return value is the identifier of the new Job object. An exception is thrown if the function fails.

Description

This function adds a new Job object to the system. If the Application for this Job has been set to the Disabled, Closed or Pending Delete state, then this function will fail.

Access Control

This function requires the calling user have Create Job privileges on the Job.

See Also

addDeviceGroupsToJob, addDeviceGroupToJob, createJob2, createJobs, createJobStep, createJobSteps, createJobStepsWithResourceRequirements, createJobStepWithResourceRequirements, deleteJob, deleteJobs, deleteJobStep, deleteJobSteps, getAllJobs, getDataSetsByJobStepWorkunits, getDeviceGroupsByJob, getJob, getJobById, getJobs, getJobsByApplication, getJobsByDeviceGroup, getJobsByGuid, getJobStatus, getJobStatusesByGuid, getJobStep, getJobSteps, getJobStepsByGuid, getJobStepsByJob, getJobStepsByProgram, getJobStepStatus, getProgramModuleVersionsByJobStep, getResourceRequirementsByJobStep, getResultsByJobStep, getStatsAllJobStates, getStatsJobDevices, getWorkunitsByJobStep, getWorkunitStatesByJobStep, removeDeviceGroupFromJob, removeDeviceGroupsFromJob, setJobDeviceGroups, updateJob, updateJobs, updateJobStep, updateJobSteps


createJob2

Create a new Job object. Similar to createJob but returns both the new job's "job_gid" and "id" members.

Synopsis

JobGuidAndId createJob2(string authkey, Job job)

Parameters

authkey

The user authentication key returned from login().

job

The Job object to add.

Return Value

The return value is the identifiers of the new Job object. An exception is thrown if the function fails.

Description

This function adds a new Job object to the system. If the Application for this Job has been set to the Disabled, Closed or Pending Delete state, then this function will fail.

Access Control

This function requires the calling user have Create Job privileges on the Job.

See Also

addDeviceGroupsToJob, addDeviceGroupToJob, createJob, createJobs, createJobStep, createJobSteps, createJobStepsWithResourceRequirements, createJobStepWithResourceRequirements, deleteJob, deleteJobs, deleteJobStep, deleteJobSteps, getAllJobs, getDataSetsByJobStepWorkunits, getDeviceGroupsByJob, getJob, getJobById, getJobs, getJobsByApplication, getJobsByDeviceGroup, getJobsByGuid, getJobStatus, getJobStatusesByGuid, getJobStep, getJobSteps, getJobStepsByGuid, getJobStepsByJob, getJobStepsByProgram, getJobStepStatus, getProgramModuleVersionsByJobStep, getResourceRequirementsByJobStep, getResultsByJobStep, getStatsAllJobStates, getStatsJobDevices, getWorkunitsByJobStep, getWorkunitStatesByJobStep, removeDeviceGroupFromJob, removeDeviceGroupsFromJob, setJobDeviceGroups, updateJob, updateJobs, updateJobStep, updateJobSteps


createJobs

Create multiple new Job objects.

Synopsis

ExceptionOrGuid[] createJobs(string authkey, Job[] jobs)

Parameters

authkey

The user authentication key returned from login().

jobs

The Job objects to add.

Return Value

Returns an array of Exceptions or guids, corresponding to the error status, or the new guid of each item in the input array.

Description

This function adds multiple new Job objects to the system. If the Applications for the Jobs have been set to the Disabled, Closed or Pending Delete state, then the creation will fail.

Access Control

This function requires the calling user have Create Job privileges on the Job.

See Also

addDeviceGroupsToJob, addDeviceGroupToJob, createAgentModules, createAgentVersions, createApplications, createCredentials, createDataSets, createDeviceGroups, createDeviceProfiles, createGlobalResources, createJob, createJob2, createJobStep, createJobSteps, createJobStepsWithResourceRequirements, createJobStepWithResourceRequirements, createProgramModules, createProgramModuleVersions, createPrograms, createProgramVersions, createResources, createSchedulingDescriptors, createServices, createUserGroups, createUsers, createWorkunits, deleteJob, deleteJobs, deleteJobStep, deleteJobSteps, getAllJobs, getDataSetsByJobStepWorkunits, getDeviceGroupsByJob, getJob, getJobById, getJobs, getJobsByApplication, getJobsByDeviceGroup, getJobsByGuid, getJobStatus, getJobStatusesByGuid, getJobStep, getJobSteps, getJobStepsByGuid, getJobStepsByJob, getJobStepsByProgram, getJobStepStatus, getProgramModuleVersionsByJobStep, getResourceRequirementsByJobStep, getResultsByJobStep, getStatsAllJobStates, getStatsJobDevices, getWorkunitsByJobStep, getWorkunitStatesByJobStep, removeDeviceGroupFromJob, removeDeviceGroupsFromJob, setJobDeviceGroups, updateJob, updateJobs, updateJobStep, updateJobSteps


createJobStep

Create a new JobStep object.

Synopsis

guid createJobStep(string authkey, JobStep job_step)

Parameters

authkey

The user authentication key returned from login().

job_step

The JobStep object to add.

Return Value

The return value is the identifier of the new JobStep object. An exception is thrown if the function fails.

Description

This function adds a new JobStep object to the system. If the Program for this JobStep has been set to the Disabled, Closed or Pending Delete state, then this function will fail.

Access Control

This function requires the calling user have Update Job privileges on the Job.

See Also

createJobSteps, createJobStepsWithResourceRequirements, createJobStepWithResourceRequirements, deleteJobStep, deleteJobSteps, getDataSetsByJobStepWorkunits, getJobStep, getJobSteps, getJobStepsByGuid, getJobStepsByJob, getJobStepsByProgram, getJobStepStatus, getProgramModuleVersionsByJobStep, getResourceRequirementsByJobStep, getResultsByJobStep, getWorkunitsByJobStep, getWorkunitStatesByJobStep, updateJobStep, updateJobSteps


createJobSteps

Create multiple new JobStep objects.

Synopsis

ExceptionOrGuid[] createJobSteps(string authkey, JobStep[] job_steps)

Parameters

authkey

The user authentication key returned from login().

job_steps

The JobStep objects to add.

Return Value

Returns an array of Exceptions or guids, corresponding to the error status, or the new guid of each item in the input array.

Description

This function adds multiple new JobStep objects to the system. If the Programs for the JobSteps have been set to the Disabled, Closed or Pending Delete state, then the creation will fail.

Access Control

This function requires the calling user have Update Job privileges on the Job.

See Also

createAgentModules, createAgentVersions, createApplications, createCredentials, createDataSets, createDeviceGroups, createDeviceProfiles, createGlobalResources, createJobs, createJobStep, createJobStepsWithResourceRequirements, createJobStepWithResourceRequirements, createProgramModules, createProgramModuleVersions, createPrograms, createProgramVersions, createResources, createSchedulingDescriptors, createServices, createUserGroups, createUsers, createWorkunits, deleteJobStep, deleteJobSteps, getDataSetsByJobStepWorkunits, getJobStep, getJobSteps, getJobStepsByGuid, getJobStepsByJob, getJobStepsByProgram, getJobStepStatus, getProgramModuleVersionsByJobStep, getResourceRequirementsByJobStep, getResultsByJobStep, getWorkunitsByJobStep, getWorkunitStatesByJobStep, updateJobStep, updateJobSteps


createJobStepsWithResourceRequirements

Create multiple new JobStep objects.

Synopsis

ExceptionOrGuid[] createJobStepsWithResourceRequirements(string authkey, JobStep[] job_steps, ResourceRequirement[] resource_requirements)

Parameters

authkey

The user authentication key returned from login().

job_steps

The JobStep objects to add.

resource_requirements

Optional list of ResourceRequirements which will supersede any ResourceRequirements inherited from the ProgramModules for all of the specified JobSteps.

Return Value

Returns an array of Exceptions or guids, corresponding to the error status, or the new guid of each item in the input array.

Description

This function adds multiple new JobStep objects to the system. If the Programs for the JobSteps have been set to the Disabled, Closed or Pending Delete state, then the creation will fail.

Access Control

This function requires the calling user have Update Job privileges on the Job.

See Also

createAgentModules, createAgentVersions, createApplications, createCredentials, createDataSets, createDeviceGroups, createDeviceProfiles, createGlobalResources, createJobs, createJobSteps, createJobStepWithResourceRequirements, createProgramModules, createProgramModuleVersions, createPrograms, createProgramVersions, createResources, createSchedulingDescriptors, createServices, createUserGroups, createUsers, createWorkunits, getResourceRequirementsByJobStep


createJobStepWithResourceRequirements

Create a new JobStep object.

Synopsis

guid createJobStepWithResourceRequirements(string authkey, JobStep job_step, ResourceRequirement[] resource_requirements)

Parameters

authkey

The user authentication key returned from login().

job_step

The JobStep object to add.

resource_requirements

Optional list of ResourceRequirements which will supersede any ResourceRequirements inherited from the ProgramModule of the specified JobStep.

Return Value

The return value is the identifier of the new JobStep object. An exception is thrown if the function fails.

Description

This function adds a new JobStep object to the system. If the Program for this JobStep has been set to the Disabled, Closed or Pending Delete state, then this function will fail.

Access Control

This function requires the calling user have Update Job privileges on the Job.

See Also

createJobStepsWithResourceRequirements, getResourceRequirementsByJobStep


createProgram

Create a new Program object.

Synopsis

guid createProgram(string authkey, Program program)

Parameters

authkey

The user authentication key returned from login().

program

The Program object to add.

Return Value

The return value is the identifier of the new Program object. An exception is thrown if the function fails.

Description

This function adds a new Program object to the system. Note that the program_name specified to this function must be unique within the system. If another Program exists with the same name, this function will fail. This may happen even if the calling user cannot view the other program due to access control. Programs may be created in any state except PENDING_DELETE.

Access Control

This function requires the calling user have the Program Creator role.

See Also

addProgramsToApplication, addProgramsToDeviceProfile, addProgramToApplication, addProgramToDeviceProfile, createProgramModule, createProgramModules, createProgramModuleVersion, createProgramModuleVersions, createPrograms, createProgramVersion, createProgramVersions, deleteProgram, deleteProgramModule, deleteProgramModules, deleteProgramModuleVersion, deleteProgramModuleVersions, deletePrograms, deleteProgramVersion, deleteProgramVersions, getAllPrograms, getApplicationsByProgram, getGlobalResourceRequirementsByProgramModule, getJobStepsByProgram, getProgram, getProgramByName, getProgramModule, getProgramModules, getProgramModulesByGuid, getProgramModulesByProgram, getProgramModulesByProgramVersion, getProgramModuleVersion, getProgramModuleVersions, getProgramModuleVersionsByGuid, getProgramModuleVersionsByJobStep, getProgramModuleVersionsByProgramModule, getPrograms, getProgramsByApplication, getProgramsByDeviceProfile, getProgramsByGuid, getProgramVersion, getProgramVersions, getProgramVersionsByGuid, getProgramVersionsByProgram, getResourceRequirementsByProgramModule, removeProgramFromApplication, removeProgramFromDeviceProfile, removeProgramsFromApplication, removeProgramsFromDeviceProfile, setApplicationPrograms, setDeviceProfilePrograms, updateProgram, updateProgramModule, updateProgramModules, updatePrograms, updateProgramVersion, updateProgramVersions


createProgramModule

Create a new ProgramModule object.

Synopsis

guid createProgramModule(string authkey, ProgramModule program_module)

Parameters

authkey

The user authentication key returned from login().

program_module

The ProgramModule object to add.

Return Value

The return value is the identifier of the new ProgramModule object. An exception is thrown if the function fails.

Description

This function adds a new ProgramModule object to the system.

Access Control

This function requires the calling user have Update Program privileges on the Program.

See Also

createProgramModules, createProgramModuleVersion, createProgramModuleVersions, deleteProgramModule, deleteProgramModules, deleteProgramModuleVersion, deleteProgramModuleVersions, getGlobalResourceRequirementsByProgramModule, getProgramModule, getProgramModules, getProgramModulesByGuid, getProgramModulesByProgram, getProgramModulesByProgramVersion, getProgramModuleVersion, getProgramModuleVersions, getProgramModuleVersionsByGuid, getProgramModuleVersionsByJobStep, getProgramModuleVersionsByProgramModule, getResourceRequirementsByProgramModule, updateProgramModule, updateProgramModules


createProgramModules

Create multiple new ProgramModule objects.

Synopsis

ExceptionOrGuid[] createProgramModules(string authkey, ProgramModule[] program_modules)

Parameters

authkey

The user authentication key returned from login().

program_modules

The ProgramModule objects to add.

Return Value

Returns an array of Exceptions or guids, corresponding to the error status, or the new guid of each item in the input array.

Description

This function adds multiple new ProgramModule objects to the system.

Access Control

This function requires the calling user have Update Program privileges on the Program.

See Also

createAgentModules, createAgentVersions, createApplications, createCredentials, createDataSets, createDeviceGroups, createDeviceProfiles, createGlobalResources, createJobs, createJobSteps, createJobStepsWithResourceRequirements, createProgramModule, createProgramModuleVersion, createProgramModuleVersions, createPrograms, createProgramVersions, createResources, createSchedulingDescriptors, createServices, createUserGroups, createUsers, createWorkunits, deleteProgramModule, deleteProgramModules, deleteProgramModuleVersion, deleteProgramModuleVersions, getGlobalResourceRequirementsByProgramModule, getProgramModule, getProgramModules, getProgramModulesByGuid, getProgramModulesByProgram, getProgramModulesByProgramVersion, getProgramModuleVersion, getProgramModuleVersions, getProgramModuleVersionsByGuid, getProgramModuleVersionsByJobStep, getProgramModuleVersionsByProgramModule, getResourceRequirementsByProgramModule, updateProgramModule, updateProgramModules


createProgramModuleVersion

Create a new ProgramModuleVersion object.

Synopsis

guid createProgramModuleVersion(string authkey, ProgramModuleVersion program_module_version)

Parameters

authkey

The user authentication key returned from login().

program_module_version

The ProgramModuleVersion object to add.

Return Value

The return value is the identifier of the new ProgramModuleVersion object. An exception is thrown if the function fails.

Description

This function adds a new ProgramModuleVersion object to the system. If the current_version_gid in this ProgramModuleVersion's ProgramModule is set to the null guid, then it will be changed to point to this newly created object.

Access Control

This function requires the calling user have Update Program privileges on the Program.

See Also

createProgramModuleVersions, deleteProgramModuleVersion, deleteProgramModuleVersions, getProgramModuleVersion, getProgramModuleVersions, getProgramModuleVersionsByGuid, getProgramModuleVersionsByJobStep, getProgramModuleVersionsByProgramModule


createProgramModuleVersions

Create multiple new ProgramModuleVersion objects.

Synopsis

ExceptionOrGuid[] createProgramModuleVersions(string authkey, ProgramModuleVersion[] program_module_versions)

Parameters

authkey

The user authentication key returned from login().

program_module_versions

The ProgramModuleVersion objects to add.

Return Value

Returns an array of Exceptions or guids, corresponding to the error status, or the new guid of each item in the input array.

Description

This function adds multiple new ProgramModuleVersion objects to the system. If the current_version_gid in any ProgramModuleVersion's ProgramModule is set to the null guid, then it will be changed to point to that newly created object. The objects are created in order that they appear in the vector.

Access Control

This function requires the calling user have Update Program privileges on the Program.

See Also

createAgentModules, createAgentVersions, createApplications, createCredentials, createDataSets, createDeviceGroups, createDeviceProfiles, createGlobalResources, createJobs, createJobSteps, createJobStepsWithResourceRequirements, createProgramModules, createProgramModuleVersion, createPrograms, createProgramVersions, createResources, createSchedulingDescriptors, createServices, createUserGroups, createUsers, createWorkunits, deleteProgramModuleVersion, deleteProgramModuleVersions, getProgramModuleVersion, getProgramModuleVersions, getProgramModuleVersionsByGuid, getProgramModuleVersionsByJobStep, getProgramModuleVersionsByProgramModule


createPrograms

Create multiple new Program objects.

Synopsis

ExceptionOrGuid[] createPrograms(string authkey, Program[] programs)

Parameters

authkey

The user authentication key returned from login().

programs

The Program objects to add.

Return Value

Returns an array of Exceptions or guids, corresponding to the error status, or the new guid of each item in the input array.

Description

This function adds multiple new Program objects to the system.

Access Control

This function requires the calling user have the Program Creator role.

See Also

addProgramsToApplication, addProgramsToDeviceProfile, addProgramToApplication, addProgramToDeviceProfile, createAgentModules, createAgentVersions, createApplications, createCredentials, createDataSets, createDeviceGroups, createDeviceProfiles, createGlobalResources, createJobs, createJobSteps, createJobStepsWithResourceRequirements, createProgram, createProgramModule, createProgramModules, createProgramModuleVersion, createProgramModuleVersions, createProgramVersion, createProgramVersions, createResources, createSchedulingDescriptors, createServices, createUserGroups, createUsers, createWorkunits, deleteProgram, deleteProgramModule, deleteProgramModules, deleteProgramModuleVersion, deleteProgramModuleVersions, deletePrograms, deleteProgramVersion, deleteProgramVersions, getAllPrograms, getApplicationsByProgram, getGlobalResourceRequirementsByProgramModule, getJobStepsByProgram, getProgram, getProgramByName, getProgramModule, getProgramModules, getProgramModulesByGuid, getProgramModulesByProgram, getProgramModulesByProgramVersion, getProgramModuleVersion, getProgramModuleVersions, getProgramModuleVersionsByGuid, getProgramModuleVersionsByJobStep, getProgramModuleVersionsByProgramModule, getPrograms, getProgramsByApplication, getProgramsByDeviceProfile, getProgramsByGuid, getProgramVersion, getProgramVersions, getProgramVersionsByGuid, getProgramVersionsByProgram, getResourceRequirementsByProgramModule, removeProgramFromApplication, removeProgramFromDeviceProfile, removeProgramsFromApplication, removeProgramsFromDeviceProfile, setApplicationPrograms, setDeviceProfilePrograms, updateProgram, updateProgramModule, updateProgramModules, updatePrograms, updateProgramVersion, updateProgramVersions


createProgramVersion

Create a new ProgramVersion object.

Synopsis

guid createProgramVersion(string authkey, ProgramVersion program_version)

Parameters

authkey

The user authentication key returned from login().

program_version

The ProgramVersion object to add.

Return Value

The return value is the identifier of the new ProgramVersion object. An exception is thrown if the function fails.

Description

This function adds a new ProgramVersion object to the system. If the current_version_gid in this ProgramVersion's Program is set to the null guid, then it will be changed to point to this newly created object.

Access Control

This function requires the calling user have Update Program privileges on the Program.

See Also

createProgramVersions, deleteProgramVersion, deleteProgramVersions, getProgramModulesByProgramVersion, getProgramVersion, getProgramVersions, getProgramVersionsByGuid, getProgramVersionsByProgram, updateProgramVersion, updateProgramVersions


createProgramVersions

Create multiple new ProgramVersion objects.

Synopsis

ExceptionOrGuid[] createProgramVersions(string authkey, ProgramVersion[] program_versions)

Parameters

authkey

The user authentication key returned from login().

program_versions

The ProgramVersion objects to add.

Return Value

Returns an array of Exceptions or guids, corresponding to the error status, or the new guid of each item in the input array.

Description

This function adds multiple new ProgramVersion objects to the system. If the current_version_gid for any ProgramVersion's Program is set to the null guid, then it will be changed to point to that newly created object. The objects are created in order that they appear in the vector.

Access Control

This function requires the calling user have Update Program privileges on the Program.

See Also

createAgentModules, createAgentVersions, createApplications, createCredentials, createDataSets, createDeviceGroups, createDeviceProfiles, createGlobalResources, createJobs, createJobSteps, createJobStepsWithResourceRequirements, createProgramModules, createProgramModuleVersions, createPrograms, createProgramVersion, createResources, createSchedulingDescriptors, createServices, createUserGroups, createUsers, createWorkunits, deleteProgramVersion, deleteProgramVersions, getProgramModulesByProgramVersion, getProgramVersion, getProgramVersions, getProgramVersionsByGuid, getProgramVersionsByProgram, updateProgramVersion, updateProgramVersions


createResource

Create a new Resource object.

Synopsis

guid createResource(string authkey, Resource resource)

Parameters

authkey

The user authentication key returned from login().

resource

The Resource object to add.

Return Value

The return value is the identifier of the new Resource object. An exception is thrown if the function fails.

Description

This function adds a new Resource object to the system.

Access Control

This function requires the calling user have the Resource Creator role.

See Also

createGlobalResource, createGlobalResources, createJobStepsWithResourceRequirements, createJobStepWithResourceRequirements, createResources, deleteGlobalResource, deleteGlobalResourceRequirement, deleteGlobalResources, deleteResource, deleteResourceAvailable, deleteResourceRequirement, deleteResources, getAllGlobalResourceRequirements, getAllGlobalResources, getAllResourceAvailables, getAllResourceRequirements, getAllResources, getGlobalResource, getGlobalResourceByName, getGlobalResourceRequirementsByGlobalResource, getGlobalResourceRequirementsByProgramModule, getGlobalResources, getResource, getResourceAvailablesByDevice, getResourceAvailablesByResource, getResourceByName, getResourceRequirementsByJobStep, getResourceRequirementsByProgramModule, getResourceRequirementsByResource, getResources, getResourcesByGuid, setGlobalResourceRequirement, setGlobalResourceRequirements, setResourceAvailable, setResourceAvailables, setResourceRequirement, setResourceRequirements, updateGlobalResource, updateGlobalResources


createResources

Create multiple new Resource objects.

Synopsis

ExceptionOrGuid[] createResources(string authkey, Resource[] resources)

Parameters

authkey

The user authentication key returned from login().

resources

The Resource objects to add.

Return Value

Returns an array of Exceptions or guids, corresponding to the error status, or the new guid of each item in the input array.

Description

This function adds multiple new Resource objects to the system.

Access Control

This function requires the calling user have the Resource Creator role.

See Also

createAgentModules, createAgentVersions, createApplications, createCredentials, createDataSets, createDeviceGroups, createDeviceProfiles, createGlobalResource, createGlobalResources, createJobs, createJobSteps, createJobStepsWithResourceRequirements, createJobStepWithResourceRequirements, createProgramModules, createProgramModuleVersions, createPrograms, createProgramVersions, createResource, createSchedulingDescriptors, createServices, createUserGroups, createUsers, createWorkunits, deleteGlobalResource, deleteGlobalResourceRequirement, deleteGlobalResources, deleteResource, deleteResourceAvailable, deleteResourceRequirement, deleteResources, getAllGlobalResourceRequirements, getAllGlobalResources, getAllResourceAvailables, getAllResourceRequirements, getAllResources, getGlobalResource, getGlobalResourceByName, getGlobalResourceRequirementsByGlobalResource, getGlobalResourceRequirementsByProgramModule, getGlobalResources, getResource, getResourceAvailablesByDevice, getResourceAvailablesByResource, getResourceByName, getResourceRequirementsByJobStep, getResourceRequirementsByProgramModule, getResourceRequirementsByResource, getResources, getResourcesByGuid, setGlobalResourceRequirement, setGlobalResourceRequirements, setResourceAvailable, setResourceAvailables, setResourceRequirement, setResourceRequirements, updateGlobalResource, updateGlobalResources


createResultQueue

Create a new Result queue.

Synopsis

guid createResultQueue(string authkey, guid job_step_gid)

Parameters

authkey

The user authentication key returned from login().

job_step_gid

The unique identifier of the JobStep for which a new result queue will be created.

Return Value

The return value is the identifier of the new result queue. An exception is thrown if the function fails.

Description

This function creates a new queue to hold Results from a JobStep. Any number of queues may be created for a JobStep. When a result queue is created, all existing results for that job step are automatically inserted into the queue. New results are automatically inserted into all existing result queues for that job step. Result queues are independent: Removing results from one queue does not affect other queues.

Access Control

This function requires the calling user have Read Job privileges on the Job.

See Also

deleteResult, deleteResultQueue, deleteResults, getResult, getResults, getResultsById, getResultsByJobStep, getResultsByResultQueue, getResultsByWorkunit, removeResultsFromResultQueue


createSchedulingDescriptor

Create a new SchedulingDescriptor object.

Synopsis

guid createSchedulingDescriptor(string authkey, SchedulingDescriptor scheduling_descriptor)

Parameters

authkey

The user authentication key returned from login().

scheduling_descriptor

The SchedulingDescriptor object to add.

Return Value

The return value is the identifier of the new SchedulingDescriptor object. An exception is thrown if the function fails.

Description

This function adds a new SchedulingDescriptor object to the system.

Access Control

This function requires the calling user have Update Device Group privileges on the DeviceGroup.

See Also

createSchedulingDescriptors, deleteSchedulingDescriptor, deleteSchedulingDescriptors, getAllSchedulingDescriptors, getSchedulingDescriptor, getSchedulingDescriptorsByDeviceGroup, getSchedulingDescriptorUserGroupsByDeviceGroup, getSchedulingDescriptorUsersByDeviceGroup, updateSchedulingDescriptor, updateSchedulingDescriptors


createSchedulingDescriptors

Create multiple new SchedulingDescriptor objects.

Synopsis

ExceptionOrGuid[] createSchedulingDescriptors(string authkey, SchedulingDescriptor[] scheduling_descriptors)

Parameters

authkey

The user authentication key returned from login().

scheduling_descriptors

The SchedulingDescriptor objects to add.

Return Value

Returns an array of Exceptions or guids, corresponding to the error status, or the new guid of each item in the input array.

Description

This function adds multiple new SchedulingDescriptor objects to the system.

Access Control

This function requires the calling user have Update Device Group privileges on the DeviceGroup.

See Also

createAgentModules, createAgentVersions, createApplications, createCredentials, createDataSets, createDeviceGroups, createDeviceProfiles, createGlobalResources, createJobs, createJobSteps, createJobStepsWithResourceRequirements, createProgramModules, createProgramModuleVersions, createPrograms, createProgramVersions, createResources, createSchedulingDescriptor, createServices, createUserGroups, createUsers, createWorkunits, deleteSchedulingDescriptor, deleteSchedulingDescriptors, getAllSchedulingDescriptors, getSchedulingDescriptor, getSchedulingDescriptorsByDeviceGroup, getSchedulingDescriptorUserGroupsByDeviceGroup, getSchedulingDescriptorUsersByDeviceGroup, updateSchedulingDescriptor, updateSchedulingDescriptors


createService

Create a Service object.

Synopsis

guid createService(string authkey, Service service)

Parameters

authkey

The user authentication key returned from login().

service

The Service object to add.

Return Value

The return value is the identifier of the new Service object. An exception is thrown if the function fails.

Description

This is used to create a Service object before starting a Service. The request_id and status_id are initialized to 1, regardless of what is passed in the service parameter to this function.

Access Control

This function is restricted to users with the MP Administrator role only.

See Also

createServiceManager, createServices, deleteService, deleteServiceManager, deleteServices, getAllServiceManagers, getAllServices, getService, getServiceManager, getServiceManagerByName, getServicesByServiceManager, queryServiceManager, queryServicesByServiceManager, updateService, updateServiceManager, updateServiceStatus


createServiceManager

Create a ServiceManager object.

Synopsis

guid createServiceManager(string authkey, ServiceManager service_manager)

Parameters

authkey

The user authentication key returned from login().

service_manager

The ServiceManager object to add.

Return Value

The return value is the identifier of the new ServiceManager object. An exception is thrown if the function fails.

Description

Used by the Service Manger to communicate with the system.

Access Control

This function is restricted to users with the MP Administrator role only.

See Also

deleteServiceManager, getAllServiceManagers, getServiceManager, getServiceManagerByName, getServicesByServiceManager, queryServiceManager, queryServicesByServiceManager, updateServiceManager


createServices

Create multiple new Service objects.

Synopsis

ExceptionOrGuid[] createServices(string authkey, Service[] services)

Parameters

authkey

The user authentication key returned from login().

services

The Service objects to add.

Return Value

Returns an array of Exceptions or guids, corresponding to the error status, or the new guid of each item in the input array.

Description

This function adds multiple new Service objects to the system. The same initialization defaults as in createService also apply to this function.

Access Control

This function is restricted to users with the MP Administrator role only.

See Also

createAgentModules, createAgentVersions, createApplications, createCredentials, createDataSets, createDeviceGroups, createDeviceProfiles, createGlobalResources, createJobs, createJobSteps, createJobStepsWithResourceRequirements, createProgramModules, createProgramModuleVersions, createPrograms, createProgramVersions, createResources, createSchedulingDescriptors, createService, createServiceManager, createUserGroups, createUsers, createWorkunits, deleteService, deleteServiceManager, deleteServices, getAllServiceManagers, getAllServices, getService, getServiceManager, getServiceManagerByName, getServicesByServiceManager, queryServiceManager, queryServicesByServiceManager, updateService, updateServiceManager, updateServiceStatus


createUser

Create a new User object.

Synopsis

guid createUser(string authkey, User user)

Parameters

authkey

The user authentication key returned from login().

user

The User object to add.

Return Value

The return value is the identifier of the new User object. An exception is thrown if the function fails.

Description

This function adds a new User object to the system.

Access Control

This function is restricted to users with the MP Administrator role only.

See Also

addPrivilegesToUserGroup, addPrivilegeToUserGroup, addUserOrGroupsToObjectPrivilege, addUserOrGroupsToRole, addUserOrGroupToObjectPrivilege, addUserOrGroupToRole, addUsersToUserGroup, addUserToUserGroup, createUserGroup, createUserGroups, createUsers, deleteUser, deleteUserGroup, deleteUserGroups, deleteUsers, getAllUserGroups, getAllUsers, getCountUserGroupsByRole, getCountUsersByRole, getCountUsersByUserGroup, getPrivilegesByUserGroup, getPrivilegesByUserOrGroupObject, getRolesByUserOrGroup, getSchedulingDescriptorUserGroupsByDeviceGroup, getSchedulingDescriptorUsersByDeviceGroup, getUser, getUserByName, getUserGroup, getUserGroupByName, getUserGroupPrivilegesByObject, getUserGroups, getUserGroupsByGuid, getUserGroupsByObjectPrivilege, getUserGroupsByRole, getUserGroupsByUser, getUserOrGroupPrivilegesByObject, getUserOrGroupsByObjectPrivilege, getUserOrGroupsByRole, getUserPrivilegesByObject, getUserProfile, getUsers, getUsersByGuid, getUsersByObjectPrivilege, getUsersByRole, getUsersByUserGroup, removePrivilegeFromUserGroup, removePrivilegesFromUserGroup, removeUserFromUserGroup, removeUserOrGroupFromObjectPrivilege, removeUserOrGroupFromRole, removeUserOrGroupsFromObjectPrivilege, removeUserOrGroupsFromRole, removeUsersFromUserGroup, setObjectPrivilegeUserAndGroups, setObjectUserOrGroupPrivileges, setRoleUserAndGroups, setUserGroupPrivileges, setUserGroupUsers, setUserOrGroupRoles, setUserUserGroups, updateUser, updateUserGroup, updateUserGroups, updateUserPassword, updateUserProfile, updateUsers


createUserGroup

Create a new UserGroup object.

Synopsis

guid createUserGroup(string authkey, UserGroup user_group)

Parameters

authkey

The user authentication key returned from login().

user_group

The UserGroup object to add.

Return Value

The return value is the identifier of the new UserGroup object. An exception is thrown if the function fails.

Description

This function adds a new UserGroup object to the system.

Access Control

This function is restricted to users with the MP Administrator role only.

See Also

addPrivilegesToUserGroup, addPrivilegeToUserGroup, addUsersToUserGroup, addUserToUserGroup, createUserGroups, deleteUserGroup, deleteUserGroups, getAllUserGroups, getCountUserGroupsByRole, getCountUsersByUserGroup, getPrivilegesByUserGroup, getSchedulingDescriptorUserGroupsByDeviceGroup, getUserGroup, getUserGroupByName, getUserGroupPrivilegesByObject, getUserGroups, getUserGroupsByGuid, getUserGroupsByObjectPrivilege, getUserGroupsByRole, getUserGroupsByUser, getUsersByUserGroup, removePrivilegeFromUserGroup, removePrivilegesFromUserGroup, removeUserFromUserGroup, removeUsersFromUserGroup, setUserGroupPrivileges, setUserGroupUsers, setUserUserGroups, updateUserGroup, updateUserGroups


createUserGroups

Create multiple new UserGroup objects.

Synopsis

ExceptionOrGuid[] createUserGroups(string authkey, UserGroup[] user_groups)

Parameters

authkey

The user authentication key returned from login().

user_groups

The UserGroup objects to add.

Return Value

Returns an array of Exceptions or guids, corresponding to the error status, or the new guid of each item in the input array.

Description

This function adds multiple new UserGroup objects to the system.

Access Control

This function is restricted to users with the MP Administrator role only.

See Also

addPrivilegesToUserGroup, addPrivilegeToUserGroup, addUsersToUserGroup, addUserToUserGroup, createAgentModules, createAgentVersions, createApplications, createCredentials, createDataSets, createDeviceGroups, createDeviceProfiles, createGlobalResources, createJobs, createJobSteps, createJobStepsWithResourceRequirements, createProgramModules, createProgramModuleVersions, createPrograms, createProgramVersions, createResources, createSchedulingDescriptors, createServices, createUserGroup, createUsers, createWorkunits, deleteUserGroup, deleteUserGroups, getAllUserGroups, getCountUserGroupsByRole, getCountUsersByUserGroup, getPrivilegesByUserGroup, getSchedulingDescriptorUserGroupsByDeviceGroup, getUserGroup, getUserGroupByName, getUserGroupPrivilegesByObject, getUserGroups, getUserGroupsByGuid, getUserGroupsByObjectPrivilege, getUserGroupsByRole, getUserGroupsByUser, getUsersByUserGroup, removePrivilegeFromUserGroup, removePrivilegesFromUserGroup, removeUserFromUserGroup, removeUsersFromUserGroup, setUserGroupPrivileges, setUserGroupUsers, setUserUserGroups, updateUserGroup, updateUserGroups


createUsers

Create multiple new User objects.

Synopsis

ExceptionOrGuid[] createUsers(string authkey, User[] users)

Parameters

authkey

The user authentication key returned from login().

users

The User objects to add.

Return Value

Returns an array of Exceptions or guids, corresponding to the error status, or the new guid of each item in the input array.

Description

This function adds multiple new User objects to the system.

Access Control

This function is restricted to users with the MP Administrator role only.

See Also

addPrivilegesToUserGroup, addPrivilegeToUserGroup, addUserOrGroupsToObjectPrivilege, addUserOrGroupsToRole, addUserOrGroupToObjectPrivilege, addUserOrGroupToRole, addUsersToUserGroup, addUserToUserGroup, createAgentModules, createAgentVersions, createApplications, createCredentials, createDataSets, createDeviceGroups, createDeviceProfiles, createGlobalResources, createJobs, createJobSteps, createJobStepsWithResourceRequirements, createProgramModules, createProgramModuleVersions, createPrograms, createProgramVersions, createResources, createSchedulingDescriptors, createServices, createUser, createUserGroup, createUserGroups, createWorkunits, deleteUser, deleteUserGroup, deleteUserGroups, deleteUsers, getAllUserGroups, getAllUsers, getCountUserGroupsByRole, getCountUsersByRole, getCountUsersByUserGroup, getPrivilegesByUserGroup, getPrivilegesByUserOrGroupObject, getRolesByUserOrGroup, getSchedulingDescriptorUserGroupsByDeviceGroup, getSchedulingDescriptorUsersByDeviceGroup, getUser, getUserByName, getUserGroup, getUserGroupByName, getUserGroupPrivilegesByObject, getUserGroups, getUserGroupsByGuid, getUserGroupsByObjectPrivilege, getUserGroupsByRole, getUserGroupsByUser, getUserOrGroupPrivilegesByObject, getUserOrGroupsByObjectPrivilege, getUserOrGroupsByRole, getUserPrivilegesByObject, getUserProfile, getUsers, getUsersByGuid, getUsersByObjectPrivilege, getUsersByRole, getUsersByUserGroup, removePrivilegeFromUserGroup, removePrivilegesFromUserGroup, removeUserFromUserGroup, removeUserOrGroupFromObjectPrivilege, removeUserOrGroupFromRole, removeUserOrGroupsFromObjectPrivilege, removeUserOrGroupsFromRole, removeUsersFromUserGroup, setObjectPrivilegeUserAndGroups, setObjectUserOrGroupPrivileges, setRoleUserAndGroups, setUserGroupPrivileges, setUserGroupUsers, setUserOrGroupRoles, setUserUserGroups, updateUser, updateUserGroup, updateUserGroups, updateUserPassword, updateUserProfile, updateUsers


createWorkunit

Create a new Workunit object.

Synopsis

guid createWorkunit(string authkey, Workunit workunit)

Parameters

authkey

The user authentication key returned from login().

workunit

The Workunit object to add. The Workunit must have valid job_step_gid and state fields. The associated Data objects are determined from the data_set_gid and index fields of the DataId objects.

Return Value

The return value is the identifier of the new Workunit object. An exception is thrown if the function fails.

Description

This function adds a new Workunit object to the system. The identifier assigned to the object is the return value of the function.

Access Control

This function requires the calling user have Update Job privileges on the Job.

See Also

createWorkunits, createWorkunitsFromDataSetsAsync, deleteWorkunit, deleteWorkunits, getDatasByWorkunit, getDataSetsByJobStepWorkunits, getDevicesByWorkunit, getResultsByWorkunit, getWorkunit, getWorkunits, getWorkunitsByGuid, getWorkunitsByJobStep, getWorkunitStatesByJobStep, getWorkunitsWithDatasByGuid, updateWorkunitState, updateWorkunitStates


createWorkunits

Create multiple new Workunit objects.

Synopsis

ExceptionOrGuid[] createWorkunits(string authkey, Workunit[] workunits)

Parameters

authkey

The user authentication key returned from login().

workunits

The Workunit objects to add.

Return Value

Returns an array of Exceptions or guids, corresponding to the error status, or the new guid of each item in the input array.

Description

This function adds multiple new Workunit objects to the system (which need not belong to the same JobStep).

Access Control

This function requires the calling user have Update Job privileges on the Job.

See Also

createAgentModules, createAgentVersions, createApplications, createCredentials, createDataSets, createDeviceGroups, createDeviceProfiles, createGlobalResources, createJobs, createJobSteps, createJobStepsWithResourceRequirements, createProgramModules, createProgramModuleVersions, createPrograms, createProgramVersions, createResources, createSchedulingDescriptors, createServices, createUserGroups, createUsers, createWorkunit, createWorkunitsFromDataSetsAsync, deleteWorkunit, deleteWorkunits, getDatasByWorkunit, getDataSetsByJobStepWorkunits, getDevicesByWorkunit, getResultsByWorkunit, getWorkunit, getWorkunits, getWorkunitsByGuid, getWorkunitsByJobStep, getWorkunitStatesByJobStep, getWorkunitsWithDatasByGuid, updateWorkunitState, updateWorkunitStates


createWorkunitsFromDataSetsAsync

Create Workunits from DataSets for a JobStep.

Synopsis

void createWorkunitsFromDataSetsAsync(string authkey, guid job_step_gid, guid[] data_set_gids, CreateWorkunitsFromDataSetsOptions options)

Parameters

authkey

The user authentication key returned from login().

job_step_gid

The identifier of the JobStep against which the DataSets are added.

data_set_gids

The DataSets from which Workunits will be generated.

options

Options controlling how the cross product is generated. At this time, this is empty and is reserved for future expansion.

Return Value

The return value is undefined. An exception is thrown if the function fails.

Description

This function is used to create new Workunits for a JobStep. Workunits are generated from the cross product of all the DataSets listed in the parameter to this function. The Workunits are not all generated immediately, as this may take some time. The actual Workunit generation process is a background process started by calling this function. The completion status of this operation may be determined by checking the JobStep.wu_generate_done flag. This function may only be called once per JobStep. The JobStep may be set to state Closed after calling this function. Although new workunits may no longer be explicitly added with createWorkunit, this background operation will continue to create new workunits even while the JobStep is Closed.

Access Control

This function requires the calling user have Update Job privileges on the Job.

See Also

getDataSetsByJobStepWorkunits


deleteAgentModule

Delete a AgentModule object.

Synopsis

void deleteAgentModule(string authkey, guid agent_module_gid)

Parameters

authkey

The user authentication key returned from login().

agent_module_gid

The primary unique identifier of the AgentModule object to delete.

Return Value

The return value is undefined. An exception is thrown if the function fails.

Description

This function deletes a AgentModule object from the system.

Access Control

This function is restricted to users with the MP Administrator role only.

See Also

createAgentModule, createAgentModules, deleteAgentModules, getAgentModule, getAgentModuleByAgentVersionPlatform, getAgentModules, getAgentModulesByGuid, getAllAgentModules


deleteAgentModules

Delete multiple AgentModule objects.

Synopsis

Exception[] deleteAgentModules(string authkey, guid[] agent_module_gids)

Parameters

authkey

The user authentication key returned from login().

agent_module_gids

The unique ids of the AgentModule objects to delete.

Return Value

Returns an array of Exceptions, corresponding to the status of each item in the input array.

Description

This function deletes multiple AgentModule objects from the system.

Access Control

This function is restricted to users with the MP Administrator role only.

See Also

createAgentModule, createAgentModules, deleteAgentModule, getAgentModule, getAgentModuleByAgentVersionPlatform, getAgentModules, getAgentModulesByGuid, getAllAgentModules


deleteAgentVersion

Delete a AgentVersion object.

Synopsis

void deleteAgentVersion(string authkey, guid agent_version_gid)

Parameters

authkey

The user authentication key returned from login().

agent_version_gid

The primary unique identifier of the AgentVersion object to delete.

Return Value

The return value is undefined. An exception is thrown if the function fails.

Description

This function deletes an AgentVersion object from the system. It will delete any AgentModule objects that refer to the AgentVersion. It will fail if any DeviceGroup objects are referencing the AgentVersion.

Access Control

This function is restricted to users with the MP Administrator role only.

See Also

createAgentVersion, createAgentVersions, deleteAgentVersions, getAgentModuleByAgentVersionPlatform, getAgentVersion, getAgentVersionByName, getAgentVersions, getAgentVersionsByGuid, getAllAgentVersions, getCountDeviceGroupsByAgentVersion


deleteAgentVersions

Delete multiple AgentVersion objects.

Synopsis

Exception[] deleteAgentVersions(string authkey, guid[] agent_version_gids)

Parameters

authkey

The user authentication key returned from login().

agent_version_gids

The unique ids of the AgentVersion objects to delete.

Return Value

Returns an array of Exceptions, corresponding to the status of each item in the input array.

Description

This function deletes multiple AgentVersion objects from the system. It will delete any AgentModule objects that refer to the AgentVersion. It will fail if any DeviceGroup objects are referencing the AgentVersion.

Access Control

This function is restricted to users with the MP Administrator role only.

See Also

createAgentVersion, createAgentVersions, deleteAgentVersion, getAgentModuleByAgentVersionPlatform, getAgentVersion, getAgentVersionByName, getAgentVersions, getAgentVersionsByGuid, getAllAgentVersions, getCountDeviceGroupsByAgentVersion


deleteApplication

Delete a Application object.

Synopsis

void deleteApplication(string authkey, guid application_gid)

Parameters

authkey

The user authentication key returned from login().

application_gid

The primary unique identifier of the Application object to delete.

Return Value

The return value is undefined. An exception is thrown if the function fails.

Description

This function deletes an Application object from the system. Unlike setting an Application to the Pending Delete state, this takes effect immediately. If there are any Job objects that refer to the Application, this function will fail.

Access Control

This function requires the calling user have Delete Application privileges on the Application.

See Also

addApplicationsToDeviceProfile, addApplicationToDeviceProfile, addProgramsToApplication, addProgramToApplication, createApplication, createApplications, deleteApplications, getAllApplications, getApplication, getApplicationByName, getApplications, getApplicationsByDeviceProfile, getApplicationsByGuid, getApplicationsByProgram, getJobsByApplication, getProgramsByApplication, removeApplicationFromDeviceProfile, removeApplicationsFromDeviceProfile, removeProgramFromApplication, removeProgramsFromApplication, setApplicationPrograms, setDeviceProfileApplications, updateApplication, updateApplications


deleteApplications

Delete multiple Application objects.

Synopsis

Exception[] deleteApplications(string authkey, guid[] application_gids)

Parameters

authkey

The user authentication key returned from login().

application_gids

The unique ids of the Application objects to delete.

Return Value

Returns an array of Exceptions, corresponding to the status of each item in the input array.

Description

This function deletes multiple Application objects from the system. Unlike setting an application to a Pending Delete state, this takes effect immediately. If there are any Job objects that refer to the Application, an Exception will be returned for that Application.

Access Control

This function requires the calling user have Delete Application privileges on the Application.

See Also

addApplicationsToDeviceProfile, addApplicationToDeviceProfile, addProgramsToApplication, addProgramToApplication, createApplication, createApplications, deleteApplication, getAllApplications, getApplication, getApplicationByName, getApplications, getApplicationsByDeviceProfile, getApplicationsByGuid, getApplicationsByProgram, getJobsByApplication, getProgramsByApplication, removeApplicationFromDeviceProfile, removeApplicationsFromDeviceProfile, removeProgramFromApplication, removeProgramsFromApplication, setApplicationPrograms, setDeviceProfileApplications, updateApplication, updateApplications


deleteCredential

Delete a Credential object.

Synopsis

void deleteCredential(string authkey, guid credential_gid)

Parameters

authkey

The user authentication key returned from login().

credential_gid

The primary unique identifier of the Credential object to delete.

Return Value

The return value is undefined. An exception is thrown if the function fails.

Description

This function deletes an Credential object from the system. Unlike setting an Credential to the Pending Delete state, this takes effect immediately. If there are any Job objects that refer to the Credential, this function will fail.

Access Control

This function requires the calling user have Update Device Group privileges on the DeviceGroup.

See Also

createCredential, createCredentials, deleteCredentials, getAllCredentials, getCredential, getCredentials, updateCredential, updateCredentials


deleteCredentials

Delete multiple Credential objects.

Synopsis

Exception[] deleteCredentials(string authkey, guid[] credential_gids)

Parameters

authkey

The user authentication key returned from login().

credential_gids

The unique ids of the Credential objects to delete.

Return Value

Returns an array of Exceptions, corresponding to the status of each item in the input array.

Description

This function deletes multiple Credential objects from the system. Unlike setting an credential to a Pending Delete state, this takes effect immediately. If there are any Job objects that refer to the Credential, an Exception will be returned for that Credential.

Access Control

This function requires the calling user have Update Device Group privileges on the DeviceGroup.

See Also

createCredential, createCredentials, deleteCredential, getAllCredentials, getCredential, getCredentials, updateCredential, updateCredentials


deleteData

Delete a Data object.

Synopsis

void deleteData(string authkey, DataId data_id)

Parameters

authkey

The user authentication key returned from login().

data_id

The primary unique identifier of the Data object to delete.

Return Value

The return value is undefined. An exception is thrown if the function fails.

Description

This function deletes a Data object from the system. It will fail if any Workunits refer to the Data.

Access Control

This function requires the calling user have Update Data privileges on the DataSet.

See Also

createData, createDatas, createDataSet, createDataSets, createWorkunitsFromDataSetsAsync, deleteDatas, deleteDataSet, deleteDataSets, getAllDataSets, getData, getDatas, getDatasByDataSet, getDatasById, getDatasByWorkunit, getDataSet, getDataSetByName, getDataSets, getDataSetsByGuid, getDataSetsByJobStepWorkunits, getWorkunitsWithDatasByGuid, updateDataSet, updateDataSets


deleteDatas

Delete multiple Data objects.

Synopsis

Exception[] deleteDatas(string authkey, DataId[] data_ids)

Parameters

authkey

The user authentication key returned from login().

data_ids

The primary unique identifier of the DataSet containing the Data objects to delete.

Return Value

Returns an array of Exceptions, corresponding to the status of each item in the input array.

Description

This function deletes multiple Data objects from the system. It will fail if any Workunits refer to the Datas.

Access Control

This function requires the calling user have Update Data privileges on the DataSet.

See Also

createData, createDatas, createDataSet, createDataSets, createWorkunitsFromDataSetsAsync, deleteData, deleteDataSet, deleteDataSets, getAllDataSets, getData, getDatas, getDatasByDataSet, getDatasById, getDatasByWorkunit, getDataSet, getDataSetByName, getDataSets, getDataSetsByGuid, getDataSetsByJobStepWorkunits, getWorkunitsWithDatasByGuid, updateDataSet, updateDataSets


deleteDataSet

Delete a DataSet object.

Synopsis

void deleteDataSet(string authkey, guid data_set_gid)

Parameters

authkey

The user authentication key returned from login().

data_set_gid

The primary unique identifier of the DataSet object to delete.

Return Value

The return value is undefined. An exception is thrown if the function fails.

Description

This function deletes a DataSet object from the system. It will delete any Datas that belong to the DataSet. If there are any Workunit objects that refer to Datas in the DataSet, this function will fail. See also deleteData.

Access Control

This function requires the calling user have Delete Data privileges on the DataSet.

See Also

createDataSet, createDataSets, createWorkunitsFromDataSetsAsync, deleteDataSets, getAllDataSets, getDatasByDataSet, getDataSet, getDataSetByName, getDataSets, getDataSetsByGuid, getDataSetsByJobStepWorkunits, updateDataSet, updateDataSets


deleteDataSets

Delete multiple DataSet objects.

Synopsis

Exception[] deleteDataSets(string authkey, guid[] data_set_gids)

Parameters

authkey

The user authentication key returned from login().

data_set_gids

The unique ids of the DataSet objects to delete.

Return Value

Returns an array of Exceptions, corresponding to the status of each item in the input array.

Description

This function deletes multiple DataSet objects from the system. It will delete any Datas that belong to the DataSets. See also deleteData.

Access Control

This function requires the calling user have Delete Data privileges on the DataSet.

See Also

createDataSet, createDataSets, createWorkunitsFromDataSetsAsync, deleteDataSet, getAllDataSets, getDatasByDataSet, getDataSet, getDataSetByName, getDataSets, getDataSetsByGuid, getDataSetsByJobStepWorkunits, updateDataSet, updateDataSets


deleteDevice

Delete a Device object.

Synopsis

void deleteDevice(string authkey, guid device_gid)

Parameters

authkey

The user authentication key returned from login().

device_gid

The primary unique identifier of the Device object to delete.

Return Value

The return value is undefined. An exception is thrown if the function fails.

Description

This function deletes a Device object from the system. It will delete any DeviceCommands that belong to this Device. If there are any existing Results submitted by this device, their device_gid member(s) will be set to the null guid after this function completes.

Access Control

This function requires the calling user have Update Device Group privileges on the DeviceGroup.

See Also

addApplicationsToDeviceProfile, addApplicationToDeviceProfile, addDeviceGroupsToJob, addDeviceGroupToJob, addProgramsToDeviceProfile, addProgramToDeviceProfile, cancelDeviceCommands, createDeviceGroup, createDeviceGroups, createDeviceProfile, createDeviceProfiles, deleteDeviceGroup, deleteDeviceGroups, deleteDeviceProfile, deleteDeviceProfiles, deleteDevices, getAllDeviceGroups, getAllDeviceProfiles, getAllDevices, getApplicationsByDeviceProfile, getCountDeviceGroupsByAgentVersion, getCountDevicesByDeviceGroup, getCountDevicesByDeviceProfile, getDevice, getDeviceCommands, getDeviceGroup, getDeviceGroupByName, getDeviceGroups, getDeviceGroupsByGuid, getDeviceGroupsByJob, getDeviceProfile, getDeviceProfiles, getDeviceProfilesByDeviceGroup, getDeviceProfilesByGuid, getDevices, getDevicesByDeviceGroup, getDevicesByDeviceProfile, getDevicesByGuid, getDevicesByWorkunit, getJobsByDeviceGroup, getProgramsByDeviceProfile, getResourceAvailablesByDevice, getSchedulingDescriptorsByDeviceGroup, getSchedulingDescriptorUserGroupsByDeviceGroup, getSchedulingDescriptorUsersByDeviceGroup, getStatsAllDeviceGroups, getStatsDevice, getStatsDeviceGroup, getStatsDevicesByDeviceGroup, getStatsJobDevices, moveDevices, removeApplicationFromDeviceProfile, removeApplicationsFromDeviceProfile, removeDeviceGroupFromJob, removeDeviceGroupsFromJob, removeProgramFromDeviceProfile, removeProgramsFromDeviceProfile, sendDeviceCommand, setDeviceProfileApplications, setDeviceProfilePrograms, setJobDeviceGroups, updateDevice, updateDeviceGroup, updateDeviceGroupRestricted, updateDeviceGroups, updateDeviceProfile, updateDeviceProfiles


deleteDeviceGroup

Delete a DeviceGroup object.

Synopsis

void deleteDeviceGroup(string authkey, guid device_group_gid)

Parameters

authkey

The user authentication key returned from login().

device_group_gid

The primary unique identifier of the DeviceGroup object to delete.

Return Value

The return value is undefined. An exception is thrown if the function fails.

Description

This function deletes a DeviceGroup object from the system. It will delete any DeviceProfiles that belong to the DeviceGroup. It will delete any Credential objects that refer to the DeviceGroup. It will fail if any Devices refer to the DeviceGroup.

Access Control

This function requires the calling user have Delete Device Group privileges on the DeviceGroup.

See Also

addDeviceGroupsToJob, addDeviceGroupToJob, createDeviceGroup, createDeviceGroups, deleteDeviceGroups, getAllDeviceGroups, getCountDeviceGroupsByAgentVersion, getCountDevicesByDeviceGroup, getDeviceGroup, getDeviceGroupByName, getDeviceGroups, getDeviceGroupsByGuid, getDeviceGroupsByJob, getDeviceProfilesByDeviceGroup, getDevicesByDeviceGroup, getJobsByDeviceGroup, getSchedulingDescriptorsByDeviceGroup, getSchedulingDescriptorUserGroupsByDeviceGroup, getSchedulingDescriptorUsersByDeviceGroup, getStatsAllDeviceGroups, getStatsDeviceGroup, getStatsDevicesByDeviceGroup, removeDeviceGroupFromJob, removeDeviceGroupsFromJob, setJobDeviceGroups, updateDeviceGroup, updateDeviceGroupRestricted, updateDeviceGroups


deleteDeviceGroups

Delete multiple DeviceGroup objects.

Synopsis

Exception[] deleteDeviceGroups(string authkey, guid[] device_group_gids)

Parameters

authkey

The user authentication key returned from login().

device_group_gids

The unique ids of the DeviceGroup objects to delete.

Return Value

Returns an array of Exceptions, corresponding to the status of each item in the input array.

Description

This function deletes multiple DeviceGroup objects from the system. It will delete any DeviceProfiles that belong to the DeviceGroup. It will delete any Credential objects that refer to the DeviceGroups. It will fail if any Devices refer to the DeviceGroup.

Access Control

This function requires the calling user have Delete Device Group privileges on the DeviceGroup.

See Also

addDeviceGroupsToJob, addDeviceGroupToJob, createDeviceGroup, createDeviceGroups, deleteDeviceGroup, getAllDeviceGroups, getCountDeviceGroupsByAgentVersion, getCountDevicesByDeviceGroup, getDeviceGroup, getDeviceGroupByName, getDeviceGroups, getDeviceGroupsByGuid, getDeviceGroupsByJob, getDeviceProfilesByDeviceGroup, getDevicesByDeviceGroup, getJobsByDeviceGroup, getSchedulingDescriptorsByDeviceGroup, getSchedulingDescriptorUserGroupsByDeviceGroup, getSchedulingDescriptorUsersByDeviceGroup, getStatsAllDeviceGroups, getStatsDeviceGroup, getStatsDevicesByDeviceGroup, removeDeviceGroupFromJob, removeDeviceGroupsFromJob, setJobDeviceGroups, updateDeviceGroup, updateDeviceGroupRestricted, updateDeviceGroups


deleteDeviceProfile

Delete a DeviceProfile object.

Synopsis

void deleteDeviceProfile(string authkey, guid device_profile_gid)

Parameters

authkey

The user authentication key returned from login().

device_profile_gid

The primary unique identifier of the DeviceProfile object to delete.

Return Value

The return value is undefined. An exception is thrown if the function fails.

Description

This function deletes a DeviceProfile object from the system. It will fail if any Devices refer to the DeviceProfile.

Access Control

This function requires the calling user have Update Device Group privileges on the DeviceGroup.

See Also

addApplicationsToDeviceProfile, addApplicationToDeviceProfile, addProgramsToDeviceProfile, addProgramToDeviceProfile, createDeviceProfile, createDeviceProfiles, deleteDeviceProfiles, getAllDeviceProfiles, getApplicationsByDeviceProfile, getCountDevicesByDeviceProfile, getDeviceProfile, getDeviceProfiles, getDeviceProfilesByDeviceGroup, getDeviceProfilesByGuid, getDevicesByDeviceProfile, getProgramsByDeviceProfile, removeApplicationFromDeviceProfile, removeApplicationsFromDeviceProfile, removeProgramFromDeviceProfile, removeProgramsFromDeviceProfile, setDeviceProfileApplications, setDeviceProfilePrograms, updateDeviceProfile, updateDeviceProfiles


deleteDeviceProfiles

Delete multiple DeviceProfile objects.

Synopsis

Exception[] deleteDeviceProfiles(string authkey, guid[] device_profile_gids)

Parameters

authkey

The user authentication key returned from login().

device_profile_gids

The unique ids of the DeviceProfile objects to delete.

Return Value

Returns an array of Exceptions, corresponding to the status of each item in the input array.

Description

This function deletes multiple DeviceProfile objects from the system. It will fail if any Devices refer to the DeviceProfiles.

Access Control

This function requires the calling user have Update Device Group privileges on the DeviceGroup.

See Also

addApplicationsToDeviceProfile, addApplicationToDeviceProfile, addProgramsToDeviceProfile, addProgramToDeviceProfile, createDeviceProfile, createDeviceProfiles, deleteDeviceProfile, getAllDeviceProfiles, getApplicationsByDeviceProfile, getCountDevicesByDeviceProfile, getDeviceProfile, getDeviceProfiles, getDeviceProfilesByDeviceGroup, getDeviceProfilesByGuid, getDevicesByDeviceProfile, getProgramsByDeviceProfile, removeApplicationFromDeviceProfile, removeApplicationsFromDeviceProfile, removeProgramFromDeviceProfile, removeProgramsFromDeviceProfile, setDeviceProfileApplications, setDeviceProfilePrograms, updateDeviceProfile, updateDeviceProfiles


deleteDevices

Delete multiple Device objects.

Synopsis

Exception[] deleteDevices(string authkey, guid[] device_gids)

Parameters

authkey

The user authentication key returned from login().

device_gids

The unique ids of the Device objects to delete.

Return Value

Returns an array of Exceptions, corresponding to the status of each item in the input array.

Description

This function deletes multiple Device objects from the system. It will delete any DeviceCommands that belong to these Devices. If there are any existing Results submitted by these devices, their device_gid member(s) will be set to the null guid after this function completes.

Access Control

This function requires the calling user have Update Device Group privileges on the DeviceGroup.

See Also

addApplicationsToDeviceProfile, addApplicationToDeviceProfile, addDeviceGroupsToJob, addDeviceGroupToJob, addProgramsToDeviceProfile, addProgramToDeviceProfile, cancelDeviceCommands, createDeviceGroup, createDeviceGroups, createDeviceProfile, createDeviceProfiles, deleteDevice, deleteDeviceGroup, deleteDeviceGroups, deleteDeviceProfile, deleteDeviceProfiles, getAllDeviceGroups, getAllDeviceProfiles, getAllDevices, getApplicationsByDeviceProfile, getCountDeviceGroupsByAgentVersion, getCountDevicesByDeviceGroup, getCountDevicesByDeviceProfile, getDevice, getDeviceCommands, getDeviceGroup, getDeviceGroupByName, getDeviceGroups, getDeviceGroupsByGuid, getDeviceGroupsByJob, getDeviceProfile, getDeviceProfiles, getDeviceProfilesByDeviceGroup, getDeviceProfilesByGuid, getDevices, getDevicesByDeviceGroup, getDevicesByDeviceProfile, getDevicesByGuid, getDevicesByWorkunit, getJobsByDeviceGroup, getProgramsByDeviceProfile, getResourceAvailablesByDevice, getSchedulingDescriptorsByDeviceGroup, getSchedulingDescriptorUserGroupsByDeviceGroup, getSchedulingDescriptorUsersByDeviceGroup, getStatsAllDeviceGroups, getStatsDevice, getStatsDeviceGroup, getStatsDevicesByDeviceGroup, getStatsJobDevices, moveDevices, removeApplicationFromDeviceProfile, removeApplicationsFromDeviceProfile, removeDeviceGroupFromJob, removeDeviceGroupsFromJob, removeProgramFromDeviceProfile, removeProgramsFromDeviceProfile, sendDeviceCommand, setDeviceProfileApplications, setDeviceProfilePrograms, setJobDeviceGroups, updateDevice, updateDeviceGroup, updateDeviceGroupRestricted, updateDeviceGroups, updateDeviceProfile, updateDeviceProfiles


deleteErrors

Delete Error objects older than a specified time.

Synopsis

void deleteErrors(string authkey, dateTime purge_time)

Parameters

authkey

The user authentication key returned from login().

purge_time

The cutoff time for which earlier Error objects will be deleted.

Return Value

The return value is undefined. An exception is thrown if the function fails.

Access Control

This function is restricted to users with the MP Administrator role only.

See Also

getErrors


deleteGlobalResource

Delete a GlobalResource object.

Synopsis

void deleteGlobalResource(string authkey, guid global_resource_gid)

Parameters

authkey

The user authentication key returned from login().

global_resource_gid

The unique identifier of the GlobalResource object to delete.

Return Value

The return value is undefined. An exception is thrown if the function fails.

Access Control

This function requires the calling user have Delete Resource privileges on the GlobalResource.

See Also

createGlobalResource, createGlobalResources, deleteGlobalResourceRequirement, deleteGlobalResources, getAllGlobalResourceRequirements, getAllGlobalResources, getGlobalResource, getGlobalResourceByName, getGlobalResourceRequirementsByGlobalResource, getGlobalResourceRequirementsByProgramModule, getGlobalResources, setGlobalResourceRequirement, setGlobalResourceRequirements, updateGlobalResource, updateGlobalResources


deleteGlobalResourceRequirement

Delete a GlobalResourceRequirement object.

Synopsis

void deleteGlobalResourceRequirement(string authkey, guid program_module_gid, guid global_resource_gid)

Parameters

authkey

The user authentication key returned from login().

program_module_gid

The unique identifier of the ProgramModule that is associated with the GlobalResourceRequirement.

global_resource_gid

The unique identifier of the GlobalResource that is associated with the GlobalResourceRequirement.

Return Value

The return value is undefined. An exception is thrown if the function fails.

Access Control

This function requires the calling user have Update Program privileges on the Program.

See Also

getAllGlobalResourceRequirements, getGlobalResourceRequirementsByGlobalResource, getGlobalResourceRequirementsByProgramModule, setGlobalResourceRequirement, setGlobalResourceRequirements


deleteGlobalResources

Delete multiple GlobalResource objects.

Synopsis

Exception[] deleteGlobalResources(string authkey, guid[] global_resource_gid)

Parameters

authkey

The user authentication key returned from login().

global_resource_gid

The unique identifiers of the GlobalResource objects to delete.

Return Value

Returns an array of Exceptions, corresponding to the status of each item in the input array.

Access Control

This function requires the calling user have Delete Resource privileges on the GlobalResource.

See Also

createGlobalResource, createGlobalResources, deleteGlobalResource, deleteGlobalResourceRequirement, getAllGlobalResourceRequirements, getAllGlobalResources, getGlobalResource, getGlobalResourceByName, getGlobalResourceRequirementsByGlobalResource, getGlobalResourceRequirementsByProgramModule, getGlobalResources, setGlobalResourceRequirement, setGlobalResourceRequirements, updateGlobalResource, updateGlobalResources


deleteJob

Delete a Job object.

Synopsis

void deleteJob(string authkey, guid job_gid)

Parameters

authkey

The user authentication key returned from login().

job_gid

The primary unique identifier of the Job object to delete.

Return Value

The return value is undefined. An exception is thrown if the function fails.

Description

This function deletes a Job object from the system. It will delete any DataSets or JobSteps that belong to the Job. See also deleteDataSet, deleteJobStep.

Access Control

This function requires the calling user have Delete Job privileges on the Job.

See Also

addDeviceGroupsToJob, addDeviceGroupToJob, createJob, createJob2, createJobs, createJobStep, createJobSteps, createJobStepsWithResourceRequirements, createJobStepWithResourceRequirements, deleteJobs, deleteJobStep, deleteJobSteps, getAllJobs, getDataSetsByJobStepWorkunits, getDeviceGroupsByJob, getJob, getJobById, getJobs, getJobsByApplication, getJobsByDeviceGroup, getJobsByGuid, getJobStatus, getJobStatusesByGuid, getJobStep, getJobSteps, getJobStepsByGuid, getJobStepsByJob, getJobStepsByProgram, getJobStepStatus, getProgramModuleVersionsByJobStep, getResourceRequirementsByJobStep, getResultsByJobStep, getStatsAllJobStates, getStatsJobDevices, getWorkunitsByJobStep, getWorkunitStatesByJobStep, removeDeviceGroupFromJob, removeDeviceGroupsFromJob, setJobDeviceGroups, updateJob, updateJobs, updateJobStep, updateJobSteps


deleteJobs

Delete multiple Job objects.

Synopsis

Exception[] deleteJobs(string authkey, guid[] job_gids)

Parameters

authkey

The user authentication key returned from login().

job_gids

The unique ids of the Job objects to delete.

Return Value

Returns an array of Exceptions, corresponding to the status of each item in the input array.

Description

This function deletes multiple Job objects from the system. It will delete any DataSets or JobSteps that belong to the Job. See also deleteDataSet, deleteJobStep.

Access Control

This function requires the calling user have Delete Job privileges on the Job.

See Also

addDeviceGroupsToJob, addDeviceGroupToJob, createJob, createJob2, createJobs, createJobStep, createJobSteps, createJobStepsWithResourceRequirements, createJobStepWithResourceRequirements, deleteJob, deleteJobStep, deleteJobSteps, getAllJobs, getDataSetsByJobStepWorkunits, getDeviceGroupsByJob, getJob, getJobById, getJobs, getJobsByApplication, getJobsByDeviceGroup, getJobsByGuid, getJobStatus, getJobStatusesByGuid, getJobStep, getJobSteps, getJobStepsByGuid, getJobStepsByJob, getJobStepsByProgram, getJobStepStatus, getProgramModuleVersionsByJobStep, getResourceRequirementsByJobStep, getResultsByJobStep, getStatsAllJobStates, getStatsJobDevices, getWorkunitsByJobStep, getWorkunitStatesByJobStep, removeDeviceGroupFromJob, removeDeviceGroupsFromJob, setJobDeviceGroups, updateJob, updateJobs, updateJobStep, updateJobSteps


deleteJobStep

Delete a JobStep object.

Synopsis

void deleteJobStep(string authkey, guid job_step_gid)

Parameters

authkey

The user authentication key returned from login().

job_step_gid

The primary unique identifier of the JobStep object to delete.

Return Value

The return value is undefined. An exception is thrown if the function fails.

Description

This function deletes a JobStep object from the system. It will delete any DataSets, Result queues, or Workunits that belong to the JobStep. See also deleteDataSet, deleteResultQueue, deleteWorkunit.

Access Control

This function requires the calling user have Update Job privileges on the Job.

See Also

createJobStep, createJobSteps, createJobStepsWithResourceRequirements, createJobStepWithResourceRequirements, deleteJobSteps, getDataSetsByJobStepWorkunits, getJobStep, getJobSteps, getJobStepsByGuid, getJobStepsByJob, getJobStepsByProgram, getJobStepStatus, getProgramModuleVersionsByJobStep, getResourceRequirementsByJobStep, getResultsByJobStep, getWorkunitsByJobStep, getWorkunitStatesByJobStep, updateJobStep, updateJobSteps


deleteJobSteps

Delete multiple JobStep objects.

Synopsis

Exception[] deleteJobSteps(string authkey, guid[] job_step_gids)

Parameters

authkey

The user authentication key returned from login().

job_step_gids

The unique ids of the JobStep objects to delete.

Return Value

Returns an array of Exceptions, corresponding to the status of each item in the input array.

Description

This function deletes multiple JobStep objects from the system. It will delete any DataSets, Result queues, or Workunits that belong to the JobSteps. See also deleteDataSet, deleteResultQueue, deleteWorkunit.

Access Control

This function requires the calling user have Update Job privileges on the Job.

See Also

createJobStep, createJobSteps, createJobStepsWithResourceRequirements, createJobStepWithResourceRequirements, deleteJobStep, getDataSetsByJobStepWorkunits, getJobStep, getJobSteps, getJobStepsByGuid, getJobStepsByJob, getJobStepsByProgram, getJobStepStatus, getProgramModuleVersionsByJobStep, getResourceRequirementsByJobStep, getResultsByJobStep, getWorkunitsByJobStep, getWorkunitStatesByJobStep, updateJobStep, updateJobSteps


deleteProgram

Delete a Program object.

Synopsis

void deleteProgram(string authkey, guid program_gid)

Parameters

authkey

The user authentication key returned from login().

program_gid

The primary unique identifier of the Program object to delete.

Return Value

The return value is undefined. An exception is thrown if the function fails.

Description

This function deletes a Program object from the system. Unlike setting a Program to the Pending Delete state, this takes effect immediately. It will delete any ProgramVersions that belong to the Program. If there are any JobStep objects that refer to the Program, this function will fail. See also deleteJobStep, deleteProgramVersion.

Access Control

This function requires the calling user have Delete Program privileges on the Program.

See Also

addProgramsToApplication, addProgramsToDeviceProfile, addProgramToApplication, addProgramToDeviceProfile, createProgram, createProgramModule, createProgramModules, createProgramModuleVersion, createProgramModuleVersions, createPrograms, createProgramVersion, createProgramVersions, deleteProgramModule, deleteProgramModules, deleteProgramModuleVersion, deleteProgramModuleVersions, deletePrograms, deleteProgramVersion, deleteProgramVersions, getAllPrograms, getApplicationsByProgram, getGlobalResourceRequirementsByProgramModule, getJobStepsByProgram, getProgram, getProgramByName, getProgramModule, getProgramModules, getProgramModulesByGuid, getProgramModulesByProgram, getProgramModulesByProgramVersion, getProgramModuleVersion, getProgramModuleVersions, getProgramModuleVersionsByGuid, getProgramModuleVersionsByJobStep, getProgramModuleVersionsByProgramModule, getPrograms, getProgramsByApplication, getProgramsByDeviceProfile, getProgramsByGuid, getProgramVersion, getProgramVersions, getProgramVersionsByGuid, getProgramVersionsByProgram, getResourceRequirementsByProgramModule, removeProgramFromApplication, removeProgramFromDeviceProfile, removeProgramsFromApplication, removeProgramsFromDeviceProfile, setApplicationPrograms, setDeviceProfilePrograms, updateProgram, updateProgramModule, updateProgramModules, updatePrograms, updateProgramVersion, updateProgramVersions


deleteProgramModule

Delete a ProgramModule object.

Synopsis

void deleteProgramModule(string authkey, guid program_module_gid)

Parameters

authkey

The user authentication key returned from login().

program_module_gid

The primary unique identifier of the ProgramModule object to delete.

Return Value

The return value is undefined. An exception is thrown if the function fails.

Description

This function deletes a ProgramModule object from the system. It will delete any ProgramModuleVersions that belong to the ProgramModule. It will delete any ResourceRequirements that belong to the ProgramModule. See also deleteProgramModuleVersion.

Access Control

This function requires the calling user have Update Program privileges on the Program.

See Also

createProgramModule, createProgramModules, createProgramModuleVersion, createProgramModuleVersions, deleteProgramModules, deleteProgramModuleVersion, deleteProgramModuleVersions, getGlobalResourceRequirementsByProgramModule, getProgramModule, getProgramModules, getProgramModulesByGuid, getProgramModulesByProgram, getProgramModulesByProgramVersion, getProgramModuleVersion, getProgramModuleVersions, getProgramModuleVersionsByGuid, getProgramModuleVersionsByJobStep, getProgramModuleVersionsByProgramModule, getResourceRequirementsByProgramModule, updateProgramModule, updateProgramModules


deleteProgramModules

Delete multiple ProgramModule objects.

Synopsis

Exception[] deleteProgramModules(string authkey, guid[] program_module_gids)

Parameters

authkey

The user authentication key returned from login().

program_module_gids

The unique ids of the ProgramModule objects to delete.

Return Value

Returns an array of Exceptions, corresponding to the status of each item in the input array.

Description

This function deletes multiple ProgramModule objects from the system. It will delete any ProgramModuleVersions that belong to the ProgramModules. It will delete any ResourceRequirements that belong to the ProgramModules. See also deleteProgramModuleVersion.

Access Control

This function requires the calling user have Update Program privileges on the Program.

See Also

createProgramModule, createProgramModules, createProgramModuleVersion, createProgramModuleVersions, deleteProgramModule, deleteProgramModuleVersion, deleteProgramModuleVersions, getGlobalResourceRequirementsByProgramModule, getProgramModule, getProgramModules, getProgramModulesByGuid, getProgramModulesByProgram, getProgramModulesByProgramVersion, getProgramModuleVersion, getProgramModuleVersions, getProgramModuleVersionsByGuid, getProgramModuleVersionsByJobStep, getProgramModuleVersionsByProgramModule, getResourceRequirementsByProgramModule, updateProgramModule, updateProgramModules


deleteProgramModuleVersion

Delete a ProgramModuleVersion object.

Synopsis

void deleteProgramModuleVersion(string authkey, guid program_module_version_gid)

Parameters

authkey

The user authentication key returned from login().

program_module_version_gid

The primary unique identifier of the ProgramModuleVersion object to delete.

Return Value

The return value is undefined. An exception is thrown if the function fails.

Description

This function deletes a ProgramModuleVersion object from the system. This ProgramModuleVersion cannot be deleted if it is set to the current_version_gid of some ProgramModule. Either set the current version to the null guid or another ProgramModuleVersion. It also can not be deleted if any JobSteps exist that reference the ProgramModuleVersion.

Access Control

This function requires the calling user have Update Program privileges on the Program.

See Also

createProgramModuleVersion, createProgramModuleVersions, deleteProgramModuleVersions, getProgramModuleVersion, getProgramModuleVersions, getProgramModuleVersionsByGuid, getProgramModuleVersionsByJobStep, getProgramModuleVersionsByProgramModule


deleteProgramModuleVersions

Delete multiple ProgramModuleVersion objects.

Synopsis

Exception[] deleteProgramModuleVersions(string authkey, guid[] program_module_version_gids)

Parameters

authkey

The user authentication key returned from login().

program_module_version_gids

The unique ids of the ProgramModuleVersion objects to delete.

Return Value

Returns an array of Exceptions, corresponding to the status of each item in the input array.

Description

This function deletes multiple ProgramModuleVersion objects from the system. The ProgramModuleVersions cannot be deleted if they are set to the current_version_gid of some ProgramModule. Either set the current version to the null guid or another ProgramModuleVersion. It also can not be deleted if any JobSteps exist that reference the ProgramModuleVersion.

Access Control

This function requires the calling user have Update Program privileges on the Program.

See Also

createProgramModuleVersion, createProgramModuleVersions, deleteProgramModuleVersion, getProgramModuleVersion, getProgramModuleVersions, getProgramModuleVersionsByGuid, getProgramModuleVersionsByJobStep, getProgramModuleVersionsByProgramModule


deletePrograms

Delete multiple Program objects.

Synopsis

Exception[] deletePrograms(string authkey, guid[] program_gids)

Parameters

authkey

The user authentication key returned from login().

program_gids

The unique ids of the Program objects to delete.

Return Value

Returns an array of Exceptions, corresponding to the status of each item in the input array.

Description

This function deletes multiple Program objects from the system. Unlike setting Programs to the Pending Delete state, this takes effect immediately. It will delete any JobStep objects that refer to the Programs and any ProgramVersions that belong to the Programs. See also deleteJobStep, deleteProgramVersion.

Access Control

This function requires the calling user have Delete Program privileges on the Program.

See Also

addProgramsToApplication, addProgramsToDeviceProfile, addProgramToApplication, addProgramToDeviceProfile, createProgram, createProgramModule, createProgramModules, createProgramModuleVersion, createProgramModuleVersions, createPrograms, createProgramVersion, createProgramVersions, deleteProgram, deleteProgramModule, deleteProgramModules, deleteProgramModuleVersion, deleteProgramModuleVersions, deleteProgramVersion, deleteProgramVersions, getAllPrograms, getApplicationsByProgram, getGlobalResourceRequirementsByProgramModule, getJobStepsByProgram, getProgram, getProgramByName, getProgramModule, getProgramModules, getProgramModulesByGuid, getProgramModulesByProgram, getProgramModulesByProgramVersion, getProgramModuleVersion, getProgramModuleVersions, getProgramModuleVersionsByGuid, getProgramModuleVersionsByJobStep, getProgramModuleVersionsByProgramModule, getPrograms, getProgramsByApplication, getProgramsByDeviceProfile, getProgramsByGuid, getProgramVersion, getProgramVersions, getProgramVersionsByGuid, getProgramVersionsByProgram, getResourceRequirementsByProgramModule, removeProgramFromApplication, removeProgramFromDeviceProfile, removeProgramsFromApplication, removeProgramsFromDeviceProfile, setApplicationPrograms, setDeviceProfilePrograms, updateProgram, updateProgramModule, updateProgramModules, updatePrograms, updateProgramVersion, updateProgramVersions


deleteProgramVersion

Delete a ProgramVersion object.

Synopsis

void deleteProgramVersion(string authkey, guid program_version_gid)

Parameters

authkey

The user authentication key returned from login().

program_version_gid

The primary unique identifier of the ProgramVersion object to delete.

Return Value

The return value is undefined. An exception is thrown if the function fails.

Description

This function deletes a ProgramVersion object from the system. It will delete any ProgramModules that belong to the ProgramVersion. This ProgramVersion cannot be deleted if it is set to the current_version_gid of some Program. Either set the current version to the null guid or another ProgramVersion.

Access Control

This function requires the calling user have Update Program privileges on the Program.

See Also

createProgramVersion, createProgramVersions, deleteProgramVersions, getProgramModulesByProgramVersion, getProgramVersion, getProgramVersions, getProgramVersionsByGuid, getProgramVersionsByProgram, updateProgramVersion, updateProgramVersions


deleteProgramVersions

Delete multiple ProgramVersion objects.

Synopsis

Exception[] deleteProgramVersions(string authkey, guid[] program_version_gids)

Parameters

authkey

The user authentication key returned from login().

program_version_gids

The unique ids of the ProgramVersion objects to delete.

Return Value

Returns an array of Exceptions, corresponding to the status of each item in the input array.

Description

This function deletes multiple ProgramVersion objects from the system. It will delete any ProgramModules that belong to the ProgramVersion. The ProgramVersions cannot be deleted if they are set to the current_version_gid of some Program. Either set the current version to the null guid or another ProgramVersion.

Access Control

This function requires the calling user have Update Program privileges on the Program.

See Also

createProgramVersion, createProgramVersions, deleteProgramVersion, getProgramModulesByProgramVersion, getProgramVersion, getProgramVersions, getProgramVersionsByGuid, getProgramVersionsByProgram, updateProgramVersion, updateProgramVersions


deleteResource

Delete a Resource object.

Synopsis

void deleteResource(string authkey, guid resource_gid)

Parameters

authkey

The user authentication key returned from login().

resource_gid

The primary unique identifier of the Resource object to delete.

Return Value

The return value is undefined. An exception is thrown if the function fails.

Description

This function deletes a Resource object from the system. It will also delete any reference to the Resource from any Device or ProgramModule.

Access Control

This function requires the calling user have Delete Resource privileges on the Resource.

See Also

createGlobalResource, createGlobalResources, createJobStepsWithResourceRequirements, createJobStepWithResourceRequirements, createResource, createResources, deleteGlobalResource, deleteGlobalResourceRequirement, deleteGlobalResources, deleteResourceAvailable, deleteResourceRequirement, deleteResources, getAllGlobalResourceRequirements, getAllGlobalResources, getAllResourceAvailables, getAllResourceRequirements, getAllResources, getGlobalResource, getGlobalResourceByName, getGlobalResourceRequirementsByGlobalResource, getGlobalResourceRequirementsByProgramModule, getGlobalResources, getResource, getResourceAvailablesByDevice, getResourceAvailablesByResource, getResourceByName, getResourceRequirementsByJobStep, getResourceRequirementsByProgramModule, getResourceRequirementsByResource, getResources, getResourcesByGuid, setGlobalResourceRequirement, setGlobalResourceRequirements, setResourceAvailable, setResourceAvailables, setResourceRequirement, setResourceRequirements, updateGlobalResource, updateGlobalResources


deleteResourceAvailable

Delete a ResourceAvailable object.

Synopsis

void deleteResourceAvailable(string authkey, guid device_gid, guid resource_gid)

Parameters

authkey

The user authentication key returned from login().

device_gid

The unique identifier of the Device associated with the ResourceAvailable object.

resource_gid

The unique identifier of the Resource associated with the ResourceAvailable object.

Return Value

The return value is undefined. An exception is thrown if the function fails.

Access Control

This function requires the calling user have Update Device Group privileges on the DeviceGroup.

See Also

getAllResourceAvailables, getResourceAvailablesByDevice, getResourceAvailablesByResource, setResourceAvailable, setResourceAvailables


deleteResourceRequirement

Delete a ResourceRequirement object.

Synopsis

void deleteResourceRequirement(string authkey, guid program_module_gid, guid resource_gid)

Parameters

authkey

The user authentication key returned from login().

program_module_gid

The unique identifier of the ProgramModule associated with the ResourceRequirement object.

resource_gid

The unique identifier of the Resource associated with the ResourceRequirement object.

Return Value

The return value is undefined. An exception is thrown if the function fails.

Access Control

This function requires the calling user have Update Program privileges on the Program.

See Also

createJobStepsWithResourceRequirements, createJobStepWithResourceRequirements, deleteGlobalResourceRequirement, getAllGlobalResourceRequirements, getAllResourceRequirements, getGlobalResourceRequirementsByGlobalResource, getGlobalResourceRequirementsByProgramModule, getResourceRequirementsByJobStep, getResourceRequirementsByProgramModule, getResourceRequirementsByResource, setGlobalResourceRequirement, setGlobalResourceRequirements, setResourceRequirement, setResourceRequirements


deleteResources

Delete multiple Resource objects.

Synopsis

Exception[] deleteResources(string authkey, guid[] resource_gids)

Parameters

authkey

The user authentication key returned from login().

resource_gids

The unique ids of the Resource objects to delete.

Return Value

Returns an array of Exceptions, corresponding to the status of each item in the input array.

Description

This function deletes multiple Resource objects from the system. It will also delete any reference to the Resources from any Device or ProgramModule.

Access Control

This function requires the calling user have Delete Resource privileges on the Resource.

See Also

createGlobalResource, createGlobalResources, createJobStepsWithResourceRequirements, createJobStepWithResourceRequirements, createResource, createResources, deleteGlobalResource, deleteGlobalResourceRequirement, deleteGlobalResources, deleteResource, deleteResourceAvailable, deleteResourceRequirement, getAllGlobalResourceRequirements, getAllGlobalResources, getAllResourceAvailables, getAllResourceRequirements, getAllResources, getGlobalResource, getGlobalResourceByName, getGlobalResourceRequirementsByGlobalResource, getGlobalResourceRequirementsByProgramModule, getGlobalResources, getResource, getResourceAvailablesByDevice, getResourceAvailablesByResource, getResourceByName, getResourceRequirementsByJobStep, getResourceRequirementsByProgramModule, getResourceRequirementsByResource, getResources, getResourcesByGuid, setGlobalResourceRequirement, setGlobalResourceRequirements, setResourceAvailable, setResourceAvailables, setResourceRequirement, setResourceRequirements, updateGlobalResource, updateGlobalResources


deleteResult

Delete a Result object.

Synopsis

void deleteResult(string authkey, integer result_uid)

Parameters

authkey

The user authentication key returned from login().

result_uid

The primary unique identifier of the Result object to delete.

Return Value

The return value is undefined. An exception is thrown if the function fails.

Description

This function deletes a Result object from the system.

Access Control

This function requires the calling user have Update Job privileges on the Job.

See Also

createResultQueue, deleteResultQueue, deleteResults, getResult, getResults, getResultsById, getResultsByJobStep, getResultsByResultQueue, getResultsByWorkunit, removeResultsFromResultQueue


deleteResultQueue

Delete a result queue.

Synopsis

void deleteResultQueue(string authkey, guid result_queue_gid)

Parameters

authkey

The user authentication key returned from login().

result_queue_gid

The unique identifier of the result queue object to delete.

Return Value

The return value is undefined. An exception is thrown if the function fails.

Description

This function discards all pending result notifications in a result queue and removes the queue. Result queues are automatically deleted when the corresponding JobStep is deleted.

Access Control

This function requires the calling user have Update Job privileges on the Job.

See Also

createResultQueue, deleteResult, deleteResults, getResult, getResults, getResultsById, getResultsByJobStep, getResultsByResultQueue, getResultsByWorkunit, removeResultsFromResultQueue


deleteResults

Delete multiple Result objects.

Synopsis

Exception[] deleteResults(string authkey, integer[] result_uids)

Parameters

authkey

The user authentication key returned from login().

result_uids

The unique ids of the Result objects to delete.

Return Value

Returns an array of Exceptions, corresponding to the status of each item in the input array.

Description

This function deletes multiple Result objects from the system.

Access Control

This function requires the calling user have Update Job privileges on the Job.

See Also

createResultQueue, deleteResult, deleteResultQueue, getResult, getResults, getResultsById, getResultsByJobStep, getResultsByResultQueue, getResultsByWorkunit, removeResultsFromResultQueue


deleteSchedulingDescriptor

Delete a SchedulingDescriptor object.

Synopsis

void deleteSchedulingDescriptor(string authkey, guid scheduling_descriptor_gid)

Parameters

authkey

The user authentication key returned from login().

scheduling_descriptor_gid

The primary unique identifier of the SchedulingDescriptor object to delete.

Return Value

The return value is undefined. An exception is thrown if the function fails.

Description

This function deletes a SchedulingDescriptor object from the system.

Access Control

This function requires the calling user have Update Device Group privileges on the DeviceGroup.

See Also

createSchedulingDescriptor, createSchedulingDescriptors, deleteSchedulingDescriptors, getAllSchedulingDescriptors, getSchedulingDescriptor, getSchedulingDescriptorsByDeviceGroup, getSchedulingDescriptorUserGroupsByDeviceGroup, getSchedulingDescriptorUsersByDeviceGroup, updateSchedulingDescriptor, updateSchedulingDescriptors


deleteSchedulingDescriptors

Delete multiple SchedulingDescriptor objects.

Synopsis

Exception[] deleteSchedulingDescriptors(string authkey, guid[] scheduling_descriptor_gids)

Parameters

authkey

The user authentication key returned from login().

scheduling_descriptor_gids

The unique ids of the SchedulingDescriptor objects to delete.

Return Value

Returns an array of Exceptions, corresponding to the status of each item in the input array.

Description

This function deletes multiple SchedulingDescriptor objects from the system.

Access Control

This function requires the calling user have Update Device Group privileges on the DeviceGroup.

See Also

createSchedulingDescriptor, createSchedulingDescriptors, deleteSchedulingDescriptor, getAllSchedulingDescriptors, getSchedulingDescriptor, getSchedulingDescriptorsByDeviceGroup, getSchedulingDescriptorUserGroupsByDeviceGroup, getSchedulingDescriptorUsersByDeviceGroup, updateSchedulingDescriptor, updateSchedulingDescriptors


deleteService

Delete a Service object.

Synopsis

void deleteService(string authkey, guid service_gid)

Parameters

authkey

The user authentication key returned from login().

service_gid

The primary unique identifier of the Service object to delete.

Return Value

The return value is undefined. An exception is thrown if the function fails.

Description

This function deletes a Service object from the system.

Access Control

This function is restricted to users with the MP Administrator role only.

See Also

createService, createServiceManager, createServices, deleteServiceManager, deleteServices, getAllServiceManagers, getAllServices, getService, getServiceManager, getServiceManagerByName, getServicesByServiceManager, queryServiceManager, queryServicesByServiceManager, updateService, updateServiceManager, updateServiceStatus


deleteServiceManager

Delete a ServiceManager object.

Synopsis

void deleteServiceManager(string authkey, guid service_manager_gid)

Parameters

authkey

The user authentication key returned from login().

service_manager_gid

The primary unique identifier of the ServiceManager object to delete.

Return Value

The return value is undefined. An exception is thrown if the function fails.

Description

This function deletes a ServiceManager object from the system. It will also delete any Services that were controlled by the ServiceManager.

Access Control

This function is restricted to users with the MP Administrator role only.

See Also

createServiceManager, getAllServiceManagers, getServiceManager, getServiceManagerByName, getServicesByServiceManager, queryServiceManager, queryServicesByServiceManager, updateServiceManager


deleteServices

Delete multiple Service objects.

Synopsis

Exception[] deleteServices(string authkey, guid[] service_gids)

Parameters

authkey

The user authentication key returned from login().

service_gids

The unique ids of the Service objects to delete.

Return Value

Returns an array of Exceptions, corresponding to the status of each item in the input array.

Description

This function deletes multiple Service objects from the system. It will also delete any Services that were controlled by the ServiceManagers.

Access Control

This function is restricted to users with the MP Administrator role only.

See Also

createService, createServiceManager, createServices, deleteService, deleteServiceManager, getAllServiceManagers, getAllServices, getService, getServiceManager, getServiceManagerByName, getServicesByServiceManager, queryServiceManager, queryServicesByServiceManager, updateService, updateServiceManager, updateServiceStatus


deleteUser

Delete a User object.

Synopsis

void deleteUser(string authkey, guid user_gid)

Parameters

authkey

The user authentication key returned from login().

user_gid

The primary unique identifier of the User object to delete.

Return Value

The return value is undefined. An exception is thrown if the function fails.

Description

This function deletes a User object from the system. It will also delete any Jobs that were created by the User. It will delete any Credential objects that refer to the User.

Access Control

This function is restricted to users with the MP Administrator role only.

See Also

addPrivilegesToUserGroup, addPrivilegeToUserGroup, addUserOrGroupsToObjectPrivilege, addUserOrGroupsToRole, addUserOrGroupToObjectPrivilege, addUserOrGroupToRole, addUsersToUserGroup, addUserToUserGroup, createUser, createUserGroup, createUserGroups, createUsers, deleteUserGroup, deleteUserGroups, deleteUsers, getAllUserGroups, getAllUsers, getCountUserGroupsByRole, getCountUsersByRole, getCountUsersByUserGroup, getPrivilegesByUserGroup, getPrivilegesByUserOrGroupObject, getRolesByUserOrGroup, getSchedulingDescriptorUserGroupsByDeviceGroup, getSchedulingDescriptorUsersByDeviceGroup, getUser, getUserByName, getUserGroup, getUserGroupByName, getUserGroupPrivilegesByObject, getUserGroups, getUserGroupsByGuid, getUserGroupsByObjectPrivilege, getUserGroupsByRole, getUserGroupsByUser, getUserOrGroupPrivilegesByObject, getUserOrGroupsByObjectPrivilege, getUserOrGroupsByRole, getUserPrivilegesByObject, getUserProfile, getUsers, getUsersByGuid, getUsersByObjectPrivilege, getUsersByRole, getUsersByUserGroup, removePrivilegeFromUserGroup, removePrivilegesFromUserGroup, removeUserFromUserGroup, removeUserOrGroupFromObjectPrivilege, removeUserOrGroupFromRole, removeUserOrGroupsFromObjectPrivilege, removeUserOrGroupsFromRole, removeUsersFromUserGroup, setObjectPrivilegeUserAndGroups, setObjectUserOrGroupPrivileges, setRoleUserAndGroups, setUserGroupPrivileges, setUserGroupUsers, setUserOrGroupRoles, setUserUserGroups, updateUser, updateUserGroup, updateUserGroups, updateUserPassword, updateUserProfile, updateUsers


deleteUserGroup

Delete a UserGroup object.

Synopsis

void deleteUserGroup(string authkey, guid user_group_gid)

Parameters

authkey

The user authentication key returned from login().

user_group_gid

The primary unique identifier of the UserGroup object to delete.

Return Value

The return value is undefined. An exception is thrown if the function fails.

Description

This function deletes a UserGroup object from the system. It does not delete any Users.

Access Control

This function is restricted to users with the MP Administrator role only.

See Also

addPrivilegesToUserGroup, addPrivilegeToUserGroup, addUsersToUserGroup, addUserToUserGroup, createUserGroup, createUserGroups, deleteUserGroups, getAllUserGroups, getCountUserGroupsByRole, getCountUsersByUserGroup, getPrivilegesByUserGroup, getSchedulingDescriptorUserGroupsByDeviceGroup, getUserGroup, getUserGroupByName, getUserGroupPrivilegesByObject, getUserGroups, getUserGroupsByGuid, getUserGroupsByObjectPrivilege, getUserGroupsByRole, getUserGroupsByUser, getUsersByUserGroup, removePrivilegeFromUserGroup, removePrivilegesFromUserGroup, removeUserFromUserGroup, removeUsersFromUserGroup, setUserGroupPrivileges, setUserGroupUsers, setUserUserGroups, updateUserGroup, updateUserGroups


deleteUserGroups

Delete multiple UserGroup objects.

Synopsis

Exception[] deleteUserGroups(string authkey, guid[] user_group_gids)

Parameters

authkey

The user authentication key returned from login().

user_group_gids

The unique ids of the UserGroup objects to delete.

Return Value

Returns an array of Exceptions, corresponding to the status of each item in the input array.

Description

This function deletes multiple UserGroup objects from the system. It does not delete any Users.

Access Control

This function is restricted to users with the MP Administrator role only.

See Also

addPrivilegesToUserGroup, addPrivilegeToUserGroup, addUsersToUserGroup, addUserToUserGroup, createUserGroup, createUserGroups, deleteUserGroup, getAllUserGroups, getCountUserGroupsByRole, getCountUsersByUserGroup, getPrivilegesByUserGroup, getSchedulingDescriptorUserGroupsByDeviceGroup, getUserGroup, getUserGroupByName, getUserGroupPrivilegesByObject, getUserGroups, getUserGroupsByGuid, getUserGroupsByObjectPrivilege, getUserGroupsByRole, getUserGroupsByUser, getUsersByUserGroup, removePrivilegeFromUserGroup, removePrivilegesFromUserGroup, removeUserFromUserGroup, removeUsersFromUserGroup, setUserGroupPrivileges, setUserGroupUsers, setUserUserGroups, updateUserGroup, updateUserGroups


deleteUsers

Delete multiple User objects.

Synopsis

Exception[] deleteUsers(string authkey, guid[] user_gids)

Parameters

authkey

The user authentication key returned from login().

user_gids

The unique ids of the User objects to delete.

Return Value

Returns an array of Exceptions, corresponding to the status of each item in the input array.

Description

This function deletes multiple User objects from the system. It will also delete any Jobs that were created by the Users. It will delete any Credential objects that refer to the Users.

Access Control

This function is restricted to users with the MP Administrator role only.

See Also

addPrivilegesToUserGroup, addPrivilegeToUserGroup, addUserOrGroupsToObjectPrivilege, addUserOrGroupsToRole, addUserOrGroupToObjectPrivilege, addUserOrGroupToRole, addUsersToUserGroup, addUserToUserGroup, createUser, createUserGroup, createUserGroups, createUsers, deleteUser, deleteUserGroup, deleteUserGroups, getAllUserGroups, getAllUsers, getCountUserGroupsByRole, getCountUsersByRole, getCountUsersByUserGroup, getPrivilegesByUserGroup, getPrivilegesByUserOrGroupObject, getRolesByUserOrGroup, getSchedulingDescriptorUserGroupsByDeviceGroup, getSchedulingDescriptorUsersByDeviceGroup, getUser, getUserByName, getUserGroup, getUserGroupByName, getUserGroupPrivilegesByObject, getUserGroups, getUserGroupsByGuid, getUserGroupsByObjectPrivilege, getUserGroupsByRole, getUserGroupsByUser, getUserOrGroupPrivilegesByObject, getUserOrGroupsByObjectPrivilege, getUserOrGroupsByRole, getUserPrivilegesByObject, getUserProfile, getUsers, getUsersByGuid, getUsersByObjectPrivilege, getUsersByRole, getUsersByUserGroup, removePrivilegeFromUserGroup, removePrivilegesFromUserGroup, removeUserFromUserGroup, removeUserOrGroupFromObjectPrivilege, removeUserOrGroupFromRole, removeUserOrGroupsFromObjectPrivilege, removeUserOrGroupsFromRole, removeUsersFromUserGroup, setObjectPrivilegeUserAndGroups, setObjectUserOrGroupPrivileges, setRoleUserAndGroups, setUserGroupPrivileges, setUserGroupUsers, setUserOrGroupRoles, setUserUserGroups, updateUser, updateUserGroup, updateUserGroups, updateUserPassword, updateUserProfile, updateUsers


deleteWorkunit

Delete a Workunit object.

Synopsis

void deleteWorkunit(string authkey, guid workunit_gid)

Parameters

authkey

The user authentication key returned from login().

workunit_gid

The primary unique identifier of the Workunit object to delete.

Return Value

The return value is undefined. An exception is thrown if the function fails.

Description

This function deletes a Workunit object from the system. It also deletes any Results for the Workunit. The presence of any Error records that mention this Workunit will not prevent the success of this function.

Access Control

This function requires the calling user have Update Job privileges on the Job.

See Also

createWorkunit, createWorkunits, createWorkunitsFromDataSetsAsync, deleteWorkunits, getDatasByWorkunit, getDataSetsByJobStepWorkunits, getDevicesByWorkunit, getResultsByWorkunit, getWorkunit, getWorkunits, getWorkunitsByGuid, getWorkunitsByJobStep, getWorkunitStatesByJobStep, getWorkunitsWithDatasByGuid, updateWorkunitState, updateWorkunitStates


deleteWorkunits

Delete multiple Workunit objects.

Synopsis

Exception[] deleteWorkunits(string authkey, guid[] workunit_gids)

Parameters

authkey

The user authentication key returned from login().

workunit_gids

The unique ids of the Workunit objects to delete.

Return Value

Returns an array of Exceptions, corresponding to the status of each item in the input array.

Description

This function deletes multiple Workunit objects from the system. It also deletes any Results for the Workunits. The presence of any Error records that mention these Workunits will not prevent the success of this function.

Access Control

This function requires the calling user have Update Job privileges on the Job.

See Also

createWorkunit, createWorkunits, createWorkunitsFromDataSetsAsync, deleteWorkunit, getDatasByWorkunit, getDataSetsByJobStepWorkunits, getDevicesByWorkunit, getResultsByWorkunit, getWorkunit, getWorkunits, getWorkunitsByGuid, getWorkunitsByJobStep, getWorkunitStatesByJobStep, getWorkunitsWithDatasByGuid, updateWorkunitState, updateWorkunitStates


getAgentModule

Return a specific AgentModule object.

Synopsis

AgentModule getAgentModule(string authkey, guid agent_module_gid)

Parameters

authkey

The user authentication key returned from login().

agent_module_gid

The identifier of the AgentModule to be returned.

Return Value

The return value is the requested AgentModule object. An exception is thrown if the function fails.

Description

This function returns a AgentModule object for a specific id.

Access Control

This function is restricted to users with the MP Administrator role only.

See Also

createAgentModule, createAgentModules, deleteAgentModule, deleteAgentModules, getAgentModuleByAgentVersionPlatform, getAgentModules, getAgentModulesByGuid, getAllAgentModules


getAgentModuleByAgentVersionPlatform

Returns an AgentModule object for a given AgentVersion and Platform.

Synopsis

AgentModule getAgentModuleByAgentVersionPlatform(string authkey, guid agent_version_gid, integer platform_id)

Parameters

authkey

The user authentication key returned from login().

agent_version_gid

The unique identifier of the AgentVersion to query.

platform_id

The identifier of the Platform to query.

Return Value

The requested AgentModule. An exception is thrown if the function fails.

Description

This is only used to upgrade the Agent software.

Access Control

This function is restricted to users with the MP Administrator role only.

See Also

getAgentModule, getAgentModulesByGuid, getAllAgentModules


getAgentModules

Return a filtered list of AgentModule objects.

Synopsis

AgentModuleArrayRange getAgentModules(string authkey, AgentModuleFilter filter, string order, integer start, integer count)

Parameters

authkey

The user authentication key returned from login().

filter

The filter condition that selects which objects will be returned.

order

The sort order in which the objects will be returned.

start

The position in the sorted list to start returning objects. Must be greater than or equal to zero and less than the number of matching elements.

count

The maximum number of objects to return. If this is greater than or equal to 0, then it specifies the maximum number of objects. If this is -1, then the maximum number of objects is unbounded.

Return Value

The return value is the filtered list of AgentModule objects. An exception is thrown if the function fails.

Description

This function returns a filtered list of all AgentModule objects that the logged-in user can access. For further information on filter functions, see Filtering and Paging.

Access Control

This function is restricted to users with the MP Administrator role only.

See Also

createAgentModule, createAgentModules, deleteAgentModule, deleteAgentModules, getAgentModule, getAgentModuleByAgentVersionPlatform, getAgentModulesByGuid, getAllAgentModules


getAgentModulesByGuid

Return specific AgentModule objects.

Synopsis

AgentModule[] getAgentModulesByGuid(string authkey, guid[] agent_module_gids)

Parameters

authkey

The user authentication key returned from login().

agent_module_gids

The ids of the AgentModule objects to be returned.

Return Value

The return value is the requested AgentModule objects. An exception is thrown if the function fails.

Description

This function returns a list of specific AgentModule objects by id.

Access Control

This function is restricted to users with the MP Administrator role only.

See Also

createAgentModule, createAgentModules, deleteAgentModule, deleteAgentModules, getAgentModule, getAgentModuleByAgentVersionPlatform, getAgentModules, getAllAgentModules


getAgentVersion

Return a specific AgentVersion object.

Synopsis

AgentVersion getAgentVersion(string authkey, guid agent_version_gid)

Parameters

authkey

The user authentication key returned from login().

agent_version_gid

The identifier of the AgentVersion to be returned.

Return Value

The return value is the requested AgentVersion object. An exception is thrown if the function fails.

Description

This function returns a AgentVersion object for a specific id.

Access Control

This function has no specific access control requirements.

See Also

createAgentVersion, createAgentVersions, deleteAgentVersion, deleteAgentVersions, getAgentModuleByAgentVersionPlatform, getAgentVersionByName, getAgentVersions, getAgentVersionsByGuid, getAllAgentVersions, getCountDeviceGroupsByAgentVersion


getAgentVersionByName

Return a specific AgentVersion object.

Synopsis

AgentVersion getAgentVersionByName(string authkey, string name)

Parameters

authkey

The user authentication key returned from login().

name

The name of the AgentVersion to be returned.

Return Value

The return value is the requested AgentVersion object. An exception is thrown if the function fails.

Description

This function returns a AgentVersion object for a specific name.

Access Control

This function has no specific access control requirements.

See Also

createAgentVersion, createAgentVersions, deleteAgentVersion, deleteAgentVersions, getAgentModuleByAgentVersionPlatform, getAgentVersion, getAgentVersions, getAgentVersionsByGuid, getAllAgentVersions, getCountDeviceGroupsByAgentVersion


getAgentVersions

Return a filtered list of AgentVersion objects.

Synopsis

AgentVersionArrayRange getAgentVersions(string authkey, AgentVersionFilter filter, string order, integer start, integer count)

Parameters

authkey

The user authentication key returned from login().

filter

The filter condition that selects which objects will be returned.

order

The sort order in which the objects will be returned.

start

The position in the sorted list to start returning objects. Must be greater than or equal to zero and less than the number of matching elements.

count

The maximum number of objects to return. If this is greater than or equal to 0, then it specifies the maximum number of objects. If this is -1, then the maximum number of objects is unbounded.

Return Value

The return value is the filtered list of AgentVersion objects. An exception is thrown if the function fails.

Description

This function returns a filtered list of all AgentVersion objects that the logged-in user can access. For further information on filter functions, see Filtering and Paging.

Access Control

This function has no specific access control requirements.

See Also

createAgentVersion, createAgentVersions, deleteAgentVersion, deleteAgentVersions, getAgentModuleByAgentVersionPlatform, getAgentVersion, getAgentVersionByName, getAgentVersionsByGuid, getAllAgentVersions, getCountDeviceGroupsByAgentVersion


getAgentVersionsByGuid

Return specific AgentVersion objects.

Synopsis

AgentVersion[] getAgentVersionsByGuid(string authkey, guid[] agent_version_gids)

Parameters

authkey

The user authentication key returned from login().

agent_version_gids

The ids of the AgentVersion objects to be returned.

Return Value

The return value is the requested AgentVersion objects. An exception is thrown if the function fails.

Description

This function returns a list of specific AgentVersion objects by id.

Access Control

This function has no specific access control requirements.

See Also

createAgentVersion, createAgentVersions, deleteAgentVersion, deleteAgentVersions, getAgentModuleByAgentVersionPlatform, getAgentVersion, getAgentVersionByName, getAgentVersions, getAllAgentVersions, getCountDeviceGroupsByAgentVersion


getAllAgentModules

Return a list of all AgentModule objects.

Synopsis

AgentModule[] getAllAgentModules(string authkey)

Parameters

authkey

The user authentication key returned from login().

Return Value

The return value is the list of AgentModule objects. An exception is thrown if the function fails.

Description

This function returns all AgentModule objects that the logged-in user can access.

Access Control

This function is restricted to users with the MP Administrator role only.

See Also

createAgentModule, createAgentModules, deleteAgentModule, deleteAgentModules, getAgentModule, getAgentModuleByAgentVersionPlatform, getAgentModules, getAgentModulesByGuid


getAllAgentVersions

Return a list of all AgentVersion objects.

Synopsis

AgentVersion[] getAllAgentVersions(string authkey)

Parameters

authkey

The user authentication key returned from login().

Return Value

The return value is the list of AgentVersion objects. An exception is thrown if the function fails.

Description

This function returns all AgentVersion objects that the logged-in user can access.

Access Control

This function has no specific access control requirements.

See Also

createAgentVersion, createAgentVersions, deleteAgentVersion, deleteAgentVersions, getAgentModuleByAgentVersionPlatform, getAgentVersion, getAgentVersionByName, getAgentVersions, getAgentVersionsByGuid, getCountDeviceGroupsByAgentVersion


getAllApplications

Return a list of all Application objects.

Synopsis

Application[] getAllApplications(string authkey)

Parameters

authkey

The user authentication key returned from login().

Return Value

The return value is the list of Application objects. An exception is thrown if the function fails.

Description

This function returns all Application objects that the logged-in user can access.

Access Control

This function requires the calling user have Read Application privileges on the Application.

See Also

addApplicationsToDeviceProfile, addApplicationToDeviceProfile, addProgramsToApplication, addProgramToApplication, createApplication, createApplications, deleteApplication, deleteApplications, getApplication, getApplicationByName, getApplications, getApplicationsByDeviceProfile, getApplicationsByGuid, getApplicationsByProgram, getJobsByApplication, getProgramsByApplication, removeApplicationFromDeviceProfile, removeApplicationsFromDeviceProfile, removeProgramFromApplication, removeProgramsFromApplication, setApplicationPrograms, setDeviceProfileApplications, updateApplication, updateApplications


getAllCredentials

Return a list of all Credential objects.

Synopsis

Credential[] getAllCredentials(string authkey)

Parameters

authkey

The user authentication key returned from login().

Return Value

The return value is the list of Credential objects. An exception is thrown if the function fails.

Description

This function returns all Credential objects that the logged-in user can access.

Access Control

This function requires the calling user have Read Device Group privileges on the DeviceGroup.

See Also

createCredential, createCredentials, deleteCredential, deleteCredentials, getCredential, getCredentials, updateCredential, updateCredentials


getAllDataSets

Return a list of all DataSet objects.

Synopsis

DataSet[] getAllDataSets(string authkey)

Parameters

authkey

The user authentication key returned from login().

Return Value

The return value is the list of DataSet objects. An exception is thrown if the function fails.

Description

This function returns all DataSet objects that the logged-in user can access.

Access Control

This function requires the calling user have Read Data privileges on the DataSet.

See Also

createDataSet, createDataSets, createWorkunitsFromDataSetsAsync, deleteDataSet, deleteDataSets, getDatasByDataSet, getDataSet, getDataSetByName, getDataSets, getDataSetsByGuid, getDataSetsByJobStepWorkunits, updateDataSet, updateDataSets


getAllDeviceGroups

Return a list of all DeviceGroup objects.

Synopsis

DeviceGroup[] getAllDeviceGroups(string authkey)

Parameters

authkey

The user authentication key returned from login().

Return Value

The return value is the list of DeviceGroup objects. An exception is thrown if the function fails.

Description

This function returns all DeviceGroup objects that the logged-in user can access.

Access Control

This function requires the calling user have Read Device Group privileges on the DeviceGroup.

See Also

addDeviceGroupsToJob, addDeviceGroupToJob, createDeviceGroup, createDeviceGroups, deleteDeviceGroup, deleteDeviceGroups, getCountDeviceGroupsByAgentVersion, getCountDevicesByDeviceGroup, getDeviceGroup, getDeviceGroupByName, getDeviceGroups, getDeviceGroupsByGuid, getDeviceGroupsByJob, getDeviceProfilesByDeviceGroup, getDevicesByDeviceGroup, getJobsByDeviceGroup, getSchedulingDescriptorsByDeviceGroup, getSchedulingDescriptorUserGroupsByDeviceGroup, getSchedulingDescriptorUsersByDeviceGroup, getStatsAllDeviceGroups, getStatsDeviceGroup, getStatsDevicesByDeviceGroup, removeDeviceGroupFromJob, removeDeviceGroupsFromJob, setJobDeviceGroups, updateDeviceGroup, updateDeviceGroupRestricted, updateDeviceGroups


getAllDeviceProfiles

Return a list of all DeviceProfile objects.

Synopsis

DeviceProfile[] getAllDeviceProfiles(string authkey)

Parameters

authkey

The user authentication key returned from login().

Return Value

The return value is the list of DeviceProfile objects. An exception is thrown if the function fails.

Description

This function returns all DeviceProfile objects that the logged-in user can access.

Access Control

This function requires the calling user have Read Device Group privileges on the DeviceGroup.

See Also

addApplicationsToDeviceProfile, addApplicationToDeviceProfile, addProgramsToDeviceProfile, addProgramToDeviceProfile, createDeviceProfile, createDeviceProfiles, deleteDeviceProfile, deleteDeviceProfiles, getApplicationsByDeviceProfile, getCountDevicesByDeviceProfile, getDeviceProfile, getDeviceProfiles, getDeviceProfilesByDeviceGroup, getDeviceProfilesByGuid, getDevicesByDeviceProfile, getProgramsByDeviceProfile, removeApplicationFromDeviceProfile, removeApplicationsFromDeviceProfile, removeProgramFromDeviceProfile, removeProgramsFromDeviceProfile, setDeviceProfileApplications, setDeviceProfilePrograms, updateDeviceProfile, updateDeviceProfiles


getAllDevices

Return a list of all Device objects.

Synopsis

Device[] getAllDevices(string authkey)

Parameters

authkey

The user authentication key returned from login().

Return Value

The return value is the list of Device objects. An exception is thrown if the function fails.

Description

This function returns all Device objects that the logged-in user can access.

Access Control

This function requires the calling user have Read Device Group privileges on the DeviceGroup.

See Also

addApplicationsToDeviceProfile, addApplicationToDeviceProfile, addDeviceGroupsToJob, addDeviceGroupToJob, addProgramsToDeviceProfile, addProgramToDeviceProfile, cancelDeviceCommands, createDeviceGroup, createDeviceGroups, createDeviceProfile, createDeviceProfiles, deleteDevice, deleteDeviceGroup, deleteDeviceGroups, deleteDeviceProfile, deleteDeviceProfiles, deleteDevices, getAllDeviceGroups, getAllDeviceProfiles, getApplicationsByDeviceProfile, getCountDeviceGroupsByAgentVersion, getCountDevicesByDeviceGroup, getCountDevicesByDeviceProfile, getDevice, getDeviceCommands, getDeviceGroup, getDeviceGroupByName, getDeviceGroups, getDeviceGroupsByGuid, getDeviceGroupsByJob, getDeviceProfile, getDeviceProfiles, getDeviceProfilesByDeviceGroup, getDeviceProfilesByGuid, getDevices, getDevicesByDeviceGroup, getDevicesByDeviceProfile, getDevicesByGuid, getDevicesByWorkunit, getJobsByDeviceGroup, getProgramsByDeviceProfile, getResourceAvailablesByDevice, getSchedulingDescriptorsByDeviceGroup, getSchedulingDescriptorUserGroupsByDeviceGroup, getSchedulingDescriptorUsersByDeviceGroup, getStatsAllDeviceGroups, getStatsDevice, getStatsDeviceGroup, getStatsDevicesByDeviceGroup, getStatsJobDevices, moveDevices, removeApplicationFromDeviceProfile, removeApplicationsFromDeviceProfile, removeDeviceGroupFromJob, removeDeviceGroupsFromJob, removeProgramFromDeviceProfile, removeProgramsFromDeviceProfile, sendDeviceCommand, setDeviceProfileApplications, setDeviceProfilePrograms, setJobDeviceGroups, updateDevice, updateDeviceGroup, updateDeviceGroupRestricted, updateDeviceGroups, updateDeviceProfile, updateDeviceProfiles


getAllGlobalResourceRequirements

Return a list of all GlobalResourceRequirement objects.

Synopsis

GlobalResourceRequirement[] getAllGlobalResourceRequirements(string authkey)

Parameters

authkey

The user authentication key returned from login().

Return Value

The return value is the list of GlobalResourceRequirement objects. An exception is thrown if the function fails.

Description

This function returns all GlobalResourceRequirement objects that the logged-in user can access.

Access Control

This function requires the calling user have Read Program privileges on the Program.

See Also

deleteGlobalResourceRequirement, getGlobalResourceRequirementsByGlobalResource, getGlobalResourceRequirementsByProgramModule, setGlobalResourceRequirement, setGlobalResourceRequirements


getAllGlobalResources

Return all GlobalResource objects.

Synopsis

GlobalResource[] getAllGlobalResources(string authkey)

Parameters

authkey

The user authentication key returned from login().

Return Value

The return value is the requested GlobalResource objects. An exception is thrown if the function fails.

Access Control

This function requires the calling user have Read Resource privileges on the GlobalResource.

See Also

createGlobalResource, createGlobalResources, deleteGlobalResource, deleteGlobalResourceRequirement, deleteGlobalResources, getAllGlobalResourceRequirements, getGlobalResource, getGlobalResourceByName, getGlobalResourceRequirementsByGlobalResource, getGlobalResourceRequirementsByProgramModule, getGlobalResources, setGlobalResourceRequirement, setGlobalResourceRequirements, updateGlobalResource, updateGlobalResources


getAllJobs

Return a list of all Job objects.

Synopsis

Job[] getAllJobs(string authkey)

Parameters

authkey

The user authentication key returned from login().

Return Value

The return value is the list of Job objects. An exception is thrown if the function fails.

Description

This function returns all Job objects that the logged-in user can access.

Access Control

This function requires the calling user have Read Job privileges on the Job.

See Also

addDeviceGroupsToJob, addDeviceGroupToJob, createJob, createJob2, createJobs, createJobStep, createJobSteps, createJobStepsWithResourceRequirements, createJobStepWithResourceRequirements, deleteJob, deleteJobs, deleteJobStep, deleteJobSteps, getDataSetsByJobStepWorkunits, getDeviceGroupsByJob, getJob, getJobById, getJobs, getJobsByApplication, getJobsByDeviceGroup, getJobsByGuid, getJobStatus, getJobStatusesByGuid, getJobStep, getJobSteps, getJobStepsByGuid, getJobStepsByJob, getJobStepsByProgram, getJobStepStatus, getProgramModuleVersionsByJobStep, getResourceRequirementsByJobStep, getResultsByJobStep, getStatsAllJobStates, getStatsJobDevices, getWorkunitsByJobStep, getWorkunitStatesByJobStep, removeDeviceGroupFromJob, removeDeviceGroupsFromJob, setJobDeviceGroups, updateJob, updateJobs, updateJobStep, updateJobSteps


getAllPlatforms

Return a list of all Platform objects.

Synopsis

Platform[] getAllPlatforms(string authkey)

Parameters

authkey

The user authentication key returned from login().

Return Value

The return value is the list of Platform objects. An exception is thrown if the function fails.

Description

This function returns all Platform objects that the logged-in user can access.

Access Control

This function has no specific access control requirements.

See Also

getAgentModuleByAgentVersionPlatform, getPlatform, getPlatformByName, getPlatformsById


getAllPrivileges

Return a list of all Privilege objects.

Synopsis

Privilege[] getAllPrivileges(string authkey)

Parameters

authkey

The user authentication key returned from login().

Return Value

The return value is the list of Privilege objects. An exception is thrown if the function fails.

Description

This function returns all Privilege objects that the logged-in user can access.

Access Control

This function has no specific access control requirements.

See Also

addPrivilegesToUserGroup, addPrivilegeToUserGroup, addUserOrGroupsToObjectPrivilege, addUserOrGroupToObjectPrivilege, getPrivilege, getPrivilegeByName, getPrivileges, getPrivilegesByGuid, getPrivilegesByUserGroup, getPrivilegesByUserOrGroupObject, getUserGroupPrivilegesByObject, getUserGroupsByObjectPrivilege, getUserOrGroupPrivilegesByObject, getUserOrGroupsByObjectPrivilege, getUserPrivilegesByObject, getUsersByObjectPrivilege, removePrivilegeFromUserGroup, removePrivilegesFromUserGroup, removeUserOrGroupFromObjectPrivilege, removeUserOrGroupsFromObjectPrivilege, setObjectPrivilegeUserAndGroups, setObjectUserOrGroupPrivileges, setUserGroupPrivileges


getAllPrograms

Return a list of all Program objects.

Synopsis

Program[] getAllPrograms(string authkey)

Parameters

authkey

The user authentication key returned from login().

Return Value

The return value is the list of Program objects. An exception is thrown if the function fails.

Description

This function returns all Program objects that the logged-in user can access.

Access Control

This function requires the calling user have Read Program privileges on the Program.

See Also

addProgramsToApplication, addProgramsToDeviceProfile, addProgramToApplication, addProgramToDeviceProfile, createProgram, createProgramModule, createProgramModules, createProgramModuleVersion, createProgramModuleVersions, createPrograms, createProgramVersion, createProgramVersions, deleteProgram, deleteProgramModule, deleteProgramModules, deleteProgramModuleVersion, deleteProgramModuleVersions, deletePrograms, deleteProgramVersion, deleteProgramVersions, getApplicationsByProgram, getGlobalResourceRequirementsByProgramModule, getJobStepsByProgram, getProgram, getProgramByName, getProgramModule, getProgramModules, getProgramModulesByGuid, getProgramModulesByProgram, getProgramModulesByProgramVersion, getProgramModuleVersion, getProgramModuleVersions, getProgramModuleVersionsByGuid, getProgramModuleVersionsByJobStep, getProgramModuleVersionsByProgramModule, getPrograms, getProgramsByApplication, getProgramsByDeviceProfile, getProgramsByGuid, getProgramVersion, getProgramVersions, getProgramVersionsByGuid, getProgramVersionsByProgram, getResourceRequirementsByProgramModule, removeProgramFromApplication, removeProgramFromDeviceProfile, removeProgramsFromApplication, removeProgramsFromDeviceProfile, setApplicationPrograms, setDeviceProfilePrograms, updateProgram, updateProgramModule, updateProgramModules, updatePrograms, updateProgramVersion, updateProgramVersions


getAllResourceAvailables

Return a list of all ResourceAvailable objects.

Synopsis

ResourceAvailable[] getAllResourceAvailables(string authkey)

Parameters

authkey

The user authentication key returned from login().

Return Value

The return value is the list of ResourceAvailable objects. An exception is thrown if the function fails.

Description

This function returns all ResourceAvailable objects that the logged-in user can access.

Access Control

This function requires the calling user have Read Device Group privileges on the DeviceGroup.

See Also

deleteResourceAvailable, getResourceAvailablesByDevice, getResourceAvailablesByResource, setResourceAvailable, setResourceAvailables


getAllResourceRequirements

Return a list of all ResourceRequirement objects.

Synopsis

ResourceRequirement[] getAllResourceRequirements(string authkey)

Parameters

authkey

The user authentication key returned from login().

Return Value

The return value is the list of ResourceRequirement objects. An exception is thrown if the function fails.

Description

This function returns all ResourceRequirement objects that the logged-in user can access.

Access Control

This function requires the calling user have Read Program privileges on the Program.

See Also

createJobStepsWithResourceRequirements, createJobStepWithResourceRequirements, deleteGlobalResourceRequirement, deleteResourceRequirement, getAllGlobalResourceRequirements, getGlobalResourceRequirementsByGlobalResource, getGlobalResourceRequirementsByProgramModule, getResourceRequirementsByJobStep, getResourceRequirementsByProgramModule, getResourceRequirementsByResource, setGlobalResourceRequirement, setGlobalResourceRequirements, setResourceRequirement, setResourceRequirements


getAllResources

Return a list of all Resource objects.

Synopsis

Resource[] getAllResources(string authkey)

Parameters

authkey

The user authentication key returned from login().

Return Value

The return value is the list of Resource objects. An exception is thrown if the function fails.

Description

This function returns all Resource objects that the logged-in user can access.

Access Control

This function requires the calling user have Read Resource privileges on the Resource.

See Also

createGlobalResource, createGlobalResources, createJobStepsWithResourceRequirements, createJobStepWithResourceRequirements, createResource, createResources, deleteGlobalResource, deleteGlobalResourceRequirement, deleteGlobalResources, deleteResource, deleteResourceAvailable, deleteResourceRequirement, deleteResources, getAllGlobalResourceRequirements, getAllGlobalResources, getAllResourceAvailables, getAllResourceRequirements, getGlobalResource, getGlobalResourceByName, getGlobalResourceRequirementsByGlobalResource, getGlobalResourceRequirementsByProgramModule, getGlobalResources, getResource, getResourceAvailablesByDevice, getResourceAvailablesByResource, getResourceByName, getResourceRequirementsByJobStep, getResourceRequirementsByProgramModule, getResourceRequirementsByResource, getResources, getResourcesByGuid, setGlobalResourceRequirement, setGlobalResourceRequirements, setResourceAvailable, setResourceAvailables, setResourceRequirement, setResourceRequirements, updateGlobalResource, updateGlobalResources


getAllRoles

Return a list of all Role objects.

Synopsis

Role[] getAllRoles(string authkey)

Parameters

authkey

The user authentication key returned from login().

Return Value

The return value is the list of Role objects. An exception is thrown if the function fails.

Description

This function returns all Role objects that the logged-in user can access.

Access Control

This function has no specific access control requirements.

See Also

addUserOrGroupsToRole, addUserOrGroupToRole, getCountUserGroupsByRole, getCountUsersByRole, getRole, getRoleByName, getRoles, getRolesByGuid, getRolesByUserOrGroup, getUserGroupsByRole, getUserOrGroupsByRole, getUsersByRole, removeUserOrGroupFromRole, removeUserOrGroupsFromRole, setRoleUserAndGroups, setUserOrGroupRoles


getAllSchedulingDescriptors

Return a list of all SchedulingDescriptor objects.

Synopsis

SchedulingDescriptor[] getAllSchedulingDescriptors(string authkey)

Parameters

authkey

The user authentication key returned from login().

Return Value

The return value is the list of SchedulingDescriptor objects. An exception is thrown if the function fails.

Description

This function returns all SchedulingDescriptor objects that the logged-in user can access.

Access Control

This function requires the calling user have Read Device Group privileges on the DeviceGroup.

See Also

createSchedulingDescriptor, createSchedulingDescriptors, deleteSchedulingDescriptor, deleteSchedulingDescriptors, getSchedulingDescriptor, getSchedulingDescriptorsByDeviceGroup, getSchedulingDescriptorUserGroupsByDeviceGroup, getSchedulingDescriptorUsersByDeviceGroup, updateSchedulingDescriptor, updateSchedulingDescriptors


getAllServiceManagers

Return a list of all ServiceManager objects.

Synopsis

ServiceManager[] getAllServiceManagers(string authkey)

Parameters

authkey

The user authentication key returned from login().

Return Value

The return value is the list of ServiceManager objects. An exception is thrown if the function fails.

Description

This function returns all ServiceManager objects that the logged-in user can access.

Access Control

This function is restricted to users with the MP Administrator role only.

See Also

createServiceManager, deleteServiceManager, getServiceManager, getServiceManagerByName, getServicesByServiceManager, queryServiceManager, queryServicesByServiceManager, updateServiceManager


getAllServices

Return a list of all Service objects.

Synopsis

Service[] getAllServices(string authkey)

Parameters

authkey

The user authentication key returned from login().

Return Value

The return value is the list of Service objects. An exception is thrown if the function fails.

Description

This function returns all Service objects that the logged-in user can access.

Access Control

This function is restricted to users with the MP Administrator role only.

See Also

createService, createServiceManager, createServices, deleteService, deleteServiceManager, deleteServices, getAllServiceManagers, getService, getServiceManager, getServiceManagerByName, getServicesByServiceManager, queryServiceManager, queryServicesByServiceManager, updateService, updateServiceManager, updateServiceStatus


getAllUserGroups

Return a list of all UserGroup objects.

Synopsis

UserGroup[] getAllUserGroups(string authkey)

Parameters

authkey

The user authentication key returned from login().

Return Value

The return value is the list of UserGroup objects. An exception is thrown if the function fails.

Description

This function returns all UserGroup objects that the logged-in user can access.

Access Control

This function requires that the calling user be a member of the UserGroup.

See Also

addPrivilegesToUserGroup, addPrivilegeToUserGroup, addUsersToUserGroup, addUserToUserGroup, createUserGroup, createUserGroups, deleteUserGroup, deleteUserGroups, getCountUserGroupsByRole, getCountUsersByUserGroup, getPrivilegesByUserGroup, getSchedulingDescriptorUserGroupsByDeviceGroup, getUserGroup, getUserGroupByName, getUserGroupPrivilegesByObject, getUserGroups, getUserGroupsByGuid, getUserGroupsByObjectPrivilege, getUserGroupsByRole, getUserGroupsByUser, getUsersByUserGroup, removePrivilegeFromUserGroup, removePrivilegesFromUserGroup, removeUserFromUserGroup, removeUsersFromUserGroup, setUserGroupPrivileges, setUserGroupUsers, setUserUserGroups, updateUserGroup, updateUserGroups


getAllUsers

Return a list of all User objects.

Synopsis

User[] getAllUsers(string authkey)

Parameters

authkey

The user authentication key returned from login().

Return Value

The return value is the list of User objects. An exception is thrown if the function fails.

Description

This function returns all User objects that the logged-in user can access.

Access Control

This function requires that the calling user have at least one UserGroup membership in common with the User (other than the Everyone group).

See Also

addPrivilegesToUserGroup, addPrivilegeToUserGroup, addUserOrGroupsToObjectPrivilege, addUserOrGroupsToRole, addUserOrGroupToObjectPrivilege, addUserOrGroupToRole, addUsersToUserGroup, addUserToUserGroup, createUser, createUserGroup, createUserGroups, createUsers, deleteUser, deleteUserGroup, deleteUserGroups, deleteUsers, getAllUserGroups, getCountUserGroupsByRole, getCountUsersByRole, getCountUsersByUserGroup, getPrivilegesByUserGroup, getPrivilegesByUserOrGroupObject, getRolesByUserOrGroup, getSchedulingDescriptorUserGroupsByDeviceGroup, getSchedulingDescriptorUsersByDeviceGroup, getTokenInfo, getUser, getUserByName, getUserGroup, getUserGroupByName, getUserGroupPrivilegesByObject, getUserGroups, getUserGroupsByGuid, getUserGroupsByObjectPrivilege, getUserGroupsByRole, getUserGroupsByUser, getUserOrGroupPrivilegesByObject, getUserOrGroupsByObjectPrivilege, getUserOrGroupsByRole, getUserPrivilegesByObject, getUserProfile, getUsers, getUsersByGuid, getUsersByObjectPrivilege, getUsersByRole, getUsersByUserGroup, removePrivilegeFromUserGroup, removePrivilegesFromUserGroup, removeUserFromUserGroup, removeUserOrGroupFromObjectPrivilege, removeUserOrGroupFromRole, removeUserOrGroupsFromObjectPrivilege, removeUserOrGroupsFromRole, removeUsersFromUserGroup, setObjectPrivilegeUserAndGroups, setObjectUserOrGroupPrivileges, setRoleUserAndGroups, setUserGroupPrivileges, setUserGroupUsers, setUserOrGroupRoles, setUserUserGroups, updateUser, updateUserGroup, updateUserGroups, updateUserPassword, updateUserProfile, updateUsers


getApplication

Return a specific Application object.

Synopsis

Application getApplication(string authkey, guid application_gid)

Parameters

authkey

The user authentication key returned from login().

application_gid

The identifier of the Application to be returned.

Return Value

The return value is the requested Application object. An exception is thrown if the function fails.

Description

This function returns a Application object for a specific id.

Access Control

This function requires the calling user have Read Application privileges on the Application.

See Also

addApplicationsToDeviceProfile, addApplicationToDeviceProfile, addProgramsToApplication, addProgramToApplication, createApplication, createApplications, deleteApplication, deleteApplications, getAllApplications, getApplicationByName, getApplications, getApplicationsByDeviceProfile, getApplicationsByGuid, getApplicationsByProgram, getJobsByApplication, getProgramsByApplication, removeApplicationFromDeviceProfile, removeApplicationsFromDeviceProfile, removeProgramFromApplication, removeProgramsFromApplication, setApplicationPrograms, setDeviceProfileApplications, updateApplication, updateApplications


getApplicationByName

Return a specific Application object by name.

Synopsis

Application getApplicationByName(string authkey, string application_name)

Parameters

authkey

The user authentication key returned from login().

application_name

The unique name of the Application to be returned.

Return Value

The return value is the requested Application object. An exception is thrown if the function fails.

Description

This function returns a Application object for a specific name.

Access Control

This function requires the calling user have Read Application privileges on the Application.

See Also

addApplicationsToDeviceProfile, addApplicationToDeviceProfile, addProgramsToApplication, addProgramToApplication, createApplication, createApplications, deleteApplication, deleteApplications, getAllApplications, getApplication, getApplications, getApplicationsByDeviceProfile, getApplicationsByGuid, getApplicationsByProgram, getJobsByApplication, getProgramsByApplication, removeApplicationFromDeviceProfile, removeApplicationsFromDeviceProfile, removeProgramFromApplication, removeProgramsFromApplication, setApplicationPrograms, setDeviceProfileApplications, updateApplication, updateApplications


getApplications

Return a filtered list of Application objects.

Synopsis

ApplicationArrayRange getApplications(string authkey, ApplicationFilter filter, string order, integer start, integer count)

Parameters

authkey

The user authentication key returned from login().

filter

The filter condition that selects which objects will be returned.

order

The sort order in which the objects will be returned.

start

The position in the sorted list to start returning objects. Must be greater than or equal to zero and less than the number of matching elements.

count

The maximum number of objects to return. If this is greater than or equal to 0, then it specifies the maximum number of objects. If this is -1, then the maximum number of objects is unbounded.

Return Value

The return value is the filtered list of Application objects. An exception is thrown if the function fails.

Description

This function returns a filtered list of all Application objects that the logged-in user can access. For further information on filter functions, see Filtering and Paging.

Access Control

This function requires the calling user have Read Application privileges on the Application.

See Also

addApplicationsToDeviceProfile, addApplicationToDeviceProfile, addProgramsToApplication, addProgramToApplication, createApplication, createApplications, deleteApplication, deleteApplications, getAllApplications, getApplication, getApplicationByName, getApplicationsByDeviceProfile, getApplicationsByGuid, getApplicationsByProgram, getJobsByApplication, getProgramsByApplication, removeApplicationFromDeviceProfile, removeApplicationsFromDeviceProfile, removeProgramFromApplication, removeProgramsFromApplication, setApplicationPrograms, setDeviceProfileApplications, updateApplication, updateApplications


getApplicationsByDeviceProfile

Return Application objects associated with a DeviceProfile.

Synopsis

Application[] getApplicationsByDeviceProfile(string authkey, guid device_profile_gid)

Parameters

authkey

The user authentication key returned from login().

device_profile_gid

The identifier of the DeviceProfile objects for which the associated Application objects will be returned.

Return Value

The return value is the requested Application objects. An exception is thrown if the function fails.

Description

This function returns a list of Application objects associated with a DeviceProfile.

Access Control

This function requires the calling user have Read Application privileges on the Application.

See Also

addApplicationsToDeviceProfile, addApplicationToDeviceProfile, getAllApplications, getApplication, getApplicationByName, getApplicationsByGuid, getApplicationsByProgram, removeApplicationFromDeviceProfile, removeApplicationsFromDeviceProfile, setDeviceProfileApplications


getApplicationsByGuid

Return specific Application objects.

Synopsis

Application[] getApplicationsByGuid(string authkey, guid[] application_gids)

Parameters

authkey

The user authentication key returned from login().

application_gids

The ids of the Application objects to be returned.

Return Value

The return value is the requested Application objects. An exception is thrown if the function fails.

Description

This function returns a list of specific Application objects by id.

Access Control

This function requires the calling user have Read Application privileges on the Application.

See Also

addApplicationsToDeviceProfile, addApplicationToDeviceProfile, addProgramsToApplication, addProgramToApplication, createApplication, createApplications, deleteApplication, deleteApplications, getAllApplications, getApplication, getApplicationByName, getApplications, getApplicationsByDeviceProfile, getApplicationsByProgram, getJobsByApplication, getProgramsByApplication, removeApplicationFromDeviceProfile, removeApplicationsFromDeviceProfile, removeProgramFromApplication, removeProgramsFromApplication, setApplicationPrograms, setDeviceProfileApplications, updateApplication, updateApplications


getApplicationsByProgram

Return Application objects associated with a Program.

Synopsis

Application[] getApplicationsByProgram(string authkey, guid program_gid)

Parameters

authkey

The user authentication key returned from login().

program_gid

The identifier of the Program objects for which the associated Application objects will be returned.

Return Value

The return value is the requested Application objects. An exception is thrown if the function fails.

Description

This function returns a list of Application objects associated with a Program.

Access Control

This function requires the calling user have Read Application privileges on the Application.

See Also

addProgramsToApplication, addProgramToApplication, getAllApplications, getApplication, getApplicationByName, getApplicationsByDeviceProfile, getApplicationsByGuid, getProgramsByApplication, removeProgramFromApplication, removeProgramsFromApplication, setApplicationPrograms


getCountDeviceGroupsByAgentVersion

Return the number of DeviceGroups in each AgentVersion.

Synopsis

GuidNameCount[] getCountDeviceGroupsByAgentVersion(string authkey)

Parameters

authkey

The user authentication key returned from login().

Return Value

The return value is the number of DeviceGroups in each AgentVersion. An exception is thrown if the function fails.

Description

Used to determine where different versions of the Agent are running.

Access Control

This function requires the calling user have Read Device Group privileges on the DeviceGroup.

See Also

getCountDevicesByDeviceGroup, getCountDevicesByDeviceProfile, getCountUserGroupsByRole, getCountUsersByRole, getCountUsersByUserGroup


getCountDevicesByDeviceGroup

Return the number of Devices in each DeviceGroup.

Synopsis

GuidNameCount[] getCountDevicesByDeviceGroup(string authkey)

Parameters

authkey

The user authentication key returned from login().

Return Value

The return value is the number of Devices in each DeviceGroup. An exception is thrown if the function fails.

Access Control

This function requires the calling user have Read Device Group privileges on the DeviceGroup.

See Also

addDeviceGroupsToJob, addDeviceGroupToJob, createDeviceGroup, createDeviceGroups, deleteDeviceGroup, deleteDeviceGroups, getAllDeviceGroups, getCountDeviceGroupsByAgentVersion, getCountDevicesByDeviceProfile, getCountUserGroupsByRole, getCountUsersByRole, getCountUsersByUserGroup, getDeviceGroup, getDeviceGroupByName, getDeviceGroups, getDeviceGroupsByGuid, getDeviceGroupsByJob, getDeviceProfilesByDeviceGroup, getDevicesByDeviceGroup, getJobsByDeviceGroup, getSchedulingDescriptorsByDeviceGroup, getSchedulingDescriptorUserGroupsByDeviceGroup, getSchedulingDescriptorUsersByDeviceGroup, getStatsAllDeviceGroups, getStatsDeviceGroup, getStatsDevicesByDeviceGroup, removeDeviceGroupFromJob, removeDeviceGroupsFromJob, setJobDeviceGroups, updateDeviceGroup, updateDeviceGroupRestricted, updateDeviceGroups


getCountDevicesByDeviceProfile

Return the number of Devices in each DeviceProfile for a specific DeviceGroup.

Synopsis

GuidNameCount[] getCountDevicesByDeviceProfile(string authkey, guid device_group_gid)

Parameters

authkey

The user authentication key returned from login().

device_group_gid

The unique identifier of the DeviceGroup to query.

Return Value

The return value is the number of Devices in each DeviceProfile. An exception is thrown if the function fails.

Access Control

This function requires the calling user have Read Device Group privileges on the DeviceGroup.

See Also

addApplicationsToDeviceProfile, addApplicationToDeviceProfile, addProgramsToDeviceProfile, addProgramToDeviceProfile, createDeviceProfile, createDeviceProfiles, deleteDeviceProfile, deleteDeviceProfiles, getAllDeviceProfiles, getApplicationsByDeviceProfile, getCountDeviceGroupsByAgentVersion, getCountDevicesByDeviceGroup, getCountUserGroupsByRole, getCountUsersByRole, getCountUsersByUserGroup, getDeviceProfile, getDeviceProfiles, getDeviceProfilesByDeviceGroup, getDeviceProfilesByGuid, getDevicesByDeviceProfile, getProgramsByDeviceProfile, removeApplicationFromDeviceProfile, removeApplicationsFromDeviceProfile, removeProgramFromDeviceProfile, removeProgramsFromDeviceProfile, setDeviceProfileApplications, setDeviceProfilePrograms, updateDeviceProfile, updateDeviceProfiles


getCountUserGroupsByRole

Return the number of UserGroups in each Role.

Synopsis

GuidNameCount[] getCountUserGroupsByRole(string authkey)

Parameters

authkey

The user authentication key returned from login().

Return Value

The return value is the number of UserGroups in each Role. An exception is thrown if the function fails.

Access Control

This function only counts user groups of which the calling user is a member, or all groups for administrators.

See Also

getCountDeviceGroupsByAgentVersion, getCountDevicesByDeviceGroup, getCountDevicesByDeviceProfile, getCountUsersByRole, getCountUsersByUserGroup, getUserGroupsByRole


getCountUsersByRole

Return the number of Users directly in each Role.

Synopsis

GuidNameCount[] getCountUsersByRole(string authkey)

Parameters

authkey

The user authentication key returned from login().

Return Value

The return value is the number of Users in each Role. An exception is thrown if the function fails.

Description

This function returns the number of Users who are directly associated with each Role. Note that it does not include Users who are indirectly associated with a Role through a UserGroup.

Access Control

This function only counts users who share a group membership (other than Everyone) with the calling user, or all users for administrators.

See Also

addUserOrGroupsToRole, addUserOrGroupToRole, getCountDeviceGroupsByAgentVersion, getCountDevicesByDeviceGroup, getCountDevicesByDeviceProfile, getCountUserGroupsByRole, getCountUsersByUserGroup, getRolesByUserOrGroup, getUserGroupsByRole, getUserOrGroupsByRole, getUsersByRole, removeUserOrGroupFromRole, removeUserOrGroupsFromRole, setRoleUserAndGroups, setUserOrGroupRoles


getCountUsersByUserGroup

Return the number of Users in each UserGroup.

Synopsis

GuidNameCount[] getCountUsersByUserGroup(string authkey)

Parameters

authkey

The user authentication key returned from login().

Return Value

The return value is the number of Users in each UserGroup. An exception is thrown if the function fails.

Access Control

This function requires that the calling user be a member of the UserGroup. The count of users in the special group "Everyone" is only returned for administrators.

See Also

addPrivilegesToUserGroup, addPrivilegeToUserGroup, addUsersToUserGroup, addUserToUserGroup, createUserGroup, createUserGroups, deleteUserGroup, deleteUserGroups, getAllUserGroups, getCountDeviceGroupsByAgentVersion, getCountDevicesByDeviceGroup, getCountDevicesByDeviceProfile, getCountUserGroupsByRole, getCountUsersByRole, getPrivilegesByUserGroup, getSchedulingDescriptorUserGroupsByDeviceGroup, getUserGroup, getUserGroupByName, getUserGroupPrivilegesByObject, getUserGroups, getUserGroupsByGuid, getUserGroupsByObjectPrivilege, getUserGroupsByRole, getUserGroupsByUser, getUsersByUserGroup, removePrivilegeFromUserGroup, removePrivilegesFromUserGroup, removeUserFromUserGroup, removeUsersFromUserGroup, setUserGroupPrivileges, setUserGroupUsers, setUserUserGroups, updateUserGroup, updateUserGroups


getCredential

Return a specific Credential object.

Synopsis

Credential getCredential(string authkey, guid credential_gid)

Parameters

authkey

The user authentication key returned from login().

credential_gid

The identifier of the Credential to be returned.

Return Value

The return value is the requested Credential object. An exception is thrown if the function fails.

Description

This function returns a Credential object for a specific id.

Access Control

This function requires the calling user have Read Device Group privileges on the DeviceGroup.

See Also

createCredential, createCredentials, deleteCredential, deleteCredentials, getAllCredentials, getCredentials, updateCredential, updateCredentials


getCredentials

Return a filtered list of Credential objects.

Synopsis

CredentialArrayRange getCredentials(string authkey, CredentialFilter filter, string order, integer start, integer count)

Parameters

authkey

The user authentication key returned from login().

filter

The filter condition that selects which objects will be returned.

order

The sort order in which the objects will be returned.

start

The position in the sorted list to start returning objects. Must be greater than or equal to zero and less than the number of matching elements.

count

The maximum number of objects to return. If this is greater than or equal to 0, then it specifies the maximum number of objects. If this is -1, then the maximum number of objects is unbounded.

Return Value

The return value is the filtered list of Credential objects. An exception is thrown if the function fails.

Description

This function returns a filtered list of all Credential objects that the logged-in user can access. For further information on filter functions, see Filtering and Paging.

Access Control

This function requires the calling user have Read Device Group privileges on the DeviceGroup.

See Also

createCredential, createCredentials, deleteCredential, deleteCredentials, getAllCredentials, getCredential, updateCredential, updateCredentials


getData

Return a specific Data object.

Synopsis

Data getData(string authkey, guid data_set_gid, integer index)

Parameters

authkey

The user authentication key returned from login().

data_set_gid

The identifier of the DataSet containing the Data.

index

The unique index of the Data in the DataSet.

Return Value

The return value is the requested Data object. An exception is thrown if the function fails.

Description

This function returns a Data object for a specific id.

Access Control

This function requires the calling user have Read Data privileges on the DataSet.

See Also

createData, createDatas, createDataSet, createDataSets, createWorkunitsFromDataSetsAsync, deleteData, deleteDatas, deleteDataSet, deleteDataSets, getAllDataSets, getDatas, getDatasByDataSet, getDatasById, getDatasByWorkunit, getDataSet, getDataSetByName, getDataSets, getDataSetsByGuid, getDataSetsByJobStepWorkunits, getWorkunitsWithDatasByGuid, updateDataSet, updateDataSets


getDatas

Return a filtered list of Data objects.

Synopsis

DataArrayRange getDatas(string authkey, DataFilter filter, string order, integer start, integer count)

Parameters

authkey

The user authentication key returned from login().

filter

The filter condition that selects which objects will be returned.

order

The sort order in which the objects will be returned.

start

The position in the sorted list to start returning objects. Must be greater than or equal to zero and less than the number of matching elements.

count

The maximum number of objects to return. If this is greater than or equal to 0, then it specifies the maximum number of objects. If this is -1, then the maximum number of objects is unbounded.

Return Value

The return value is the filtered list of Data objects. An exception is thrown if the function fails.

Description

This function returns a filtered list of all Data objects that the logged-in user can access. For further information on filter functions, see Filtering and Paging.

Access Control

This function requires the calling user have Read Data privileges on the DataSet.

See Also

createData, createDatas, createDataSet, createDataSets, createWorkunitsFromDataSetsAsync, deleteData, deleteDatas, deleteDataSet, deleteDataSets, getAllDataSets, getData, getDatasByDataSet, getDatasById, getDatasByWorkunit, getDataSet, getDataSetByName, getDataSets, getDataSetsByGuid, getDataSetsByJobStepWorkunits, getWorkunitsWithDatasByGuid, updateDataSet, updateDataSets


getDatasByDataSet

Return Data objects associated with a DataSet.

Synopsis

Data[] getDatasByDataSet(string authkey, guid data_set_gid)

Parameters

authkey

The user authentication key returned from login().

data_set_gid

The identifier of the DataSet object for which the associated Data objects will be returned.

Return Value

The return value is the requested Data objects. An exception is thrown if the function fails.

Description

This function returns the list of Data objects associated with a DataSet.

Access Control

This function requires the calling user have Read Data privileges on the DataSet.

See Also

createDataSet, createDataSets, createWorkunitsFromDataSetsAsync, deleteDataSet, deleteDataSets, getAllDataSets, getData, getDatasById, getDatasByWorkunit, getDataSet, getDataSetByName, getDataSets, getDataSetsByGuid, getDataSetsByJobStepWorkunits, updateDataSet, updateDataSets


getDatasById

Return specific Data objects.

Synopsis

Data[] getDatasById(string authkey, guid data_set_gid, integer[] indexes)

Parameters

authkey

The user authentication key returned from login().

data_set_gid

The primary unique identifier of the DataSet containing the Data objects.

indexes

The indexes of the Data objects to be returned.

Return Value

The return value is the requested Data objects. An exception is thrown if the function fails.

Description

This function returns a list of specific Data objects by id.

Access Control

This function requires the calling user have Read Data privileges on the DataSet.

See Also

createData, createDatas, createDataSet, createDataSets, createWorkunitsFromDataSetsAsync, deleteData, deleteDatas, deleteDataSet, deleteDataSets, getAllDataSets, getData, getDatas, getDatasByDataSet, getDatasByWorkunit, getDataSet, getDataSetByName, getDataSets, getDataSetsByGuid, getDataSetsByJobStepWorkunits, getWorkunitsWithDatasByGuid, updateDataSet, updateDataSets


getDatasByWorkunit

Return Data objects associated with a Workunit.

Synopsis

Data[] getDatasByWorkunit(string authkey, guid workunit_gid)

Parameters

authkey

The user authentication key returned from login().

workunit_gid

The identifier of the Workunit object for which the associated Data objects will be returned.

Return Value

The return value is the requested Data objects. An exception is thrown if the function fails.

Access Control

This function requires the calling user have Read Data privileges on the DataSet.

This function requires the calling user have Read Job privileges on the Job.

See Also

createWorkunitsFromDataSetsAsync, getData, getDatasByDataSet, getDatasById, getDataSetsByJobStepWorkunits, getWorkunitsWithDatasByGuid


getDataSet

Return a specific DataSet object.

Synopsis

DataSet getDataSet(string authkey, guid data_set_gid)

Parameters

authkey

The user authentication key returned from login().

data_set_gid

The identifier of the DataSet to be returned.

Return Value

The return value is the requested DataSet object. An exception is thrown if the function fails.

Description

This function returns a DataSet object for a specific id.

Access Control

This function requires the calling user have Read Data privileges on the DataSet.

See Also

createDataSet, createDataSets, createWorkunitsFromDataSetsAsync, deleteDataSet, deleteDataSets, getAllDataSets, getDatasByDataSet, getDataSetByName, getDataSets, getDataSetsByGuid, getDataSetsByJobStepWorkunits, updateDataSet, updateDataSets


getDataSetByName

Return a specific DataSet object by name.

Synopsis

DataSet getDataSetByName(string authkey, string data_set_name)

Parameters

authkey

The user authentication key returned from login().

data_set_name

The unique name of the DataSet to be returned.

Return Value

The return value is the requested DataSet object. An exception is thrown if the function fails.

Description

This function returns a DataSet object for a specific name.

Access Control

This function requires the calling user have Read Data privileges on the DataSet.

See Also

createDataSet, createDataSets, createWorkunitsFromDataSetsAsync, deleteDataSet, deleteDataSets, getAllDataSets, getDatasByDataSet, getDataSet, getDataSets, getDataSetsByGuid, getDataSetsByJobStepWorkunits, updateDataSet, updateDataSets


getDataSets

Return a filtered list of DataSet objects.

Synopsis

DataSetArrayRange getDataSets(string authkey, DataSetFilter filter, string order, integer start, integer count)

Parameters

authkey

The user authentication key returned from login().

filter

The filter condition that selects which objects will be returned.

order

The sort order in which the objects will be returned.

start

The position in the sorted list to start returning objects. Must be greater than or equal to zero and less than the number of matching elements.

count

The maximum number of objects to return. If this is greater than or equal to 0, then it specifies the maximum number of objects. If this is -1, then the maximum number of objects is unbounded.

Return Value

The return value is the filtered list of DataSet objects. An exception is thrown if the function fails.

Description

This function returns a filtered list of all DataSet objects that the logged-in user can access. For further information on filter functions, see Filtering and Paging.

Access Control

This function requires the calling user have Read Data privileges on the DataSet.

See Also

createDataSet, createDataSets, createWorkunitsFromDataSetsAsync, deleteDataSet, deleteDataSets, getAllDataSets, getDatasByDataSet, getDataSet, getDataSetByName, getDataSetsByGuid, getDataSetsByJobStepWorkunits, updateDataSet, updateDataSets


getDataSetsByGuid

Return specific DataSet objects.

Synopsis

DataSet[] getDataSetsByGuid(string authkey, guid[] data_set_gids)

Parameters

authkey

The user authentication key returned from login().

data_set_gids

The ids of the DataSet objects to be returned.

Return Value

The return value is the requested DataSet objects. An exception is thrown if the function fails.

Description

This function returns a list of specific DataSet objects by id.

Access Control

This function requires the calling user have Read Data privileges on the DataSet.

See Also

createDataSet, createDataSets, createWorkunitsFromDataSetsAsync, deleteDataSet, deleteDataSets, getAllDataSets, getDatasByDataSet, getDataSet, getDataSetByName, getDataSets, getDataSetsByJobStepWorkunits, updateDataSet, updateDataSets


getDataSetsByJobStepWorkunits

Return the DataSet objects associated with automatic Workunit creation for a JobStep via createWorkunitsFromDataSetsAsync.

Synopsis

DataSet[] getDataSetsByJobStepWorkunits(string authkey, guid job_step_gid)

Parameters

authkey

The user authentication key returned from login().

job_step_gid

The id of the JobStep for which DataSet objects will be returned.

Return Value

The return value is the requested DataSet objects. An exception is thrown if the function fails.

Access Control

This function requires the calling user have Read Job privileges on the Job.

This function requires the calling user have Read Data privileges on the DataSet.

See Also

getAllDataSets, getDataSet, getDataSetByName, getDataSetsByGuid


getDevice

Return a specific Device object.

Synopsis

Device getDevice(string authkey, guid device_gid)

Parameters

authkey

The user authentication key returned from login().

device_gid

The identifier of the Device to be returned.

Return Value

The return value is the requested Device object. An exception is thrown if the function fails.

Description

This function returns a Device object for a specific id.

Access Control

This function requires the calling user have Read Device Group privileges on the DeviceGroup.

See Also

addApplicationsToDeviceProfile, addApplicationToDeviceProfile, addDeviceGroupsToJob, addDeviceGroupToJob, addProgramsToDeviceProfile, addProgramToDeviceProfile, cancelDeviceCommands, createDeviceGroup, createDeviceGroups, createDeviceProfile, createDeviceProfiles, deleteDevice, deleteDeviceGroup, deleteDeviceGroups, deleteDeviceProfile, deleteDeviceProfiles, deleteDevices, getAllDeviceGroups, getAllDeviceProfiles, getAllDevices, getApplicationsByDeviceProfile, getCountDeviceGroupsByAgentVersion, getCountDevicesByDeviceGroup, getCountDevicesByDeviceProfile, getDeviceCommands, getDeviceGroup, getDeviceGroupByName, getDeviceGroups, getDeviceGroupsByGuid, getDeviceGroupsByJob, getDeviceProfile, getDeviceProfiles, getDeviceProfilesByDeviceGroup, getDeviceProfilesByGuid, getDevices, getDevicesByDeviceGroup, getDevicesByDeviceProfile, getDevicesByGuid, getDevicesByWorkunit, getJobsByDeviceGroup, getProgramsByDeviceProfile, getResourceAvailablesByDevice, getSchedulingDescriptorsByDeviceGroup, getSchedulingDescriptorUserGroupsByDeviceGroup, getSchedulingDescriptorUsersByDeviceGroup, getStatsAllDeviceGroups, getStatsDevice, getStatsDeviceGroup, getStatsDevicesByDeviceGroup, getStatsJobDevices, moveDevices, removeApplicationFromDeviceProfile, removeApplicationsFromDeviceProfile, removeDeviceGroupFromJob, removeDeviceGroupsFromJob, removeProgramFromDeviceProfile, removeProgramsFromDeviceProfile, sendDeviceCommand, setDeviceProfileApplications, setDeviceProfilePrograms, setJobDeviceGroups, updateDevice, updateDeviceGroup, updateDeviceGroupRestricted, updateDeviceGroups, updateDeviceProfile, updateDeviceProfiles


getDeviceCommands

Return the pending DeviceCommands for a given Device or DeviceGroup.

Synopsis

DeviceCommand[] getDeviceCommands(string authkey, guid device_gid)

Parameters

authkey

The user authentication key returned from login().

device_gid

The identifier of the Device or DeviceGroup for which the DeviceCommands will be returned. If this is the null guid, all outstanding commands for all Devices are returned.

Return Value

The return value is the requested DeviceCommand objects. An exception is thrown if the function fails.

Access Control

If device_gid is the null guid, this function requires the MP Administrator role. If device_gid refers to a device group or device, the calling user must have the ability to manage the device group.

See Also

cancelDeviceCommands, sendDeviceCommand


getDeviceGroup

Return a specific DeviceGroup object.

Synopsis

DeviceGroup getDeviceGroup(string authkey, guid device_group_gid)

Parameters

authkey

The user authentication key returned from login().

device_group_gid

The identifier of the DeviceGroup to be returned.

Return Value

The return value is the requested DeviceGroup object. An exception is thrown if the function fails.

Description

This function returns a DeviceGroup object for a specific id.

Access Control

This function requires the calling user have Read Device Group privileges on the DeviceGroup.

See Also

addDeviceGroupsToJob, addDeviceGroupToJob, createDeviceGroup, createDeviceGroups, deleteDeviceGroup, deleteDeviceGroups, getAllDeviceGroups, getCountDeviceGroupsByAgentVersion, getCountDevicesByDeviceGroup, getDeviceGroupByName, getDeviceGroups, getDeviceGroupsByGuid, getDeviceGroupsByJob, getDeviceProfilesByDeviceGroup, getDevicesByDeviceGroup, getJobsByDeviceGroup, getSchedulingDescriptorsByDeviceGroup, getSchedulingDescriptorUserGroupsByDeviceGroup, getSchedulingDescriptorUsersByDeviceGroup, getStatsAllDeviceGroups, getStatsDeviceGroup, getStatsDevicesByDeviceGroup, removeDeviceGroupFromJob, removeDeviceGroupsFromJob, setJobDeviceGroups, updateDeviceGroup, updateDeviceGroupRestricted, updateDeviceGroups


getDeviceGroupByName

Return a specific DeviceGroup object by name.

Synopsis

DeviceGroup getDeviceGroupByName(string authkey, string device_group_name)

Parameters

authkey

The user authentication key returned from login().

device_group_name

The unique name of the DeviceGroup to be returned.

Return Value

The return value is the requested DeviceGroup object. An exception is thrown if the function fails.

Description

This function returns a DeviceGroup object for a specific name.

Access Control

This function requires the calling user have Read Device Group privileges on the DeviceGroup.

See Also

addDeviceGroupsToJob, addDeviceGroupToJob, createDeviceGroup, createDeviceGroups, deleteDeviceGroup, deleteDeviceGroups, getAllDeviceGroups, getCountDeviceGroupsByAgentVersion, getCountDevicesByDeviceGroup, getDeviceGroup, getDeviceGroups, getDeviceGroupsByGuid, getDeviceGroupsByJob, getDeviceProfilesByDeviceGroup, getDevicesByDeviceGroup, getJobsByDeviceGroup, getSchedulingDescriptorsByDeviceGroup, getSchedulingDescriptorUserGroupsByDeviceGroup, getSchedulingDescriptorUsersByDeviceGroup, getStatsAllDeviceGroups, getStatsDeviceGroup, getStatsDevicesByDeviceGroup, removeDeviceGroupFromJob, removeDeviceGroupsFromJob, setJobDeviceGroups, updateDeviceGroup, updateDeviceGroupRestricted, updateDeviceGroups


getDeviceGroups

Return a filtered list of DeviceGroup objects.

Synopsis

DeviceGroupArrayRange getDeviceGroups(string authkey, DeviceGroupFilter filter, string order, integer start, integer count)

Parameters

authkey

The user authentication key returned from login().

filter

The filter condition that selects which objects will be returned.

order

The sort order in which the objects will be returned.

start

The position in the sorted list to start returning objects. Must be greater than or equal to zero and less than the number of matching elements.

count

The maximum number of objects to return. If this is greater than or equal to 0, then it specifies the maximum number of objects. If this is -1, then the maximum number of objects is unbounded.

Return Value

The return value is the filtered list of DeviceGroup objects. An exception is thrown if the function fails.

Description

This function returns a filtered list of all DeviceGroup objects that the logged-in user can access. For further information on filter functions, see Filtering and Paging.

Access Control

This function requires the calling user have Read Device Group privileges on the DeviceGroup.

See Also

addDeviceGroupsToJob, addDeviceGroupToJob, createDeviceGroup, createDeviceGroups, deleteDeviceGroup, deleteDeviceGroups, getAllDeviceGroups, getCountDeviceGroupsByAgentVersion, getCountDevicesByDeviceGroup, getDeviceGroup, getDeviceGroupByName, getDeviceGroupsByGuid, getDeviceGroupsByJob, getDeviceProfilesByDeviceGroup, getDevicesByDeviceGroup, getJobsByDeviceGroup, getSchedulingDescriptorsByDeviceGroup, getSchedulingDescriptorUserGroupsByDeviceGroup, getSchedulingDescriptorUsersByDeviceGroup, getStatsAllDeviceGroups, getStatsDeviceGroup, getStatsDevicesByDeviceGroup, removeDeviceGroupFromJob, removeDeviceGroupsFromJob, setJobDeviceGroups, updateDeviceGroup, updateDeviceGroupRestricted, updateDeviceGroups


getDeviceGroupsByGuid

Return specific DeviceGroup objects.

Synopsis

DeviceGroup[] getDeviceGroupsByGuid(string authkey, guid[] device_group_gids)

Parameters

authkey

The user authentication key returned from login().

device_group_gids

The ids of the DeviceGroup objects to be returned.

Return Value

The return value is the requested DeviceGroup objects. An exception is thrown if the function fails.

Description

This function returns a list of specific DeviceGroup objects by id.

Access Control

This function requires the calling user have Read Device Group privileges on the DeviceGroup.

See Also

addDeviceGroupsToJob, addDeviceGroupToJob, createDeviceGroup, createDeviceGroups, deleteDeviceGroup, deleteDeviceGroups, getAllDeviceGroups, getCountDeviceGroupsByAgentVersion, getCountDevicesByDeviceGroup, getDeviceGroup, getDeviceGroupByName, getDeviceGroups, getDeviceGroupsByJob, getDeviceProfilesByDeviceGroup, getDevicesByDeviceGroup, getJobsByDeviceGroup, getSchedulingDescriptorsByDeviceGroup, getSchedulingDescriptorUserGroupsByDeviceGroup, getSchedulingDescriptorUsersByDeviceGroup, getStatsAllDeviceGroups, getStatsDeviceGroup, getStatsDevicesByDeviceGroup, removeDeviceGroupFromJob, removeDeviceGroupsFromJob, setJobDeviceGroups, updateDeviceGroup, updateDeviceGroupRestricted, updateDeviceGroups


getDeviceGroupsByJob

Return DeviceGroup objects associated with a Job.

Synopsis

DeviceGroup[] getDeviceGroupsByJob(string authkey, guid job_gid)

Parameters

authkey

The user authentication key returned from login().

job_gid

The identifier of the Job objects for which the associated DeviceGroup objects will be returned.

Return Value

The return value is the requested DeviceGroup objects. An exception is thrown if the function fails.

Description

This function returns a list of DeviceGroup on which a Job can run. The empty list is a special case, and is equivalent to a list of every DeviceGroup in the system.

Access Control

This function requires the calling user have Read Device Group privileges on the DeviceGroup.

See Also

addDeviceGroupsToJob, addDeviceGroupToJob, getAllDeviceGroups, getDeviceGroup, getDeviceGroupByName, getDeviceGroupsByGuid, getJobsByDeviceGroup, removeDeviceGroupFromJob, removeDeviceGroupsFromJob, setJobDeviceGroups


getDeviceProfile

Return a specific DeviceProfile object.

Synopsis

DeviceProfile getDeviceProfile(string authkey, guid device_profile_gid)

Parameters

authkey

The user authentication key returned from login().

device_profile_gid

The identifier of the DeviceProfile to be returned.

Return Value

The return value is the requested DeviceProfile object. An exception is thrown if the function fails.

Description

This function returns a DeviceProfile object for a specific id.

Access Control

This function requires the calling user have Read Device Group privileges on the DeviceGroup.

See Also

addApplicationsToDeviceProfile, addApplicationToDeviceProfile, addProgramsToDeviceProfile, addProgramToDeviceProfile, createDeviceProfile, createDeviceProfiles, deleteDeviceProfile, deleteDeviceProfiles, getAllDeviceProfiles, getApplicationsByDeviceProfile, getCountDevicesByDeviceProfile, getDeviceProfiles, getDeviceProfilesByDeviceGroup, getDeviceProfilesByGuid, getDevicesByDeviceProfile, getProgramsByDeviceProfile, removeApplicationFromDeviceProfile, removeApplicationsFromDeviceProfile, removeProgramFromDeviceProfile, removeProgramsFromDeviceProfile, setDeviceProfileApplications, setDeviceProfilePrograms, updateDeviceProfile, updateDeviceProfiles


getDeviceProfiles

Return a filtered list of DeviceProfile objects.

Synopsis

DeviceProfileArrayRange getDeviceProfiles(string authkey, DeviceProfileFilter filter, string order, integer start, integer count)

Parameters

authkey

The user authentication key returned from login().

filter

The filter condition that selects which objects will be returned.

order

The sort order in which the objects will be returned.

start

The position in the sorted list to start returning objects. Must be greater than or equal to zero and less than the number of matching elements.

count

The maximum number of objects to return. If this is greater than or equal to 0, then it specifies the maximum number of objects. If this is -1, then the maximum number of objects is unbounded.

Return Value

The return value is the filtered list of DeviceProfile objects. An exception is thrown if the function fails.

Description

This function returns a filtered list of all DeviceProfile objects that the logged-in user can access. For further information on filter functions, see Filtering and Paging.

Access Control

This function requires the calling user have Read Device Group privileges on the DeviceGroup.

See Also

addApplicationsToDeviceProfile, addApplicationToDeviceProfile, addProgramsToDeviceProfile, addProgramToDeviceProfile, createDeviceProfile, createDeviceProfiles, deleteDeviceProfile, deleteDeviceProfiles, getAllDeviceProfiles, getApplicationsByDeviceProfile, getCountDevicesByDeviceProfile, getDeviceProfile, getDeviceProfilesByDeviceGroup, getDeviceProfilesByGuid, getDevicesByDeviceProfile, getProgramsByDeviceProfile, removeApplicationFromDeviceProfile, removeApplicationsFromDeviceProfile, removeProgramFromDeviceProfile, removeProgramsFromDeviceProfile, setDeviceProfileApplications, setDeviceProfilePrograms, updateDeviceProfile, updateDeviceProfiles


getDeviceProfilesByDeviceGroup

Return DeviceProfile objects associated with a DeviceGroup.

Synopsis

DeviceProfile[] getDeviceProfilesByDeviceGroup(string authkey, guid device_group_gid)

Parameters

authkey

The user authentication key returned from login().

device_group_gid

The identifier of the DeviceGroup objects for which the associated DeviceProfile objects will be returned.

Return Value

The return value is the requested DeviceProfile objects. An exception is thrown if the function fails.

Description

This function returns a list of DeviceProfile objects associated with a DeviceGroup.

Access Control

This function requires the calling user have Read Device Group privileges on the DeviceGroup.

See Also

getAllDeviceProfiles, getDeviceProfile, getDeviceProfilesByGuid


getDeviceProfilesByGuid

Return specific DeviceProfile objects.

Synopsis

DeviceProfile[] getDeviceProfilesByGuid(string authkey, guid[] device_profile_gids)

Parameters

authkey

The user authentication key returned from login().

device_profile_gids

The ids of the DeviceProfile objects to be returned.

Return Value

The return value is the requested DeviceProfile objects. An exception is thrown if the function fails.

Description

This function returns a list of specific DeviceProfile objects by id.

Access Control

This function requires the calling user have Read Device Group privileges on the DeviceGroup.

See Also

addApplicationsToDeviceProfile, addApplicationToDeviceProfile, addProgramsToDeviceProfile, addProgramToDeviceProfile, createDeviceProfile, createDeviceProfiles, deleteDeviceProfile, deleteDeviceProfiles, getAllDeviceProfiles, getApplicationsByDeviceProfile, getCountDevicesByDeviceProfile, getDeviceProfile, getDeviceProfiles, getDeviceProfilesByDeviceGroup, getDevicesByDeviceProfile, getProgramsByDeviceProfile, removeApplicationFromDeviceProfile, removeApplicationsFromDeviceProfile, removeProgramFromDeviceProfile, removeProgramsFromDeviceProfile, setDeviceProfileApplications, setDeviceProfilePrograms, updateDeviceProfile, updateDeviceProfiles


getDevices

Return a filtered list of Device objects.

Synopsis

DeviceArrayRange getDevices(string authkey, DeviceFilter filter, string order, integer start, integer count)

Parameters

authkey

The user authentication key returned from login().

filter

The filter condition that selects which objects will be returned.

order

The sort order in which the objects will be returned.

start

The position in the sorted list to start returning objects. Must be greater than or equal to zero and less than the number of matching elements.

count

The maximum number of objects to return. If this is greater than or equal to 0, then it specifies the maximum number of objects. If this is -1, then the maximum number of objects is unbounded.

Return Value

The return value is the filtered list of Device objects. An exception is thrown if the function fails.

Description

This function returns a filtered list of all Device objects that the logged-in user can access. For further information on filter functions, see Filtering and Paging.

Access Control

This function requires the calling user have Read Device Group privileges on the DeviceGroup.

See Also

addApplicationsToDeviceProfile, addApplicationToDeviceProfile, addDeviceGroupsToJob, addDeviceGroupToJob, addProgramsToDeviceProfile, addProgramToDeviceProfile, cancelDeviceCommands, createDeviceGroup, createDeviceGroups, createDeviceProfile, createDeviceProfiles, deleteDevice, deleteDeviceGroup, deleteDeviceGroups, deleteDeviceProfile, deleteDeviceProfiles, deleteDevices, getAllDeviceGroups, getAllDeviceProfiles, getAllDevices, getApplicationsByDeviceProfile, getCountDeviceGroupsByAgentVersion, getCountDevicesByDeviceGroup, getCountDevicesByDeviceProfile, getDevice, getDeviceCommands, getDeviceGroup, getDeviceGroupByName, getDeviceGroups, getDeviceGroupsByGuid, getDeviceGroupsByJob, getDeviceProfile, getDeviceProfiles, getDeviceProfilesByDeviceGroup, getDeviceProfilesByGuid, getDevicesByDeviceGroup, getDevicesByDeviceProfile, getDevicesByGuid, getDevicesByWorkunit, getJobsByDeviceGroup, getProgramsByDeviceProfile, getResourceAvailablesByDevice, getSchedulingDescriptorsByDeviceGroup, getSchedulingDescriptorUserGroupsByDeviceGroup, getSchedulingDescriptorUsersByDeviceGroup, getStatsAllDeviceGroups, getStatsDevice, getStatsDeviceGroup, getStatsDevicesByDeviceGroup, getStatsJobDevices, moveDevices, removeApplicationFromDeviceProfile, removeApplicationsFromDeviceProfile, removeDeviceGroupFromJob, removeDeviceGroupsFromJob, removeProgramFromDeviceProfile, removeProgramsFromDeviceProfile, sendDeviceCommand, setDeviceProfileApplications, setDeviceProfilePrograms, setJobDeviceGroups, updateDevice, updateDeviceGroup, updateDeviceGroupRestricted, updateDeviceGroups, updateDeviceProfile, updateDeviceProfiles


getDevicesByDeviceGroup

Return Device objects associated with a DeviceGroup.

Synopsis

Device[] getDevicesByDeviceGroup(string authkey, guid device_group_gid)

Parameters

authkey

The user authentication key returned from login().

device_group_gid

The identifier of the DeviceGroup objects for which the associated Device objects will be returned.

Return Value

The return value is the requested Device objects. An exception is thrown if the function fails.

Description

This function returns a list of Device objects associated with a DeviceGroup.

Access Control

This function requires the calling user have Read Device Group privileges on the DeviceGroup.

See Also

addDeviceGroupsToJob, addDeviceGroupToJob, createDeviceGroup, createDeviceGroups, deleteDeviceGroup, deleteDeviceGroups, getAllDeviceGroups, getAllDevices, getCountDeviceGroupsByAgentVersion, getCountDevicesByDeviceGroup, getDevice, getDeviceGroup, getDeviceGroupByName, getDeviceGroups, getDeviceGroupsByGuid, getDeviceGroupsByJob, getDeviceProfilesByDeviceGroup, getDevicesByDeviceProfile, getDevicesByGuid, getDevicesByWorkunit, getJobsByDeviceGroup, getSchedulingDescriptorsByDeviceGroup, getSchedulingDescriptorUserGroupsByDeviceGroup, getSchedulingDescriptorUsersByDeviceGroup, getStatsAllDeviceGroups, getStatsDeviceGroup, getStatsDevicesByDeviceGroup, removeDeviceGroupFromJob, removeDeviceGroupsFromJob, setJobDeviceGroups, updateDeviceGroup, updateDeviceGroupRestricted, updateDeviceGroups


getDevicesByDeviceProfile

Return Device objects associated with a DeviceProfile.

Synopsis

Device[] getDevicesByDeviceProfile(string authkey, guid device_profile_gid)

Parameters

authkey

The user authentication key returned from login().

device_profile_gid

The identifier of the DeviceProfile objects for which the associated Device objects will be returned.

Return Value

The return value is the requested Device objects. An exception is thrown if the function fails.

Description

This function returns a list of Device objects associated with a DeviceProfile.

Access Control

This function requires the calling user have Read Device Group privileges on the DeviceGroup.

See Also

addApplicationsToDeviceProfile, addApplicationToDeviceProfile, addProgramsToDeviceProfile, addProgramToDeviceProfile, createDeviceProfile, createDeviceProfiles, deleteDeviceProfile, deleteDeviceProfiles, getAllDeviceProfiles, getAllDevices, getApplicationsByDeviceProfile, getCountDevicesByDeviceProfile, getDevice, getDeviceProfile, getDeviceProfiles, getDeviceProfilesByDeviceGroup, getDeviceProfilesByGuid, getDevicesByDeviceGroup, getDevicesByGuid, getDevicesByWorkunit, getProgramsByDeviceProfile, removeApplicationFromDeviceProfile, removeApplicationsFromDeviceProfile, removeProgramFromDeviceProfile, removeProgramsFromDeviceProfile, setDeviceProfileApplications, setDeviceProfilePrograms, updateDeviceProfile, updateDeviceProfiles


getDevicesByGuid

Return specific Device objects.

Synopsis

Device[] getDevicesByGuid(string authkey, guid[] device_gids)

Parameters

authkey

The user authentication key returned from login().

device_gids

The ids of the Device objects to be returned.

Return Value

The return value is the requested Device objects. An exception is thrown if the function fails.

Description

This function returns a list of specific Device objects by id.

Access Control

This function requires the calling user have Read Device Group privileges on the DeviceGroup.

See Also

addApplicationsToDeviceProfile, addApplicationToDeviceProfile, addDeviceGroupsToJob, addDeviceGroupToJob, addProgramsToDeviceProfile, addProgramToDeviceProfile, cancelDeviceCommands, createDeviceGroup, createDeviceGroups, createDeviceProfile, createDeviceProfiles, deleteDevice, deleteDeviceGroup, deleteDeviceGroups, deleteDeviceProfile, deleteDeviceProfiles, deleteDevices, getAllDeviceGroups, getAllDeviceProfiles, getAllDevices, getApplicationsByDeviceProfile, getCountDeviceGroupsByAgentVersion, getCountDevicesByDeviceGroup, getCountDevicesByDeviceProfile, getDevice, getDeviceCommands, getDeviceGroup, getDeviceGroupByName, getDeviceGroups, getDeviceGroupsByGuid, getDeviceGroupsByJob, getDeviceProfile, getDeviceProfiles, getDeviceProfilesByDeviceGroup, getDeviceProfilesByGuid, getDevices, getDevicesByDeviceGroup, getDevicesByDeviceProfile, getDevicesByWorkunit, getJobsByDeviceGroup, getProgramsByDeviceProfile, getResourceAvailablesByDevice, getSchedulingDescriptorsByDeviceGroup, getSchedulingDescriptorUserGroupsByDeviceGroup, getSchedulingDescriptorUsersByDeviceGroup, getStatsAllDeviceGroups, getStatsDevice, getStatsDeviceGroup, getStatsDevicesByDeviceGroup, getStatsJobDevices, moveDevices, removeApplicationFromDeviceProfile, removeApplicationsFromDeviceProfile, removeDeviceGroupFromJob, removeDeviceGroupsFromJob, removeProgramFromDeviceProfile, removeProgramsFromDeviceProfile, sendDeviceCommand, setDeviceProfileApplications, setDeviceProfilePrograms, setJobDeviceGroups, updateDevice, updateDeviceGroup, updateDeviceGroupRestricted, updateDeviceGroups, updateDeviceProfile, updateDeviceProfiles


getDevicesByWorkunit

Return the Devices that are currently working on a given Workunit.

Synopsis

Device[] getDevicesByWorkunit(string authkey, guid workunit_gid)

Parameters

authkey

The user authentication key returned from login().

workunit_gid

The id of the Workunit for which Devices will be returned.

Return Value

The return value is the requested Device objects. An exception is thrown if the function fails.

Access Control

This function requires the calling user have Read Device Group privileges on the DeviceGroup.

See Also

getAllDevices, getDevice, getDevicesByDeviceGroup, getDevicesByDeviceProfile, getDevicesByGuid


getErrors

Return a filtered list of Error objects.

Synopsis

ErrorArrayRange getErrors(string authkey, ErrorFilter filter, string order, integer start, integer count)

Parameters

authkey

The user authentication key returned from login().

filter

The filter condition that selects which objects will be returned.

order

The sort order in which the objects will be returned.

start

The position in the sorted list to start returning objects. Must be greater than or equal to zero and less than the number of matching elements.

count

The maximum number of objects to return. If this is greater than or equal to 0, then it specifies the maximum number of objects. If this is -1, then the maximum number of objects is unbounded.

Return Value

The return value is the filtered list of Error objects. An exception is thrown if the function fails.

Description

This function returns a filtered list of all Error objects that the logged-in user can access. For further information on filter functions, see Filtering and Paging.

Access Control

This function has no specific access control requirements.

See Also

deleteErrors


getGlobalResource

Return a specific GlobalResource object.

Synopsis

GlobalResource getGlobalResource(string authkey, guid global_resource_gid)

Parameters

authkey

The user authentication key returned from login().

global_resource_gid

The identifier of the GlobalResource to be returned.

Return Value

The return value is the requested GlobalResource object. An exception is thrown if the function fails.

Description

This function returns a GlobalResource object for a specific id.

Access Control

This function requires the calling user have Read Resource privileges on the GlobalResource.

See Also

createGlobalResource, createGlobalResources, deleteGlobalResource, deleteGlobalResourceRequirement, deleteGlobalResources, getAllGlobalResourceRequirements, getAllGlobalResources, getGlobalResourceByName, getGlobalResourceRequirementsByGlobalResource, getGlobalResourceRequirementsByProgramModule, getGlobalResources, setGlobalResourceRequirement, setGlobalResourceRequirements, updateGlobalResource, updateGlobalResources


getGlobalResourceByName

Return a specific GlobalResource object by its name.

Synopsis

GlobalResource getGlobalResourceByName(string authkey, string global_resource_name)

Parameters

authkey

The user authentication key returned from login().

global_resource_name

The name of the GlobalResource to be returned.

Return Value

The return value is the requested GlobalResource object. An exception is thrown if the function fails.

Description

This function returns a GlobalResource object for a specific id.

Access Control

This function requires the calling user have Read Resource privileges on the GlobalResource.

See Also

createGlobalResource, createGlobalResources, deleteGlobalResource, deleteGlobalResourceRequirement, deleteGlobalResources, getAllGlobalResourceRequirements, getAllGlobalResources, getGlobalResource, getGlobalResourceRequirementsByGlobalResource, getGlobalResourceRequirementsByProgramModule, getGlobalResources, setGlobalResourceRequirement, setGlobalResourceRequirements, updateGlobalResource, updateGlobalResources


getGlobalResourceRequirementsByGlobalResource

Return GlobalResourceRequirement objects associated with a GlobalResource.

Synopsis

GlobalResourceRequirement[] getGlobalResourceRequirementsByGlobalResource(string authkey, guid global_resource_gid)

Parameters

authkey

The user authentication key returned from login().

global_resource_gid

The identifier of the GlobalResource objects for which the associated GlobalResourceRequirement objects will be returned.

Return Value

The return value is the requested GlobalResourceRequirement objects. An exception is thrown if the function fails.

Description

This function returns a list of GlobalResourceRequirement objects associated with a GlobalResource.

Access Control

This function requires the calling user have Read Resource privileges on the GlobalResource.

See Also

deleteGlobalResourceRequirement, getAllGlobalResourceRequirements, getGlobalResourceRequirementsByProgramModule, setGlobalResourceRequirement, setGlobalResourceRequirements


getGlobalResourceRequirementsByProgramModule

Return GlobalResourceRequirement objects associated with a ProgramModule.

Synopsis

GlobalResourceRequirement[] getGlobalResourceRequirementsByProgramModule(string authkey, guid program_module_gid)

Parameters

authkey

The user authentication key returned from login().

program_module_gid

The identifier of the ProgramModule object for which the associated GlobalResourceRequirement objects will be returned.

Return Value

The return value is the requested GlobalResourceRequirement objects. An exception is thrown if the function fails.

Description

This function returns a list of GlobalResourceRequirement objects associated with a ProgramModule.

Access Control

This function requires the calling user have Read Program privileges on the Program.

See Also

getAllGlobalResourceRequirements, getGlobalResourceRequirementsByGlobalResource


getGlobalResources

Return a filtered list of GlobalResource objects.

Synopsis

GlobalResourceArrayRange getGlobalResources(string authkey, GlobalResourceFilter filter, string order, integer start, integer count)

Parameters

authkey

The user authentication key returned from login().

filter

The filter condition that selects which objects will be returned.

order

The sort order in which the objects will be returned.

start

The position in the sorted list to start returning objects. Must be greater than or equal to zero and less than the number of matching elements.

count

The maximum number of objects to return. If this is greater than or equal to 0, then it specifies the maximum number of objects. If this is -1, then the maximum number of objects is unbounded.

Return Value

The return value is the filtered list of GlobalResource objects. An exception is thrown if the function fails.

Description

This function returns a filtered list of all GlobalResource objects that the logged-in user can access. For further information on filter functions, see Filtering and Paging.

Access Control

This function requires the calling user have Read Resource privileges on the GlobalResource.

See Also

createGlobalResource, createGlobalResources, deleteGlobalResource, deleteGlobalResourceRequirement, deleteGlobalResources, getAllGlobalResourceRequirements, getAllGlobalResources, getGlobalResource, getGlobalResourceByName, getGlobalResourceRequirementsByGlobalResource, getGlobalResourceRequirementsByProgramModule, setGlobalResourceRequirement, setGlobalResourceRequirements, updateGlobalResource, updateGlobalResources


getJob

Return a specific Job object.

Synopsis

Job getJob(string authkey, guid job_gid)

Parameters

authkey

The user authentication key returned from login().

job_gid

The identifier of the Job to be returned.

Return Value

The return value is the requested Job object. An exception is thrown if the function fails.

Description

This function returns a Job object for a specific id.

Access Control

This function requires the calling user have Read Job privileges on the Job.

See Also

addDeviceGroupsToJob, addDeviceGroupToJob, createJob, createJob2, createJobs, createJobStep, createJobSteps, createJobStepsWithResourceRequirements, createJobStepWithResourceRequirements, deleteJob, deleteJobs, deleteJobStep, deleteJobSteps, getAllJobs, getDataSetsByJobStepWorkunits, getDeviceGroupsByJob, getJobById, getJobs, getJobsByApplication, getJobsByDeviceGroup, getJobsByGuid, getJobStatus, getJobStatusesByGuid, getJobStep, getJobSteps, getJobStepsByGuid, getJobStepsByJob, getJobStepsByProgram, getJobStepStatus, getProgramModuleVersionsByJobStep, getResourceRequirementsByJobStep, getResultsByJobStep, getStatsAllJobStates, getStatsJobDevices, getWorkunitsByJobStep, getWorkunitStatesByJobStep, removeDeviceGroupFromJob, removeDeviceGroupsFromJob, setJobDeviceGroups, updateJob, updateJobs, updateJobStep, updateJobSteps


getJobById

Return a specific Job object.

Synopsis

Job getJobById(string authkey, integer job_id)

Parameters

authkey

The user authentication key returned from login().

job_id

The identifier of the Job to be returned.

Return Value

The return value is the requested Job object. An exception is thrown if the function fails.

Description

This function returns a Job object for a specific id.

Access Control

This function requires the calling user have Read Job privileges on the Job.

See Also

addDeviceGroupsToJob, addDeviceGroupToJob, createJob, createJob2, createJobs, createJobStep, createJobSteps, createJobStepsWithResourceRequirements, createJobStepWithResourceRequirements, deleteJob, deleteJobs, deleteJobStep, deleteJobSteps, getAllJobs, getDataSetsByJobStepWorkunits, getDeviceGroupsByJob, getJob, getJobs, getJobsByApplication, getJobsByDeviceGroup, getJobsByGuid, getJobStatus, getJobStatusesByGuid, getJobStep, getJobSteps, getJobStepsByGuid, getJobStepsByJob, getJobStepsByProgram, getJobStepStatus, getProgramModuleVersionsByJobStep, getResourceRequirementsByJobStep, getResultsByJobStep, getStatsAllJobStates, getStatsJobDevices, getWorkunitsByJobStep, getWorkunitStatesByJobStep, removeDeviceGroupFromJob, removeDeviceGroupsFromJob, setJobDeviceGroups, updateJob, updateJobs, updateJobStep, updateJobSteps


getJobs

Return a filtered list of Job objects.

Synopsis

JobArrayRange getJobs(string authkey, JobFilter filter, string order, integer start, integer count)

Parameters

authkey

The user authentication key returned from login().

filter

The filter condition that selects which objects will be returned.

order

The sort order in which the objects will be returned.

start

The position in the sorted list to start returning objects. Must be greater than or equal to zero and less than the number of matching elements.

count

The maximum number of objects to return. If this is greater than or equal to 0, then it specifies the maximum number of objects. If this is -1, then the maximum number of objects is unbounded.

Return Value

The return value is the filtered list of Job objects. An exception is thrown if the function fails.

Description

This function returns a filtered list of all Job objects that the logged-in user can access. For further information on filter functions, see Filtering and Paging.

Access Control

This function requires the calling user have Read Job privileges on the Job.

See Also

addDeviceGroupsToJob, addDeviceGroupToJob, createJob, createJob2, createJobs, createJobStep, createJobSteps, createJobStepsWithResourceRequirements, createJobStepWithResourceRequirements, deleteJob, deleteJobs, deleteJobStep, deleteJobSteps, getAllJobs, getDataSetsByJobStepWorkunits, getDeviceGroupsByJob, getJob, getJobById, getJobsByApplication, getJobsByDeviceGroup, getJobsByGuid, getJobStatus, getJobStatusesByGuid, getJobStep, getJobSteps, getJobStepsByGuid, getJobStepsByJob, getJobStepsByProgram, getJobStepStatus, getProgramModuleVersionsByJobStep, getResourceRequirementsByJobStep, getResultsByJobStep, getStatsAllJobStates, getStatsJobDevices, getWorkunitsByJobStep, getWorkunitStatesByJobStep, removeDeviceGroupFromJob, removeDeviceGroupsFromJob, setJobDeviceGroups, updateJob, updateJobs, updateJobStep, updateJobSteps


getJobsByApplication

Return Job objects associated with a Application.

Synopsis

Job[] getJobsByApplication(string authkey, guid application_gid)

Parameters

authkey

The user authentication key returned from login().

application_gid

The identifier of the Application objects for which the associated Job objects will be returned.

Return Value

The return value is the requested Job objects. An exception is thrown if the function fails.

Description

This function returns a list of Job objects associated with a Application.

Access Control

This function requires the calling user have Read Job privileges on the Job.

See Also

getAllJobs, getJob, getJobById, getJobsByDeviceGroup, getJobsByGuid


getJobsByDeviceGroup

Return Job objects associated with a DeviceGroup.

Synopsis

Job[] getJobsByDeviceGroup(string authkey, guid device_group_gid)

Parameters

authkey

The user authentication key returned from login().

device_group_gid

The identifier of the DeviceGroup objects for which the associated Job objects will be returned.

Return Value

The return value is the requested Job objects. An exception is thrown if the function fails.

Description

This function returns a list of Job objects associated with a DeviceGroup.

Access Control

This function requires the calling user have Read Job privileges on the Job.

See Also

addDeviceGroupsToJob, addDeviceGroupToJob, getAllJobs, getDeviceGroupsByJob, getJob, getJobById, getJobsByApplication, getJobsByGuid, removeDeviceGroupFromJob, removeDeviceGroupsFromJob, setJobDeviceGroups


getJobsByGuid

Return specific Job objects.

Synopsis

Job[] getJobsByGuid(string authkey, guid[] job_gids)

Parameters

authkey

The user authentication key returned from login().

job_gids

The ids of the Job objects to be returned.

Return Value

The return value is the requested Job objects. An exception is thrown if the function fails.

Description

This function returns a list of specific Job objects by id.

Access Control

This function requires the calling user have Read Job privileges on the Job.

See Also

addDeviceGroupsToJob, addDeviceGroupToJob, createJob, createJob2, createJobs, createJobStep, createJobSteps, createJobStepsWithResourceRequirements, createJobStepWithResourceRequirements, deleteJob, deleteJobs, deleteJobStep, deleteJobSteps, getAllJobs, getDataSetsByJobStepWorkunits, getDeviceGroupsByJob, getJob, getJobById, getJobs, getJobsByApplication, getJobsByDeviceGroup, getJobStatus, getJobStatusesByGuid, getJobStep, getJobSteps, getJobStepsByGuid, getJobStepsByJob, getJobStepsByProgram, getJobStepStatus, getProgramModuleVersionsByJobStep, getResourceRequirementsByJobStep, getResultsByJobStep, getStatsAllJobStates, getStatsJobDevices, getWorkunitsByJobStep, getWorkunitStatesByJobStep, removeDeviceGroupFromJob, removeDeviceGroupsFromJob, setJobDeviceGroups, updateJob, updateJobs, updateJobStep, updateJobSteps


getJobStatus

Return a JobStatus object describing the state of a Job.

Synopsis

JobStatus getJobStatus(string authkey, guid job_gid)

Parameters

authkey

The user authentication key returned from login().

job_gid

The identifier of the Job to query.

Return Value

The return value is the requested JobStatus object. An exception is thrown if the requested object is not found.

Description

This function returns a JobStatus object that describes the state of a Job.

Access Control

This function requires the calling user have Read Job privileges on the Job.

See Also

getJobStatusesByGuid


getJobStatusesByGuid

Return specific JobStatus objects.

Synopsis

JobStatus[] getJobStatusesByGuid(string authkey, guid[] job_gids)

Parameters

authkey

The user authentication key returned from login().

job_gids

The ids of the JobStatus objects to be returned.

Return Value

The return value is the requested JobStatus objects. An exception is thrown if the function fails.

Description

This function returns a list of specific JobStatus objects by id.

Access Control

This function requires the calling user have Read Job privileges on the Job.

See Also

getJobStatus


getJobStep

Return a specific JobStep object.

Synopsis

JobStep getJobStep(string authkey, guid job_step_gid)

Parameters

authkey

The user authentication key returned from login().

job_step_gid

The identifier of the JobStep to be returned.

Return Value

The return value is the requested JobStep object. An exception is thrown if the function fails.

Description

This function returns a JobStep object for a specific id.

Access Control

This function requires the calling user have Read Job privileges on the Job.

See Also

createJobStep, createJobSteps, createJobStepsWithResourceRequirements, createJobStepWithResourceRequirements, deleteJobStep, deleteJobSteps, getDataSetsByJobStepWorkunits, getJobSteps, getJobStepsByGuid, getJobStepsByJob, getJobStepsByProgram, getJobStepStatus, getProgramModuleVersionsByJobStep, getResourceRequirementsByJobStep, getResultsByJobStep, getWorkunitsByJobStep, getWorkunitStatesByJobStep, updateJobStep, updateJobSteps


getJobSteps

Return a filtered list of JobStep objects.

Synopsis

JobStepArrayRange getJobSteps(string authkey, JobStepFilter filter, string order, integer start, integer count)

Parameters

authkey

The user authentication key returned from login().

filter

The filter condition that selects which objects will be returned.

order

The sort order in which the objects will be returned.

start

The position in the sorted list to start returning objects. Must be greater than or equal to zero and less than the number of matching elements.

count

The maximum number of objects to return. If this is greater than or equal to 0, then it specifies the maximum number of objects. If this is -1, then the maximum number of objects is unbounded.

Return Value

The return value is the filtered list of JobStep objects. An exception is thrown if the function fails.

Description

This function returns a filtered list of all JobStep objects that the logged-in user can access. For further information on filter functions, see Filtering and Paging.

Access Control

This function requires the calling user have Read Job privileges on the Job.

See Also

createJobStep, createJobSteps, createJobStepsWithResourceRequirements, createJobStepWithResourceRequirements, deleteJobStep, deleteJobSteps, getDataSetsByJobStepWorkunits, getJobStep, getJobStepsByGuid, getJobStepsByJob, getJobStepsByProgram, getJobStepStatus, getProgramModuleVersionsByJobStep, getResourceRequirementsByJobStep, getResultsByJobStep, getWorkunitsByJobStep, getWorkunitStatesByJobStep, updateJobStep, updateJobSteps


getJobStepsByGuid

Return specific JobStep objects.

Synopsis

JobStep[] getJobStepsByGuid(string authkey, guid[] job_step_gids)

Parameters

authkey

The user authentication key returned from login().

job_step_gids

The ids of the JobStep objects to be returned.

Return Value

The return value is the requested JobStep objects. An exception is thrown if the function fails.

Description

This function returns a list of specific JobStep objects by id.

Access Control

This function requires the calling user have Read Job privileges on the Job.

See Also

createJobStep, createJobSteps, createJobStepsWithResourceRequirements, createJobStepWithResourceRequirements, deleteJobStep, deleteJobSteps, getDataSetsByJobStepWorkunits, getJobStep, getJobSteps, getJobStepsByJob, getJobStepsByProgram, getJobStepStatus, getProgramModuleVersionsByJobStep, getResourceRequirementsByJobStep, getResultsByJobStep, getWorkunitsByJobStep, getWorkunitStatesByJobStep, updateJobStep, updateJobSteps


getJobStepsByJob

Return JobStep objects associated with a Job.

Synopsis

JobStep[] getJobStepsByJob(string authkey, guid job_gid)

Parameters

authkey

The user authentication key returned from login().

job_gid

The identifier of the Job objects for which the associated JobStep objects will be returned.

Return Value

The return value is the requested JobStep objects. An exception is thrown if the function fails.

Description

This function returns a list of JobStep objects associated with a Job.

Access Control

This function requires the calling user have Read Job privileges on the Job.

See Also

createJobStep, createJobSteps, createJobStepsWithResourceRequirements, createJobStepWithResourceRequirements, deleteJobStep, deleteJobSteps, getDataSetsByJobStepWorkunits, getJobStep, getJobSteps, getJobStepsByGuid, getJobStepsByProgram, getJobStepStatus, getProgramModuleVersionsByJobStep, getResourceRequirementsByJobStep, getResultsByJobStep, getWorkunitsByJobStep, getWorkunitStatesByJobStep, updateJobStep, updateJobSteps


getJobStepsByProgram

Return JobStep objects associated with a Program.

Synopsis

JobStep[] getJobStepsByProgram(string authkey, guid program_gid)

Parameters

authkey

The user authentication key returned from login().

program_gid

The identifier of the Program objects for which the associated JobStep objects will be returned.

Return Value

The return value is the requested JobStep objects. An exception is thrown if the function fails.

Description

This function returns a list of JobStep objects associated with a Program.

Access Control

This function requires the calling user have Read Job privileges on the Job.

See Also

getJobStep, getJobStepsByGuid, getJobStepsByJob, getProgramModuleVersionsByJobStep


getJobStepStatus

Return a JobStepStatus object describing the state of a JobStep.

Synopsis

JobStepStatus getJobStepStatus(string authkey, guid job_step_gid)

Parameters

authkey

The user authentication key returned from login().

job_step_gid

The identifier of the JobStep to query.

Return Value

The return value is the requested JobStepStatus object. An exception is thrown if the requested object is not found.

Description

This function returns a JobStepStatus object that describes the state of a JobStep.

Access Control

This function requires the calling user have Read Job privileges on the Job.


getPlatform

Return a specific Platform object.

Synopsis

Platform getPlatform(string authkey, integer platform_id)

Parameters

authkey

The user authentication key returned from login().

platform_id

The identifier of the Platform to be returned.

Return Value

The return value is the requested Platform object. An exception is thrown if the function fails.

Description

This function returns a Platform object for a specific id.

Access Control

This function has no specific access control requirements.

See Also

getAgentModuleByAgentVersionPlatform, getAllPlatforms, getPlatformByName, getPlatformsById


getPlatformByName

Return a specific Platform object by name.

Synopsis

Platform getPlatformByName(string authkey, string platform_name)

Parameters

authkey

The user authentication key returned from login().

platform_name

The unique name of the Platform to be returned.

Return Value

The return value is the requested Platform object. An exception is thrown if the function fails.

Description

This function returns a Platform object for a specific name.

Access Control

This function has no specific access control requirements.

See Also

getAgentModuleByAgentVersionPlatform, getAllPlatforms, getPlatform, getPlatformsById


getPlatformsById

Return specific Platform objects.

Synopsis

Platform[] getPlatformsById(string authkey, integer[] platform_ids)

Parameters

authkey

The user authentication key returned from login().

platform_ids

The ids of the Platform objects to be returned.

Return Value

The return value is the requested Platform objects. An exception is thrown if the function fails.

Description

This function returns a list of specific Platform objects by id.

Access Control

This function has no specific access control requirements.

See Also

getAgentModuleByAgentVersionPlatform, getAllPlatforms, getPlatform, getPlatformByName


getPrivilege

Return a specific Privilege object.

Synopsis

Privilege getPrivilege(string authkey, guid privilege_gid)

Parameters

authkey

The user authentication key returned from login().

privilege_gid

The identifier of the Privilege to be returned.

Return Value

The return value is the requested Privilege object. An exception is thrown if the function fails.

Description

This function returns a Privilege object for a specific id.

Access Control

This function has no specific access control requirements.

See Also

addPrivilegesToUserGroup, addPrivilegeToUserGroup, addUserOrGroupsToObjectPrivilege, addUserOrGroupToObjectPrivilege, getAllPrivileges, getPrivilegeByName, getPrivileges, getPrivilegesByGuid, getPrivilegesByUserGroup, getPrivilegesByUserOrGroupObject, getUserGroupPrivilegesByObject, getUserGroupsByObjectPrivilege, getUserOrGroupPrivilegesByObject, getUserOrGroupsByObjectPrivilege, getUserPrivilegesByObject, getUsersByObjectPrivilege, removePrivilegeFromUserGroup, removePrivilegesFromUserGroup, removeUserOrGroupFromObjectPrivilege, removeUserOrGroupsFromObjectPrivilege, setObjectPrivilegeUserAndGroups, setObjectUserOrGroupPrivileges, setUserGroupPrivileges


getPrivilegeByName

Return a specific Privilege object by name.

Synopsis

Privilege getPrivilegeByName(string authkey, string privilege_name)

Parameters

authkey

The user authentication key returned from login().

privilege_name

The unique name of the Privilege to be returned.

Return Value

The return value is the requested Privilege object. An exception is thrown if the function fails.

Description

This function returns a Privilege object for a specific name.

Access Control

This function has no specific access control requirements.

See Also

addPrivilegesToUserGroup, addPrivilegeToUserGroup, addUserOrGroupsToObjectPrivilege, addUserOrGroupToObjectPrivilege, getAllPrivileges, getPrivilege, getPrivileges, getPrivilegesByGuid, getPrivilegesByUserGroup, getPrivilegesByUserOrGroupObject, getUserGroupPrivilegesByObject, getUserGroupsByObjectPrivilege, getUserOrGroupPrivilegesByObject, getUserOrGroupsByObjectPrivilege, getUserPrivilegesByObject, getUsersByObjectPrivilege, removePrivilegeFromUserGroup, removePrivilegesFromUserGroup, removeUserOrGroupFromObjectPrivilege, removeUserOrGroupsFromObjectPrivilege, setObjectPrivilegeUserAndGroups, setObjectUserOrGroupPrivileges, setUserGroupPrivileges


getPrivileges

Return a filtered list of Privilege objects.

Synopsis

PrivilegeArrayRange getPrivileges(string authkey, PrivilegeFilter filter, string order, integer start, integer count)

Parameters

authkey

The user authentication key returned from login().

filter

The filter condition that selects which objects will be returned.

order

The sort order in which the objects will be returned.

start

The position in the sorted list to start returning objects. Must be greater than or equal to zero and less than the number of matching elements.

count

The maximum number of objects to return. If this is greater than or equal to 0, then it specifies the maximum number of objects. If this is -1, then the maximum number of objects is unbounded.

Return Value

The return value is the filtered list of Privilege objects. An exception is thrown if the function fails.

Description

This function returns a filtered list of all Privilege objects that the logged-in user can access. For further information on filter functions, see Filtering and Paging.

Access Control

This function has no specific access control requirements.

See Also

addPrivilegesToUserGroup, addPrivilegeToUserGroup, addUserOrGroupsToObjectPrivilege, addUserOrGroupToObjectPrivilege, getAllPrivileges, getPrivilege, getPrivilegeByName, getPrivilegesByGuid, getPrivilegesByUserGroup, getPrivilegesByUserOrGroupObject, getUserGroupPrivilegesByObject, getUserGroupsByObjectPrivilege, getUserOrGroupPrivilegesByObject, getUserOrGroupsByObjectPrivilege, getUserPrivilegesByObject, getUsersByObjectPrivilege, removePrivilegeFromUserGroup, removePrivilegesFromUserGroup, removeUserOrGroupFromObjectPrivilege, removeUserOrGroupsFromObjectPrivilege, setObjectPrivilegeUserAndGroups, setObjectUserOrGroupPrivileges, setUserGroupPrivileges


getPrivilegesByGuid

Return specific Privilege objects.

Synopsis

Privilege[] getPrivilegesByGuid(string authkey, guid[] privilege_gids)

Parameters

authkey

The user authentication key returned from login().

privilege_gids

The ids of the Role objects to be returned.

Return Value

The return value is the requested Privilege objects. An exception is thrown if the function fails.

Description

This function returns a list of specific Privilege objects by id.

Access Control

This function has no specific access control requirements.

See Also

addPrivilegesToUserGroup, addPrivilegeToUserGroup, addUserOrGroupsToObjectPrivilege, addUserOrGroupToObjectPrivilege, getAllPrivileges, getPrivilege, getPrivilegeByName, getPrivileges, getPrivilegesByUserGroup, getPrivilegesByUserOrGroupObject, getUserGroupPrivilegesByObject, getUserGroupsByObjectPrivilege, getUserOrGroupPrivilegesByObject, getUserOrGroupsByObjectPrivilege, getUserPrivilegesByObject, getUsersByObjectPrivilege, removePrivilegeFromUserGroup, removePrivilegesFromUserGroup, removeUserOrGroupFromObjectPrivilege, removeUserOrGroupsFromObjectPrivilege, setObjectPrivilegeUserAndGroups, setObjectUserOrGroupPrivileges, setUserGroupPrivileges


getPrivilegesByUserGroup

Return Privilege objects associated with a UserGroup.

Synopsis

Privilege[] getPrivilegesByUserGroup(string authkey, guid user_group_gid)

Parameters

authkey

The user authentication key returned from login().

user_group_gid

The identifier of the UserGroup object for which the associated Privilege objects will be returned.

Return Value

The return value is the requested Privilege objects. An exception is thrown if the function fails.

Description

This function returns a list of Privilege objects associated with a UserGroup.

Access Control

This function is restricted to users with the MP Administrator role only.

See Also

addPrivilegesToUserGroup, addPrivilegeToUserGroup, getAllPrivileges, getPrivilege, getPrivilegeByName, getPrivilegesByGuid, getPrivilegesByUserOrGroupObject, getUserGroupPrivilegesByObject, getUserGroupsByObjectPrivilege, removePrivilegeFromUserGroup, removePrivilegesFromUserGroup, setUserGroupPrivileges


getPrivilegesByUserOrGroupObject

Return Privilege objects associated with a User or UserGroup and an object.

Synopsis

Privilege[] getPrivilegesByUserOrGroupObject(string authkey, guid user_or_group_gid, guid object_gid)

Parameters

authkey

The user authentication key returned from login().

user_or_group_gid

The identifier of the User or UserGroup objects for which the associated Privilege objects will be returned.

object_gid

The unique identifier of the object to query.

Return Value

The return value is the requested Privilege objects. An exception is thrown if the function fails.

Description

This function returns a list of Privilege objects associated with a User or UserGroup and an object.

Access Control

This function may be called by either an administrator, or by a user against themselves or against a group of which they are a member.

See Also

addPrivilegesToUserGroup, addPrivilegeToUserGroup, addUserOrGroupsToObjectPrivilege, addUserOrGroupToObjectPrivilege, getAllPrivileges, getPrivilege, getPrivilegeByName, getPrivilegesByGuid, getPrivilegesByUserGroup, getUserGroupPrivilegesByObject, getUserGroupsByObjectPrivilege, getUserOrGroupPrivilegesByObject, getUserOrGroupsByObjectPrivilege, getUserPrivilegesByObject, getUsersByObjectPrivilege, removePrivilegeFromUserGroup, removePrivilegesFromUserGroup, removeUserOrGroupFromObjectPrivilege, removeUserOrGroupsFromObjectPrivilege, setObjectPrivilegeUserAndGroups, setObjectUserOrGroupPrivileges, setUserGroupPrivileges


getProgram

Return a specific Program object.

Synopsis

Program getProgram(string authkey, guid program_gid)

Parameters

authkey

The user authentication key returned from login().

program_gid

The identifier of the Program to be returned.

Return Value

The return value is the requested Program object. An exception is thrown if the function fails.

Description

This function returns a Program object for a specific id.

Access Control

This function requires the calling user have Read Program privileges on the Program.

See Also

addProgramsToApplication, addProgramsToDeviceProfile, addProgramToApplication, addProgramToDeviceProfile, createProgram, createProgramModule, createProgramModules, createProgramModuleVersion, createProgramModuleVersions, createPrograms, createProgramVersion, createProgramVersions, deleteProgram, deleteProgramModule, deleteProgramModules, deleteProgramModuleVersion, deleteProgramModuleVersions, deletePrograms, deleteProgramVersion, deleteProgramVersions, getAllPrograms, getApplicationsByProgram, getGlobalResourceRequirementsByProgramModule, getJobStepsByProgram, getProgramByName, getProgramModule, getProgramModules, getProgramModulesByGuid, getProgramModulesByProgram, getProgramModulesByProgramVersion, getProgramModuleVersion, getProgramModuleVersions, getProgramModuleVersionsByGuid, getProgramModuleVersionsByJobStep, getProgramModuleVersionsByProgramModule, getPrograms, getProgramsByApplication, getProgramsByDeviceProfile, getProgramsByGuid, getProgramVersion, getProgramVersions, getProgramVersionsByGuid, getProgramVersionsByProgram, getResourceRequirementsByProgramModule, removeProgramFromApplication, removeProgramFromDeviceProfile, removeProgramsFromApplication, removeProgramsFromDeviceProfile, setApplicationPrograms, setDeviceProfilePrograms, updateProgram, updateProgramModule, updateProgramModules, updatePrograms, updateProgramVersion, updateProgramVersions


getProgramByName

Return a specific Program object by name.

Synopsis

Program getProgramByName(string authkey, string program_name)

Parameters

authkey

The user authentication key returned from login().

program_name

The unique name of the Program to be returned.

Return Value

The return value is the requested Program object. An exception is thrown if the function fails.

Description

This function returns a Program object for a specific name.

Access Control

This function requires the calling user have Read Program privileges on the Program.

See Also

addProgramsToApplication, addProgramsToDeviceProfile, addProgramToApplication, addProgramToDeviceProfile, createProgram, createProgramModule, createProgramModules, createProgramModuleVersion, createProgramModuleVersions, createPrograms, createProgramVersion, createProgramVersions, deleteProgram, deleteProgramModule, deleteProgramModules, deleteProgramModuleVersion, deleteProgramModuleVersions, deletePrograms, deleteProgramVersion, deleteProgramVersions, getAllPrograms, getApplicationsByProgram, getGlobalResourceRequirementsByProgramModule, getJobStepsByProgram, getProgram, getProgramModule, getProgramModules, getProgramModulesByGuid, getProgramModulesByProgram, getProgramModulesByProgramVersion, getProgramModuleVersion, getProgramModuleVersions, getProgramModuleVersionsByGuid, getProgramModuleVersionsByJobStep, getProgramModuleVersionsByProgramModule, getPrograms, getProgramsByApplication, getProgramsByDeviceProfile, getProgramsByGuid, getProgramVersion, getProgramVersions, getProgramVersionsByGuid, getProgramVersionsByProgram, getResourceRequirementsByProgramModule, removeProgramFromApplication, removeProgramFromDeviceProfile, removeProgramsFromApplication, removeProgramsFromDeviceProfile, setApplicationPrograms, setDeviceProfilePrograms, updateProgram, updateProgramModule, updateProgramModules, updatePrograms, updateProgramVersion, updateProgramVersions


getProgramModule

Return a specific ProgramModule object.

Synopsis

ProgramModule getProgramModule(string authkey, guid program_module_gid)

Parameters

authkey

The user authentication key returned from login().

program_module_gid

The identifier of the ProgramModule to be returned.

Return Value

The return value is the requested ProgramModule object. An exception is thrown if the function fails.

Description

This function returns a ProgramModule object for a specific id.

Access Control

This function requires the calling user have Read Program privileges on the Program.

See Also

createProgramModule, createProgramModules, createProgramModuleVersion, createProgramModuleVersions, deleteProgramModule, deleteProgramModules, deleteProgramModuleVersion, deleteProgramModuleVersions, getGlobalResourceRequirementsByProgramModule, getProgramModules, getProgramModulesByGuid, getProgramModulesByProgram, getProgramModulesByProgramVersion, getProgramModuleVersion, getProgramModuleVersions, getProgramModuleVersionsByGuid, getProgramModuleVersionsByJobStep, getProgramModuleVersionsByProgramModule, getResourceRequirementsByProgramModule, updateProgramModule, updateProgramModules


getProgramModules

Return a filtered list of ProgramModule objects.

Synopsis

ProgramModuleArrayRange getProgramModules(string authkey, ProgramModuleFilter filter, string order, integer start, integer count)

Parameters

authkey

The user authentication key returned from login().

filter

The filter condition that selects which objects will be returned.

order

The sort order in which the objects will be returned.

start

The position in the sorted list to start returning objects. Must be greater than or equal to zero and less than the number of matching elements.

count

The maximum number of objects to return. If this is greater than or equal to 0, then it specifies the maximum number of objects. If this is -1, then the maximum number of objects is unbounded.

Return Value

The return value is the filtered list of ProgramModule objects. An exception is thrown if the function fails.

Description

This function returns a filtered list of all ProgramModule objects that the logged-in user can access. For further information on filter functions, see Filtering and Paging.

Access Control

This function requires the calling user have Read Program privileges on the Program.

See Also

createProgramModule, createProgramModules, createProgramModuleVersion, createProgramModuleVersions, deleteProgramModule, deleteProgramModules, deleteProgramModuleVersion, deleteProgramModuleVersions, getGlobalResourceRequirementsByProgramModule, getProgramModule, getProgramModulesByGuid, getProgramModulesByProgram, getProgramModulesByProgramVersion, getProgramModuleVersion, getProgramModuleVersions, getProgramModuleVersionsByGuid, getProgramModuleVersionsByJobStep, getProgramModuleVersionsByProgramModule, getResourceRequirementsByProgramModule, updateProgramModule, updateProgramModules


getProgramModulesByGuid

Return specific ProgramModule objects.

Synopsis

ProgramModule[] getProgramModulesByGuid(string authkey, guid[] program_module_gids)

Parameters

authkey

The user authentication key returned from login().

program_module_gids

The ids of the ProgramModule objects to be returned.

Return Value

The return value is the requested ProgramModule objects. An exception is thrown if the function fails.

Description

This function returns a list of specific ProgramModule objects by id.

Access Control

This function requires the calling user have Read Program privileges on the Program.

See Also

createProgramModule, createProgramModules, createProgramModuleVersion, createProgramModuleVersions, deleteProgramModule, deleteProgramModules, deleteProgramModuleVersion, deleteProgramModuleVersions, getGlobalResourceRequirementsByProgramModule, getProgramModule, getProgramModules, getProgramModulesByProgram, getProgramModulesByProgramVersion, getProgramModuleVersion, getProgramModuleVersions, getProgramModuleVersionsByGuid, getProgramModuleVersionsByJobStep, getProgramModuleVersionsByProgramModule, getResourceRequirementsByProgramModule, updateProgramModule, updateProgramModules


getProgramModulesByProgram

Return ProgramModule objects associated with a Program.

Synopsis

ProgramModule[] getProgramModulesByProgram(string authkey, guid program_gid)

Parameters

authkey

The user authentication key returned from login().

program_gid

The identifier of the Program objects for which the associated ProgramModule objects will be returned.

Return Value

The return value is the requested ProgramModule objects. An exception is thrown if the function fails.

Description

This function returns a list of ProgramModule objects associated with a Program.

Access Control

This function requires the calling user have Read Program privileges on the Program.

See Also

createProgramModule, createProgramModules, createProgramModuleVersion, createProgramModuleVersions, deleteProgramModule, deleteProgramModules, deleteProgramModuleVersion, deleteProgramModuleVersions, getGlobalResourceRequirementsByProgramModule, getProgramModule, getProgramModules, getProgramModulesByGuid, getProgramModulesByProgramVersion, getProgramModuleVersion, getProgramModuleVersions, getProgramModuleVersionsByGuid, getProgramModuleVersionsByJobStep, getProgramModuleVersionsByProgramModule, getResourceRequirementsByProgramModule, updateProgramModule, updateProgramModules


getProgramModulesByProgramVersion

Return ProgramModule objects associated with a ProgramVersion.

Synopsis

ProgramModule[] getProgramModulesByProgramVersion(string authkey, guid program_version_gid)

Parameters

authkey

The user authentication key returned from login().

program_version_gid

The identifier of the ProgramVersion objects for which the associated ProgramModule objects will be returned.

Return Value

The return value is the requested ProgramModule objects. An exception is thrown if the function fails.

Description

This function returns a list of ProgramModule objects associated with a ProgramVersion.

Access Control

This function requires the calling user have Read Program privileges on the Program.

See Also

getProgramModule, getProgramModulesByGuid, getProgramModulesByProgram


getProgramModuleVersion

Return a specific ProgramModuleVersion object.

Synopsis

ProgramModuleVersion getProgramModuleVersion(string authkey, guid program_module_version_gid)

Parameters

authkey

The user authentication key returned from login().

program_module_version_gid

The identifier of the ProgramModuleVersion to be returned.

Return Value

The return value is the requested ProgramModuleVersion object. An exception is thrown if the function fails.

Description

This function returns a ProgramModuleVersion object for a specific id.

Access Control

This function requires the calling user have Read Program privileges on the Program.

See Also

createProgramModuleVersion, createProgramModuleVersions, deleteProgramModuleVersion, deleteProgramModuleVersions, getProgramModuleVersions, getProgramModuleVersionsByGuid, getProgramModuleVersionsByJobStep, getProgramModuleVersionsByProgramModule


getProgramModuleVersions

Return a filtered list of ProgramModuleVersion objects.

Synopsis

ProgramModuleVersionArrayRange getProgramModuleVersions(string authkey, ProgramModuleVersionFilter filter, string order, integer start, integer count)

Parameters

authkey

The user authentication key returned from login().

filter

The filter condition that selects which objects will be returned.

order

The sort order in which the objects will be returned.

start

The position in the sorted list to start returning objects. Must be greater than or equal to zero and less than the number of matching elements.

count

The maximum number of objects to return. If this is greater than or equal to 0, then it specifies the maximum number of objects. If this is -1, then the maximum number of objects is unbounded.

Return Value

The return value is the filtered list of ProgramModuleVersion objects. An exception is thrown if the function fails.

Description

This function returns a filtered list of all