IPayRuleScriptService2

Operations

NameSignatureDescription
Activatevoid Activate(Uri scriptUri)Activate a script
BulkDeleteScriptBulkDeleteResults1 BulkDelete(Uri[] scriptUris, Uri scriptBulkDeleteOptionUri)Delete many scripts
BulkGetScriptDescriptionSummaryScriptDescriptionSummary1[] BulkGetScriptDescriptionSummary(Uri[] scriptUris)Retrieve script description summary for many scripts
BulkGetScriptDetailsScriptDetails1[] BulkGetScriptDetails(Uri[] scriptUris)Retrieve script details for many scripts. Null elements will be returned for requested scripts that can not be returned
CreateEditDraftUri CreateEditDraft(Uri scriptUri)Create a draft of an existing script.
CreateFromGlobalScriptReference1 CreateFromGlobal(GlobalScriptTargetParameter1 globalScript, String unitOfWorkId)Copy a script from global script
CreateNewDraftUri CreateNewDraft()Create a draft of a new script.
CreatePutPayRuleScriptAssignmentScheduleBatchUri CreatePutPayRuleScriptAssignmentScheduleBatch(Uri[] userUris, PayRuleScriptScheduleEntryParameter1[] scheduleEntries)Create a batch for bulk assign payrules to users
Deactivatevoid Deactivate(Uri scriptUri)Deactivate a script. Existing bindings will still use the script, but the script will be unavailable for new bindings.
Deletevoid Delete(Uri scriptUri)Delete a script
ExecutePutPayRuleScriptAssignmentScheduleBatchPutPayRuleScriptAssignmentScheduleBatchResults1 ExecutePutPayRuleScriptAssignmentScheduleBatch(Uri putPayRuleScriptAssignmentScheduleBatchUri)Bulk assign PayRules to users
GetActiveScriptsScriptReference1[] GetActiveScripts()Retrieve a list of all enabled scripts in the system
GetAllScriptsScriptReference1[] GetAllScripts()Retrieve a list of all scripts in the system
GetPageOfAvailablePayRuleScriptsByTextSearchPayRuleScriptReference1[] GetPageOfAvailablePayRuleScriptsByTextSearch(Int32 page, Int32 pageSize, PayRuleScriptTextSearchParameter1 textSearch)Searches for pay rule scripts matching a given text search parameter which can be assigned to users
GetPayRuleScriptAssignmentScheduleForUserPayRuleScriptScheduleEntryDetails1[] GetPayRuleScriptAssignmentScheduleForUser(Uri userUri)Get the pay rule script assignment schedule for the specified user
GetPayRuleScriptDetailsPayRuleScriptDetails1 GetPayRuleScriptDetails(Uri payRuleScriptUri)Retrieve pay rule script details for a pay rule script or pay rule script draft.
GetPayRuleScriptDetailsIfUpdatedPayRuleScriptConditionalDetails1 GetPayRuleScriptDetailsIfUpdated(Uri payRuleScriptUri, Uri payRuleScriptVersionUri)Retrieve pay rule script details for a pay rule script or pay rule script draft, if it has been changed since the provided parameter payRuleScriptVersion.
GetPutPayRuleScriptAssignmentScheduleBatchResultsPutPayRuleScriptAssignmentScheduleBatchResults1 GetPutPayRuleScriptAssignmentScheduleBatchResults(Uri putPayRuleScriptAssignmentScheduleBatchUri)Retrieve results of a completed ExecutePutPayRuleScriptAssignmentScheduleBatch operation. Returns null if the batch has not completed.
GetScriptScriptReference1 GetScript(Uri scriptUri)Get a given script
GetScriptDetailsScriptDetails1 GetScriptDetails(Uri scriptUri)Retrieve script details for a script or script draft.
GetScriptDetailsIfUpdatedScriptConditionalDetails1 GetScriptDetailsIfUpdated(Uri scriptUri, Uri scriptVersionUri)Retrieve script details for a script or draft if it has been changed since the provided parameter ScriptVersion.
GetScriptRevisionsScriptRevision1[] GetScriptRevisions(Uri scriptUri)Retrieve script details with revisions for many scripts. Null elements will be returned for requested scripts that can not be returned
GetScriptsWithKeyValuesScriptReference1[] GetScriptsWithKeyValues(ScriptKeyValue1[] keyValues)Retrieve a list of all scripts which have a specified setting value
GetUriFromDraftUri GetUriFromDraft(Uri draftUri)Convert a script draft URI into the backing script URI.
GetUriFromSlugUri GetUriFromSlug(String scriptSlug)Convert a script slug into a URI.
PublishDraftScriptReference1 PublishDraft(Uri draftUri)Publish a script draft, converting it into a script that is returned.
PutPayRuleScriptAssignmentScheduleForUservoid PutPayRuleScriptAssignmentScheduleForUser(Uri userUri, PayRuleScriptScheduleEntryParameter1[] scheduleEntries)Put the entire pay rule script assignment schedule for the specified user
PutScriptScriptReference1 PutScript(ScriptParameter1 script)Put an entire script object and corresponding properties
PutSettingValueForScriptvoid PutSettingValueForScript(Uri scriptUri, ScriptKeyValue1 keyValue)Sets the specified key on the specified script or draft
UpdateCostCentervoid UpdateCostCenter(Uri payRuleScriptUri, CostCenterTargetParameter1 costCenter)Modify the cost center of a pay rule script or pay rule script draft.
UpdateCountryvoid UpdateCountry(Uri payRuleScriptUri, Uri countryUri)Modify the country of a pay rule script or pay rule script draft
UpdateDepartmentGroupvoid UpdateDepartmentGroup(Uri payRuleScriptUri, DepartmentGroupTargetParameter1 departmentGroup)Modify the department group of a pay rule script or pay rule script draft.
UpdateDescriptionvoid UpdateDescription(Uri scriptUri, String description)Modify the description of a script or draft.
UpdateDetailedDescriptionvoid UpdateDetailedDescription(Uri scriptUri, String detailedDescription)Modify the detail description of a script or draft.
UpdateDivisionvoid UpdateDivision(Uri payRuleScriptUri, DivisionTargetParameter1 division)Modify the division of a pay rule script or pay rule script draft.
UpdateEmployeeTypeGroupvoid UpdateEmployeeTypeGroup(Uri payRuleScriptUri, EmployeeTypeGroupTargetParameter1 employeeTypeGroup)Modify the employee type group of a pay rule script or pay rule script draft.
UpdateLocationvoid UpdateLocation(Uri payRuleScriptUri, LocationTargetParameter1 location)Modify the location of a pay rule script or pay rule script draft.
UpdateNamevoid UpdateName(Uri scriptUri, String name)Modify the name of a script or draft.
UpdateRegionvoid UpdateRegion(Uri payRuleScriptUri, String region)Modify the region of a pay rule script or pay rule script draft
UpdateScriptCodevoid UpdateScriptCode(Uri scriptUri, String scriptCode, Uri scriptCodeLanguageUri)Modify the code of an script or draft.
UpdateServiceCentervoid UpdateServiceCenter(Uri payRuleScriptUri, ServiceCenterTargetParameter1 serviceCenter)Modify the service center of a pay rule script or pay rule script draft.