TargetAssignments

put/api/v1/target-assignments/global/{id}

Request

  • Base URL: https://api.immy.bot (the document declares no server; this is the origin it was published from)
  • URL: https://api.immy.bot/api/v1/target-assignments/global/{id}
  • Auth: none declared

Path parameters

idinteger required

Request body

idinteger
maintenanceIdentifierstring nullable required
maintenanceType'GlobalSoftware' | 'LocalSoftware' | 'WindowsUpdate' | 'ChocolateySoftware' | 'NiniteSoftware' | 'LocalMaintenanceTask' | 'GlobalMaintenanceTask' | 'AgentUpdate'

The string or integer value may be used. GlobalSoftware = 0, LocalSoftware = 1, WindowsUpdate = 2, ChocolateySoftware = 3, NiniteSoftware = 4, LocalMaintenanceTask = 5, GlobalMaintenanceTask = 6, AgentUpdate = 7

targetType'All' | 'Computer' | 'Metascript' | 'Person' | 'AzureGroup' | 'TenantMetascript' | 'AllForTenant' | 'ProviderDeviceGroup' | 'ProviderClientGroup' | 'TenantFilterScript' | 'FilterScript' | 'AllTenants' | 'SpecificTenant' | 'Tag' | 'TenantTag' | 'CloudTag' | 'CloudProviderClientGroup'

The string or integer value may be used. All = 1, Computer = 2, Metascript = 5, Person = 7, AzureGroup = 8, TenantMetascript = 20, AllForTenant = 21, ProviderDeviceGroup = 22, ProviderClientGroup = 23, TenantFilterScript = 24, FilterScript = 25, AllTenants = 28, SpecificTenant = 29, Tag = 30, TenantTag = 31, CloudTag = 40, CloudProviderClientGroup = 42

targetstring nullable
targetCategory'Computer' | 'Tenant' | 'Person'

The string or integer value may be used. Computer = 0, Tenant = 1, Person = 2

desiredSoftwareState'NewerOrEqualVersion' | 'NotPresent' | 'AnyVersion' | 'ThisVersion' | 'OlderOrEqualVersion' | 'LatestVersion' | 'NoAction' | 'UpdateIfFound'

The string or integer value may be used. NewerOrEqualVersion = 0, NotPresent = 1, AnyVersion = 2, ThisVersion = 3, OlderOrEqualVersion = 4, LatestVersion = 5, NoAction = 6, UpdateIfFound = 7

softwareProviderType'Ninite' | 'Chocolatey' | 'Inherent'

The string or integer value may be used. Ninite = 1, Chocolatey = 2, Inherent = 3

maintenanceTaskMode'Enforce' | 'Audit' | 'Monitor' | 'NoAction'

The string or integer value may be used. Enforce = 0, Audit = 1, Monitor = 2, NoAction = 3

taskParameterValuesobject nullable
targetGroupFilter'All' | 'Servers' | 'Workstations' | 'PortableDevices' | 'WorkstationsAndPortableDevices' | 'DomainControllers' | 'PrimaryDomainControllers'

The string or integer value may be used. All = 0, Servers = 1, Workstations = 2, PortableDevices = 3, WorkstationsAndPortableDevices = 4, DomainControllers = 5, PrimaryDomainControllers = 6

excludedboolean
onboardingOnlyboolean
targetEnforcement'Required' | 'Optional' | 'Adhoc' | 'Onboarding'

The string or integer value may be used. Required = 1, Optional = 2, Adhoc = 3, Onboarding = 4

Response

OK

targetTextstring nullable
targetTypeNamestring nullable
targetScopeNamestring nullable
targetMissingboolean
tenantMissingboolean
targetTypeMissingboolean
targetTypeDescriptionstring nullable
targetType'All' | 'Computer' | 'Metascript' | 'Person' | 'AzureGroup' | 'TenantMetascript' | 'AllForTenant' | 'ProviderDeviceGroup' | 'ProviderClientGroup' | 'TenantFilterScript' | 'FilterScript' | 'AllTenants' | 'SpecificTenant' | 'Tag' | 'TenantTag' | 'CloudTag' | 'CloudProviderClientGroup'

The string or integer value may be used. All = 1, Computer = 2, Metascript = 5, Person = 7, AzureGroup = 8, TenantMetascript = 20, AllForTenant = 21, ProviderDeviceGroup = 22, ProviderClientGroup = 23, TenantFilterScript = 24, FilterScript = 25, AllTenants = 28, SpecificTenant = 29, Tag = 30, TenantTag = 31, CloudTag = 40, CloudProviderClientGroup = 42

onboardingOnlyboolean
targetstring nullable
targetCategory'Computer' | 'Tenant' | 'Person'

The string or integer value may be used. Computer = 0, Tenant = 1, Person = 2

targetGroupFilter'All' | 'Servers' | 'Workstations' | 'PortableDevices' | 'WorkstationsAndPortableDevices' | 'DomainControllers' | 'PrimaryDomainControllers'

The string or integer value may be used. All = 0, Servers = 1, Workstations = 2, PortableDevices = 3, WorkstationsAndPortableDevices = 4, DomainControllers = 5, PrimaryDomainControllers = 6

tenantIdinteger nullable
propagateToChildTenantsboolean
allowAccessToParentTenantboolean
providerLinkIdinteger nullable
providerClientGroupTypestring uuid nullable
providerDeviceGroupTypestring uuid nullable
targetGroupFilterNamestring nullable
idinteger
isCoreboolean
excludedboolean
targetEnforcement'Required' | 'Optional' | 'Adhoc' | 'Onboarding'

The string or integer value may be used. Required = 1, Optional = 2, Adhoc = 3, Onboarding = 4

notesstring nullable
notesUpdatedByUserNamestring nullable
notesUpdatedUtcstring date-time nullable
maintenanceType'GlobalSoftware' | 'LocalSoftware' | 'WindowsUpdate' | 'ChocolateySoftware' | 'NiniteSoftware' | 'LocalMaintenanceTask' | 'GlobalMaintenanceTask' | 'AgentUpdate'

The string or integer value may be used. GlobalSoftware = 0, LocalSoftware = 1, WindowsUpdate = 2, ChocolateySoftware = 3, NiniteSoftware = 4, LocalMaintenanceTask = 5, GlobalMaintenanceTask = 6, AgentUpdate = 7

maintenanceIdentifierstring nullable required
targetNamestring nullable
softwareSemanticVersionStringstring nullable
desiredSoftwareState'NewerOrEqualVersion' | 'NotPresent' | 'AnyVersion' | 'ThisVersion' | 'OlderOrEqualVersion' | 'LatestVersion' | 'NoAction' | 'UpdateIfFound'

The string or integer value may be used. NewerOrEqualVersion = 0, NotPresent = 1, AnyVersion = 2, ThisVersion = 3, OlderOrEqualVersion = 4, LatestVersion = 5, NoAction = 6, UpdateIfFound = 7

softwareProviderType'Ninite' | 'Chocolatey' | 'Inherent'

The string or integer value may be used. Ninite = 1, Chocolatey = 2, Inherent = 3

licenseIdinteger nullable
licenseNamestring nullable
updatedDateUTCstring date-time
updatedBystring nullable
createdDateUTCstring date-time
maintenanceTaskMode'Enforce' | 'Audit' | 'Monitor' | 'NoAction'

The string or integer value may be used. Enforce = 0, Audit = 1, Monitor = 2, NoAction = 3

taskParameterValuesobject nullable
sortOrderinteger
integrationTypeIdstring nullable
integrationPromptstring nullable
providerLinkIdForMaintenanceIteminteger nullable
databaseType'Global' | 'Local'

The string or integer value may be used. Global = 0, Local = 1

Changes

No recorded changes to this operation across all 1 revision of this API.