Overview
Configuration is provided for establishing connections with ADP service. The configuration is used in the REST Connection Manager.
Setup
Press 
icon to get more information about the connection parameters.
Obtain data
Use REST Source component to get data from service resource.
Insert data
Use REST Destination component to insert data into service resource.
Quick Start
In this task, we will show you step-by-step how to create a connection to ADP REST API using COZYROC's REST Connection Manager. Please review the ADP documentation page here. You will need the following information:
- Client ID.
- Client Secret.
- Certificate file in pfx format.
- Certificate password.
Step 1. Run "Visual Studio" under "Administrator account". Right click on Connection managers Tab and Select New Connection. In Add SSIS Connection Manager scroll down and select Connection managers for REST Connection and click Add.
Step 2. From the drop-down menu Configuration select ADP. Enter the required parameters in the places shown in the screenshot.
The default server host URL is for the production instance. If you want to connect to ADP sandbox enter the following: https://api.uat-adp.com/
Step 3. Click "Test Connection" to test your connection.
Congratulations! You have now established a connection to your ADP instance.
In this guide, we will show how to read data from the ADP service resource using the COZYROC REST Source component.
Step 1. Select an existing "Data Flow task" or create a new "Data Flow Task".
Step 2. Open "SSIS Toolbox" and drag and drop COZYROC "REST Source" component.
Step 3. Double click on the "REST Source" component and select ADP connection from the combo. Select from available ADP resources listed in the second combo below.
Optionally you can include extra parameters in the grid below if needed.
Step 4. Click on the "Columns tab" and select ADP resource columns you want to read.
Bravo! You have now learned how to read data from ADP service.
In this guide, we will show how to write data to the ADP service resource using the COZYROC REST Destination component.
Step 1. Select an existing "Data Flow task" or create a new "Data Flow Task".
Step 2. Open the "SSIS Toolbox" and drag and drop COZYROC "REST Destination" component.
Step 3. Double click on the "REST Destination" component and select ADP connection from the combo. Also, select resource action and ADP resource you want to work on.
Step 4. Click on the "Mapping" tab and map the input columns for the process you are configuring.
If you want to provide input for other resource composite objects, change the input above and map the columns.
Done. You have now learned how to write data into the ADP resource.
Configuration
Base URL address: https://api.adp.com/.
- Data Connector
-
The authentication uses a session token.
The authentication has the following user-defined parameters:
- client_id: Required. Specify client identifier.
- client_secret: Required. Specify client secret.
- CertificateFile: Required. Specify client certificate file (pfx).
- CertificatePassword: Specify certificate decryption password.
The following request parameters will be automatically processed during the authentication process:
-
Authorization:
Bearer {{=token.Access}} -
scope:
api
Documentation: https://developers.adp.com/articles/guides/auth-process-data-connector-apps.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/hr/v2/workers.
The result is extracted from:{{=response.workers}}.
The result is paginated.
- [Create] action
-
Endpoint URL address:
/events/hr/v1/{{=item.event && item.event.eventNameCode.codeValue}}.The following request parameters will be automatically processed:
-
application/json:
{{=ADP.getActionData('worker', item)}}
-
application/json:
- associateOID
A key field. Template: ShortText.
- workerID
Template: IDValue.
- person
Field components:
-
Uses template:
GovernmentIDs. - Contains the following components: governmentIDs, legalName, legalAddress, communication, birthDate, deceasedIndicator, deathDate, genderCode, genderIdentityCode, sexualOrientationCode, religionCode, maritalStatusCode, socialInsurancePrograms, tobaccoUserIndicator, disabilityIdentificationDeclinedIndicator, disabledIndicator, disabilityTypeCodes, disabilityPercentage, studentIndicator, studentStatusCode, identityDocuments, immigrationDocuments, passports, workAuthorizationDocuments, preferredName, alternatePreferredNames, formerNames, birthName, birthPlace, otherPersonalAddresses, ethnicityCode, ethnicityGroupCode, raceCode, identificationMethodCode, citizenshipCountryCodes, residencyCountryCodes, highestEducationLevelCode, militaryStatusCode, militaryDischargeDate, militaryClassificationCodes, customFieldGroup, links.
-
Uses template:
- workerDates
Field components:
-
Uses template:
Date. - Contains the following components: originalHireDate, rehireDate, adjustedServiceDate, acquisitionDate, retirementDate, terminationDate, expectedTerminationDate.
-
Uses template:
- workerStatus
Template: Status.
- photos
Field components:
- An array.
- Contains the following components: itemID, nameCode, links.
- businessCommunication
Template: Communication.
- workAssignments
Field components:
- An array.
- Contains the following components: itemID, primaryIndicator, offerExtensionDate, offerAcceptanceDate, hireDate, seniorityDate, expectedStartDate, actualStartDate, terminationDate, expectedTerminationDate, assignmentStatus, assignmentCostCenters, workerProbationIndicator, workerProbationPeriod, workerTypeCode, assignmentTermCode, workLevelCode, nationalityContextCode, vipIndicator, vipTypeCode, executiveIndicator, executiveTypeCode, officerIndicator, officerTypeCode, managementPositionIndicator, legalEntityID, highlyCompensatedIndicator, highlyCompensatedTypeCode, stockOwnerIndicator, stockOwnerPercentage, workerGroups, jobCode, jobTitle, occupationalClassifications, industryClassifications, wageLawCoverage, positionID, positionTitle, laborUnion, bargainingUnit, workShiftCode, workArrangementCode, standardHours, fullTimeEquivalenceRatio, homeOrganizationalUnits, assignedOrganizationalUnits, homeWorkLocation, assignedWorkLocations, remunerationBasisCode, payCycleCode, standardPayPeriodHours, baseRemuneration, additionalRemunerations, reportsTo, payrollProcessingStatusCode, payrollGroupCode, annualBenefitBaseRate, payrollScheduleGroupID, payrollFileNumber, payrollRegionCode, payScaleCode, payGradeCode, payGradePayRange, compaRatio, payGradeStepCode, payGradeStepPayRate, nextPayGradeStepDate, minimumPayGradeStepDuration, geographicPayDifferentialCode, geographicPayDifferentialPercentage, customFieldGroup, links.
- customFieldGroup
Template: CustomFieldGroup.
- links
Template: Links.
- event
Template: PostEvent.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/time/v1/workers/{{=parameters.aoid}}/time-entry-details.
The result is extracted from:{{=response.timeEntryDetails.entrySummary}}.The action has the following user-defined parameters:
- aoid: Required. Specify Associate OID.
- [Create] action
-
Endpoint URL address:
/time/v1/timeSheets/review.The following request parameters will be automatically processed:
-
application/json:
{{={ timeSheetsReview: { timeSheets: batch } } }}
-
application/json:
The resource includes the fields from the TimeEntry template.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/payroll/v1/payroll-output.
The result is extracted from:{{=response.payrollOutputs}}.
- itemID
Template: ShortText.
- payrollProcessingJobID
Template: ShortText.
- payrollRegionCode
Template: Code.
- payrollGroupCode
Template: Code.
- payrollScheduleReference
Field components:
-
Uses template:
ShortText. - Contains the following components: payrollScheduleID, scheduleEntryID, payrollYear, payrollWeekNumber, payrollRunNumber.
-
Uses template:
- payrollProcessingJobStatusCode
Template: Code.
- payrollSummary
Field components:
-
Uses template:
ConfigurationTags. - Contains the following components: earningsSummary, reportableEarningsAndBenefitsSummary, reimbursementsSummary, statutoryDeductionsSummary, nonStatutoryDeductionsSummary, memosSummary, paymentDistributionsSummary, payrollAdjustments, thirdPartyPayments, configurationTags, links.
-
Uses template:
- associatePayments
Field components:
- An array.
- Contains the following components: itemID, associateOID, payrollID, payments, links.
- links
Template: Links.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/payroll/v1/workers/{{=parameteres.aoid}}/payroll-instructions.
The result is extracted from:{{=response.payrollInstructions}}.The action has the following user-defined parameters:
- aoid: Required. Specify Associate OID.
- [Create] action
-
Endpoint URL address:
/events/payroll/v2/{{=item.event && item.event.eventNameCode.codeValue}}.The following request parameters will be automatically processed:
-
application/json:
{{=ADP.getActionData('payrollInstruction', item)}}
-
application/json:
The resource includes the fields from the PayrollInstruction template.
- event
Template: PostEvent.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/time/v2/workers/{{=parameters.aoid}}/clock-entries.
The result is extracted from:{{=response.clockEntries}}.The action has the following user-defined parameters:
- aoid: Required. Specify Associate OID.
- [Create] action
-
Endpoint URL address:
/events/time/v1/{{=item.event && item.event.eventNameCode.codeValue}}.The following request parameters will be automatically processed:
-
application/json:
{{=ADP.getActionData('clockEntry', item)}}
-
application/json:
The resource includes the fields from the ClockEntry template.
- event
Template: PostEvent.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/core/v1/event-notification-messages.
The result is extracted from:{{=response.events}}.
- [Delete] action
-
Endpoint URL address:
/core/v1/event-notification-messages/{{=item.eventID}}.
The resource includes the fields from the EventMessage template.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/time/v2/workers/{{=parameters.aoid}}/time-cards.
The result is extracted from:{{=response.timeCards}}.The action has the following user-defined parameters:
- aoid: Required. Specify Associate OID.
- [Create] action
-
Endpoint URL address:
/events/time/v2/{{=item.event && item.event.eventNameCode.codeValue}}.The following request parameters will be automatically processed:
-
application/json:
{{=ADP.getActionData('timeCard', item)}}
-
application/json:
The resource includes the fields from the TimeCard template.
- event
Template: PostEvent.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/staffing/v2/job-applicants.
The result is extracted from:{{=response.jobApplicants}}.
- [Create] action
-
Endpoint URL address:
/events/staffing/v1/{{=item.event && item.event.eventNameCode.codeValue}}.The following request parameters will be automatically processed:
-
application/json:
{{=ADP.getActionData('jobApplicant', item)}}
-
application/json:
- person
Field components:
-
Uses template:
ShortName. - Contains the following components: personName, relationshipTypeCode, communication, address, preferredName, formerNames, governmentIDs, birthName, birthPlace, studentIndicator, citizenshipCountryCodes, residencyCountryCodes, highestEducationLevelCode, militaryStatusCode, militaryDischargeDate, militaryClassificationCodes, selfIdentificationDeclinedIndicator, birthDate, genderCode, religionCode, ethnicityCode, ethnicityGroupCode, raceCode, maritalStatusCode, disabilityIdentificationDeclinedIndicator, disabledIndicator, disabilityTypeCodes, personOID, customFieldGroup.
-
Uses template:
- competencies
Field components:
- An array.
-
Uses template:
Competency.
- educationalDegrees
Field components:
- An array.
-
Uses template:
EducationalDegree. - Contains the following components: educationalInstitution, degreeIssuedIndicator.
- certifications
Field components:
- An array.
-
Uses template:
Certification.
- languages
Field components:
- An array.
-
Uses template:
Language.
- licenses
Field components:
- An array.
-
Uses template:
License.
- memberships
Field components:
- An array.
-
Uses template:
Membership. - Contains the following components: membershipOrganizationNameCode, membershipOrganizationChapterID.
- recognitions
Field components:
- An array.
-
Uses template:
Recognition.
- employmentHistory
Template: EmploymentHistory.
- references
Field components:
- An array.
- Contains the following components: personName, relationshipTypeCode, communication.
- applicantID
Template: ShortText.
- associateOID
Template: ShortText.
- internalApplicantIndicator
Data type: DT_BOOL
- workAuthorizationIndicator
Data type: DT_BOOL
- documents
Field components:
- An array.
-
Uses template:
Attachment.
- links
Template: Links.
- event
Template: PostEvent.
- payDistributions
A read-only field. The value is gathered from
/staffing/v2/job-applicants/{{=item.applicantID}}/pay-distributionsaddress. Field components:- An array.
- Contains the following components: itemID, requestedStartDate, distributionPurposeCode, distributionStatusCode, distributionInstructions, actions, attestationIndicator, payrollFileNumber, payrollAgreementDescription, payrollRegionCode, payrollGroupCode, links.
- usTaxProfiles
A read-only field. The value is gathered from
/staffing/v2/job-applicants/{{=item.applicantID}}/us-tax-profilesaddress. Field components:- An array.
- Contains the following components: itemID, payrollFileNumber, payrollRegionCode, payrollGroupCode, usFederalTaxInstruction, usStateTaxInstructions, usLocalTaxInstructions, links.
- personalContacts
A read-only field. The value is gathered from
/staffing/v2/job-applicants/{{=item.applicantID}}/personal-contactsaddress. Field components:- An array.
- Contains the following components: itemID, contactTypeCode, relationshipTypeCode, precedenceCode, personalContactComments, personName, address, communication, links.
- associateKSAOCS
A read-only field. The value is gathered from
/staffing/v2/job-applicants/{{=item.applicantID}}/applicant-ksaocsaddress. Field components:- An array.
- Contains the following components: associateOID, associateCertifications, associateCompetencies, associateEducationalDegrees, associateLanguages, associateLicenses, associateMemberships, associateRecognitions.
- recruitingDocuments
A read-only field. The value is gathered from
/staffing/v2/job-applicants/{{=item.applicantID}}/documentsaddress. The gathered value is processed with{{=response.documents}}expression. Field components:- An array.
- Contains the following components: itemID, documentTitle, documentDescription, documentTypeCode, fileTypeCode, categoryCode, subCategoryCode, mediaType, keywords, eSignatureSignedBy, eSignatureRequester, eSignatureStatusCode, eSignatureSignedDate, eSignatureRequestedDate, eSignatureTypeCode, sourceApplicationFeatureID, uploadedBy, uploadedDateTime, updatedBy, updatedDateTime, owner, organizationalUnitIDSets, fileName, fileSize, numberOfPages, versionID, serverFolderPath, localFolderPath, effectiveDateTime, expirationDateTime, documentStatusCode, uploadStatusCode, metaDataStatusCode, legacyID, applicationReferenceID, privateIndicator, readOnlyIndicator, nonAccessibleIndicator, cryptographicHashMessageDigest, multipleDocumentsIndicator, customStringFields, customIndicatorFields, sequenceNumber, hasCommentsIndicator, comments, links.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/payroll/v1/workers/{{=parameters.aoid}}/pay-statements.
The result is extracted from:{{=response.payStatements}}.The action has the following user-defined parameters:
- aoid: Required. Specify Associate OID.
- payDate
Template: Date.
- netPayAmount
Template: Amount.
- grossPayAmount
Template: Amount.
- totalHours
Data type: DT_I4
- payDetailUri
Field components:
-
Uses template:
ShortText. - Contains the following components: href.
-
Uses template:
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/payroll/v1/pay-data-input.
The result is extracted from:{{=response.payDataInputs}}.
- [Create] action
-
Endpoint URL address:
/events/payroll/v1/{{=item.event && item.event.eventNameCode.codeValue}}.The following request parameters will be automatically processed:
-
application/json:
{{=ADP.getActionData('payDataInput', item)}}
-
application/json:
- itemID
Template: ShortText.
- payeePayInputs
Field components:
- An array.
- Contains the following components: itemID, associateOID, payeeID, payPeriodStartDate, payPeriodEndDate, payNumber, payTypeCode, configurationTags, payrollProfilePayInputs.
- payrollRegionCode
Template: Code.
- payrollGroupCode
Template: Code.
- payrollWeekNumber
Template: ShortText.
- payrollRunNumber
Template: ShortText.
- payrollProcessingJobID
Template: ShortText.
- payDate
Template: Date.
- links
Template: Links.
- event
Template: PostEvent.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/time/v2/workers/{{=parameters.aoid}}/time-off-details/time-off-requests.
The result is extracted from:{{=response.paidTimeOffDetails.paidTimeOffRequests}}.The action has the following user-defined parameters:
- aoid: Required. Specify Associate OID.
- [Create] action
-
Endpoint URL address:
/time/v2/workers/{aoid}/time-off-requests.The following request parameters will be automatically processed:
-
application/json:
{{={ paidTimeOffRequest: _.extend({ positionRef: item.positionRef }, item.paidTimeOffRequestEntries[0]) } }}
-
application/json:
- [Update] action
-
Endpoint URL address:
/time/v2/workers/{{=item.positionRef.positionID.id}}/time-off-requests/{{=item.paidTimeOffRequestEntries[0].requestID}}.The following request parameters will be automatically processed:
-
application/json:
{{={ paidTimeOffRequest: _.extend({ positionRef: item.positionRef }, item.paidTimeOffRequestEntries[0]) } }}
-
application/json:
- [Delete] action
-
Endpoint URL address:
/time/v2/workers/{{=item.positionRef.positionID.id}}/time-off-requests/{{=item.paidTimeOffRequestEntries[0].requestID}}.
- positionRef
Field components:
-
Uses template:
PositionID. - Contains the following components: positionID, title.
-
Uses template:
- paidTimeOffRequestEntries
Field components:
- An array.
- Contains the following components: requestStatus, totalQuantity, totalTime, requests.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/hr/v1/corporate-contacts.
The result is extracted from:{{=response.corporateContacts.contacts}}.
- givenName
Template: ShortText.
- familyName
Template: ShortText.
- phone
Field components:
- An array.
- Contains the following components: labelName, channelCode, formattedDialNumber, extension.
Field components:
- An array.
- Contains the following components: labelName, uri.
- associateUri
Field components:
-
Uses template:
ShortText. - Contains the following components: href.
-
Uses template:
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/staffing/v1/job-requisitions.
The result is extracted from:{{=response.jobRequisitions}}.
- itemID
A key field. Template: ShortText.
- requisitionTitle
Template: ShortText.
- requisitionReasonCode
Template: Code.
- requisitionPurposeCode
Template: Code.
- postDate
Template: Date.
- positionQualifications
Field components:
-
Uses template:
ShortText. - Contains the following components: qualificationSummary.
-
Uses template:
- positionTravelRequirement
Template: ShortText.
- screeningRequirements
Field components:
- An array.
- Contains the following components: itemID, nameCode, requirementDescription.
- organizationalUnits
Template: OrganizationalUnits.
- standardHours
Field components:
- Contains the following components: dailyHoursQuantity, weeklyHoursQuantity, monthlyHoursQuantity, annualHoursQuantity, payPeriodHoursQuantity.
- payScaleCode
Template: Code.
- payGradeCode
Template: Code.
- payGradeStepCode
Template: Code.
- payGradeRange
Field components:
-
Uses template:
Rate. - Contains the following components: minimumRate, medianRate, maximumRate.
-
Uses template:
- bonusEligibleIndicator
Data type: DT_BOOL
- remunerationBasisCode
Template: Code.
- workLevelCode
Template: Code.
- workArrangementCode
Template: Code.
- assignmentTermCode
Template: Code.
- workerTypeCode
Template: Code.
- allowedOvertimeIndicator
Data type: DT_BOOL
- allowedOvertimeQuantity
Field components:
-
Uses template:
Code. - Contains the following components: quantityValue, unitTypeCode.
-
Uses template:
- mandatoryOvertimeIndicator
Data type: DT_BOOL
- mandatoryOvertimeQuantity
Field components:
-
Uses template:
Code. - Contains the following components: quantityValue, unitTypeCode.
-
Uses template:
- paidRelocationCode
Template: Code.
- projectedStartDate
Template: Date.
- projectedEndDate
Template: Date.
- workingLanguageCode
Template: Code.
- openingsQuantity
Data type: DT_I4
- openingsFilledQuantity
Data type: DT_I4
- shiftWorkIndicator
Data type: DT_BOOL
- sponsorVisaIndicator
Data type: DT_BOOL
- sponsoredVisaTypeCodes
Field components:
- An array.
-
Uses template:
Code.
- laborUnionIndicator
Data type: DT_BOOL
- laborUnionCode
Template: Code.
- bargainingUnitCode
Template: Code.
- visibleToJobSeekerIndicator
Data type: DT_BOOL
- visibleToExternalJobSeekerIndicator
Data type: DT_BOOL
- customFieldGroup
Template: CustomFieldGroup.
- clientRequisitionID
Template: ShortText.
- requisitionStatusCode
Template: StatusCode.
- requisitionDescription
Template: ShortText.
- job
Field components:
-
Uses template:
Code. - Contains the following components: jobCode, jobTitle, jobFamilies, jobResponsibilities, wageLawCoverage, occupationalClassifications, links.
-
Uses template:
- position
Field components:
-
Uses template:
ShortText. - Contains the following components: positionID, positionTitle, positionCode, categoryCode.
-
Uses template:
- careerLevelCode
Template: Code.
- requisitionLocations
Field components:
- An array.
- Contains the following components: itemID, aliasNames, nameCode, communication, address, primaryIndicator, postingIndicator.
- locationIndependentIndicator
Data type: DT_BOOL
- hiringManager
Field components:
-
Uses template:
Name. - Contains the following components: personName, address, communication, associateOID, workerID, roleCode.
-
Uses template:
- recruiter
Field components:
-
Uses template:
Name. - Contains the following components: personName, address, communication, associateOID, workerID, roleCode.
-
Uses template:
- jobSeekerApplicationReference
Field components:
-
Uses template:
StatusCode. - Contains the following components: applicationStatusCode, applicationID, appliedDate.
-
Uses template:
- postingInstructions
Field components:
- An array.
- Contains the following components: itemID, nameCode, postingChannel, jobRequisitionOverrides, internalIndicator, externalIndicator, prospectReferralIndicator, prospectReferralDateRange, resumeRequiredIndicator, compensationVisibleIndicator, applicantLimit, applicationAcceptedDateRange, postDate, expireDate, applicationMethods.
- links
Template: Links.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/payroll/v2/workers/{{=parameters.aoid}}/pay-distributions.
The result is extracted from:{{=response.payDistributions}}.The action has the following user-defined parameters:
- aoid: Required. Specify Associate OID.
- [Create] action
-
Endpoint URL address:
/events/payroll/v1/{{=item.event && item.event.eventNameCode.codeValue}}.The following request parameters will be automatically processed:
-
application/json:
{{=ADP.getActionData('payDistribution', item)}}
-
application/json:
- itemID
Template: ShortText.
- requestedStartDate
Template: Date.
- distributionPurposeCode
Template: Code.
- distributionStatusCode
Template: StatusCode.
- distributionInstructions
Field components:
- An array.
- Contains the following components: itemID, precedenceCode, paymentMethodCode, depositAccount, payee, distributionAmount, distributionPercentage, remainingBalanceIndicator, prenoteIndicator.
- actions
Template: Actions.
- attestationIndicator
Field components:
-
Uses template:
Date. - Contains the following components: indicatorValue, effectiveDate.
-
Uses template:
- payrollFileNumber
Template: ShortText.
- payrollAgreementDescription
Template: ShortText.
- payrollRegionCode
Template: Code.
- payrollGroupCode
Template: Code.
- links
Template: Links.
- event
Template: PostEvent.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/tax/v1/tax-credit-screenings.
The result is extracted from:{{=response.taxCreditScreenings}}.
- [Create] action
-
Endpoint URL address:
/events/tax/v1/{{=item.event && item.event.eventNameCode.codeValue}}.The following request parameters will be automatically processed:
-
application/json:
{{=ADP.getActionData('taxCreditScreening', item)}}
-
application/json:
- itemID
Template: ShortText.
- screeningInitiationDate
Template: Date.
- screeningStatusCode
Template: Code.
- screeningSubject
Field components:
-
Uses template:
Name. - Contains the following components: taxID, legalName, birthDate, legalAddress, communication, screeningSubjectAcknowledgementDate, workAssignment.
-
Uses template:
- confirmationNumber
Template: ShortText.
- evaluatedTaxCredits
Field components:
- An array.
- Contains the following components: taxCreditCode, eligibilityCode.
- taxCreditForms
Field components:
- An array.
- Contains the following components: formCode, links.
- links
Template: Links.
- event
Template: PostEvent.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/core/v1/data.
The result is extracted from:{{=ADP.getTableData(response.data[0])}}.
The result is paginated.The action has the following user-defined parameters:
- table: Required. Specify table name.
The following request parameters will be automatically processed:
-
tableName:
{{=parameters.table}}
- [External]
-
The external fields URL address:
/core/v1/data. The external fields list is extracted from:{{=item.columns}}.- {{=external.columnName}}
Data type: {{=ADP.getDataType(external.columnDataType)}} ( length 255 )
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/staffing/v2/job-applications.
The result is extracted from:{{=response.jobApplications}}.
- [Create] action
-
Endpoint URL address:
/events/staffing/v1/{{=item.event && item.event.eventNameCode.codeValue}}.The following request parameters will be automatically processed:
-
application/json:
{{=ADP.getActionData('jobApplication', item)}}
-
application/json:
- itemID
A key field. Template: ShortText.
- applicantReferralIndicator
Data type: DT_BOOL
- applicantReferredBy
Field components:
-
Uses template:
ShortName. - Contains the following components: personName, relationshipTypeCode, communication, personOID, associateOID, workerID, workAssignmentID.
-
Uses template:
- referralSourceCode
Template: Code.
- requestedPayRate
Template: PayRate. Field components:
-
Uses template:
Code. - Contains the following components: remunerationBasisCode.
-
Uses template:
- attachments
Field components:
- An array.
-
Uses template:
Attachment.
- _languageCode
Template: Code.
- jobRequisitionReference
Field components:
-
Uses template:
ShortText. - Contains the following components: requisitionID, requisitionTitle, clientRequisitionID, requisitionStatusCode, requisitionDescription, postDate, jobFamilyCode, links.
-
Uses template:
- jobOfferReference
Field components:
-
Uses template:
Date. - Contains the following components: offerExtensionDate, offerExpirationDate, offerStatusCode, offerAcceptanceDate, offerTerms, offerAssignment, offerAcceptanceStatusCode, offerCreatedBy, eSignatureSignedBy, eSignatureStatusCode, eSignatureSignedDate, jobOfferID, comments.
-
Uses template:
- applicationStatusCode
Template: StatusCode.
- applicationSource
Field components:
-
Uses template:
Date. - Contains the following components: submittedBy, submittedDate, initiatedDateTime, postingChannelID, postingChannelNameCode.
-
Uses template:
- applicant
Field components:
-
Uses template:
EmploymentHistory. - Contains the following components: person, competencies, educationalDegrees, certifications, languages, licenses, memberships, recognitions, employmentHistory, references, personOID, associateOID, internalApplicantIndicator, workAuthorizationIndicator, relevancyCategoryCode, WOTCScreeningStatusCode.
-
Uses template:
- attestations
Field components:
- An array.
- Contains the following components: itemID, messageTxt, links, nameCode, acceptedIndicator.
- questionnaire
Field components:
-
Uses template:
ShortText. - Contains the following components: questionnaireID, questionnaireTitle, questionAnswers.
-
Uses template:
- comments
Field components:
- An array.
-
Uses template:
Comment.
- links
Template: Links.
- event
Template: PostEvent.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/time/v2/workers/{{=parameters.aoid}}/team-time-cards.
The result is extracted from:{{=response.teamTimeCards}}.The action has the following user-defined parameters:
- aoid: Required. Specify Associate OID.
- associateOID
Template: ShortText.
- workerID
Template: IDValue.
- personLegalName
Template: Name.
- timeCards
Field components:
- An array.
-
Uses template:
TimeCard.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/payroll/v2/paycard/enrollment/{{=parameters.enrollment_id}}/status.
The result is extracted from:{{=response.paycardEnrollments}}.The action has the following user-defined parameters:
- enrollment_id: Required. Specify Enrollment ID
- [Create] action
-
Endpoint URL address:
/events/payroll/v1/{{=item.event && item.event.eventNameCode.codeValue}}.The following request parameters will be automatically processed:
-
application/json:
{{=ADP.getActionData('enrollment', item)}}
-
application/json:
- itemID
Template: ShortText.
- enrollmentTypeCode
Template: Code.
- cardClassCode
Template: Code.
- cardDesignCode
Template: Code.
- cardholderTypeCode
Template: Code.
- enrollmentStatus
Template: StatusCode.
- initialLoadAmount
Template: Amount.
- person
Field components:
-
Uses template:
GovernmentIDs. - Contains the following components: governmentIDs, legalName, legalAddress, communication, birthDate.
-
Uses template:
- standardizedAddresses
Field components:
- An array.
- Contains the following components: itemID, address, selectedIndicator.
- fundingAccount
Template: Account. Field components:
-
Uses template:
IDValue. - Contains the following components: accountID, accountCardAliasID, location.
-
Uses template:
- cardDepositAccount
Template: Account. Field components:
-
Uses template:
IDValue. - Contains the following components: accountID.
-
Uses template:
- processingInstructions
Field components:
- An array.
- Contains the following components: typeCode, processingCode.
- actions
Template: Actions.
- links
Template: Links.
- event
Template: PostEvent.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/hr/v2/associates/{{=parameters.aoid}}/personal-contacts.
The result is extracted from:{{=response.personalContacts}}.The action has the following user-defined parameters:
- aoid: Required. Specify Associate OID.
- [Create] action
-
Endpoint URL address:
/events/hr/v1/{{=item.event && item.event.eventNameCode.codeValue}}.The following request parameters will be automatically processed:
-
application/json:
{{=ADP.getActionData('personalContact', item)}}
-
application/json:
- itemID
Template: ShortText.
- contactName
Template: ShortName.
- contactAddress
Template: Address.
- communication
Template: Communication.
- contactTypeCode
Template: Code.
- relationshipTypeCode
Template: Code.
- precedenceCode
Template: Code.
- event
Template: PostEvent.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/time/v1/data-collection-entries.
The result is extracted from:{{=response.dataCollectionEntries}}.
- [Create] action
-
Endpoint URL address:
/events/time/v1/{{=item.event && item.event.eventNameCode.codeValue}}.The following request parameters will be automatically processed:
-
application/json:
{{=ADP.getActionData('dataCollectionEntries', item)}}
-
application/json:
- itemID
Template: ShortText.
- terminalID
Template: ShortText.
- terminalName
Template: ShortText.
- workerDataCollectionEntries
Field components:
- An array.
- Contains the following components: entryID, entryCode, entryTypeCode, badgeID, actorBadgeID, workAssignmentID, deviceDateTime, entryDateTime, actionCode, laborAllocations, entryOverrideCodes, comment, secondsQuantity, hourQuantity, timeDuration, unitQuantity, amount.
- event
Template: PostEvent.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/time/v1/workers/{{=parameters.aoid}}/work-schedules.
The result is extracted from:{{=response.workSchedules}}.The action has the following user-defined parameters:
- aoid: Required. Specify Associate OID.
- [Create] action
-
Endpoint URL address:
/events/time/v1/{{=item.event && item.event.eventNameCode.codeValue}}.The following request parameters will be automatically processed:
-
application/json:
{{=ADP.getActionData('workSchedule', item)}}
-
application/json:
- itemID
Template: ShortText.
- scheduleID
Template: ShortText.
- scheduleName
Template: ShortText.
- associateOID
Template: ShortText.
- workerName
Template: ShortName.
- workAssignmentID
Template: ShortText.
- clockReferenceDateTime
Template: DateTime.
- schedulePeriod
Template: DatePeriod.
- scheduleDays
Field components:
- An array.
- Contains the following components: itemID, daySequenceNumber, dayOfWeekCode, scheduleDayDate, scheduleEntries, scheduledHours, appliedTempateID, actions.
- scheduledHours
Field components:
-
Uses template:
Code. - Contains the following components: hoursQuantity, unitCode.
-
Uses template:
- appliedTemplateID
Template: ShortText.
- actions
Template: Actions.
- links
Template: Links.
- event
Template: PostEvent.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/payroll/v1/workers/{{=parameters.aoid}}/tax-statements.
The result is extracted from:{{=response.workerTaxStatements}}.The action has the following user-defined parameters:
- aoid: Required. Specify Associate OID.
- statementID
Template: ShortText.
- statementName
Template: ShortText.
- form
Template: LocCode.
- jurisdiction
Template: LocCode.
- statementYear
Field components:
-
Uses template:
ShortText. - Contains the following components: year.
-
Uses template:
- summaryAmount
Field components:
-
Uses template:
ShortText. - Contains the following components: amountValue, currencyCode, labelName.
-
Uses template:
- statementUri
Field components:
-
Uses template:
ShortText. - Contains the following components: href.
-
Uses template:
- statementImageUri
Field components:
-
Uses template:
ShortText. - Contains the following components: href.
-
Uses template:
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/time/v2/workers/{{=parameters.aoid}}/time-off-details/time-off-balances.
The result is extracted from:{{=response.paidTimeOffDetails.paidTimeOffBalances}}.The action has the following user-defined parameters:
- aoid: Required. Specify Associate OID.
- positionRef
Field components:
-
Uses template:
PositionID. - Contains the following components: positionID, title.
-
Uses template:
- asOfDate
Template: Date.
- paidTimeOffPolicyBalances
Field components:
- An array.
- Contains the following components: paidTimeOffPolicy, policyBalances.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/time/v2/workers/{{=parameters.aoid}}/time-off-details/time-off-configurations.
The result is extracted from:{{=response.paidTimeOffDetails.paidTimeOffConfiguration}}.The action has the following user-defined parameters:
- aoid: Required. Specify Associate OID.
- positionRef
Field components:
-
Uses template:
PositionID. - Contains the following components: positionID, title.
-
Uses template:
- clockReferenceDateTime
Template: DateTime.
- timeNotationCode
Template: ShortText.
- requestTimeOffIndicator
Data type: DT_BOOL
- forecastIndicator
Data type: DT_BOOL
- approvalDateIndicator
Data type: DT_BOOL
- commentsIndicator
Data type: DT_BOOL
- multiPeriodRequestIndicator
Data type: DT_BOOL
- singlePolicyRequestIndicator
Data type: DT_BOOL
- balancesIndicator
Data type: DT_BOOL
- requestsIndicator
Data type: DT_BOOL
- paidTimeOffPolicies
Field components:
- An array.
- Contains the following components: paidTimeOffPolicy, defaultQuantity, defaultTime, defaultStartTime, defaultEndTime, requestTimeOffIndicator, forecastIndicator, entryTypeCodes, partialDayIndicator, minimumQuantity, minimumIncrement, durationPrecision, defaultIndicator, multiPeriodRequestIndicator, startTimeInSummaryIndicator, durationTypes, dayPeriods, earningTypes, durationDisplayCode, commentsIndicator.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/payroll/v1/paycard/cardholders.
The result is extracted from:{{=response.cardholders}}.
- [Create] action
-
Endpoint URL address:
/events/payroll/v1/paycard/{{=item.event && item.event.eventNameCode.codeValue}}.The following request parameters will be automatically processed:
-
application/json:
{{=ADP.getActionData('cardholder', item)}}
-
application/json:
- associateOID
Template: ShortText.
- workerID
Template: IDValue.
- governmentID
Template: IDValue.
- personName
Template: ShortName.
- locationNameCode
Template: Code.
- cardholderAccount
Field components:
-
Uses template:
IDValue. - Contains the following components: accountID, accountStatusCode, alternateFundingStatusCode, accountNumber, accountBalanceAmount.
-
Uses template:
- cards
Field components:
- An array.
- Contains the following components: cardStatusCode, cardProxyID, cardNumber, cardProgramCode.
- event
Template: PostEvent.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/payroll/v1/paycard/funding-accounts.
The result is extracted from:{{=response.fundingAccounts}}.
- [Create] action
-
Endpoint URL address:
/events/payroll/v1/{{=item.event && item.event.eventNameCode.codeValue}}.The following request parameters will be automatically processed:
-
application/json:
{{=ADP.getActionData('cardDepositAccount', item)}}
-
application/json:
- itemID
Template: ShortText.
- accountID
Template: IDValue.
- accountCardAliasID
Template: IDValue.
- location
Field components:
-
Uses template:
Code. - Contains the following components: nameCode, communication.
-
Uses template:
- BBAN
Template: ShortText.
- IBAN
Template: ShortText.
- UPIC
Template: ShortText.
- financialParty
Field components:
-
Uses template:
Code. - Contains the following components: nameCode, address, financialPartyID, SWIFTCode, branchNameCode, routingTransitID, communication.
-
Uses template:
- financialAccount
Field components:
-
Uses template:
ShortText. - Contains the following components: accountNumber, accountName, typeCode, currencyCode, availableBalanceAmount, accountTransactions.
-
Uses template:
- event
Template: PostEvent.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/core/v1/associates/{{=parameters.aoid}}/notifications.
The result is extracted from:{{=response.notifications}}.The action has the following user-defined parameters:
- aoid: Required. Specify Associate OID.
- receiptDate
Template: Date.
- originatorName
Template: ShortText.
- notificationType
Template: LocCode.
- priority
Template: LocCode.
- readIndicator
Data type: DT_BOOL
- subject
Template: ShortText.
- notificationUri
Field components:
-
Uses template:
ShortText. - Contains the following components: href.
-
Uses template:
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/talent/v2/associates/{{=parameters.aoid}}/associate-competencies.
The result is extracted from:{{=response.associateCompetencies}}.The action has the following user-defined parameters:
- aoid: Required. Specify Associate OID.
The resource includes the fields from the Competency template.
- itemID
Template: ShortText.
- hasCompetencyIndicator
Data type: DT_BOOL
- competencyDimensions
Field components:
- An array.
- Contains the following components: itemID, hasDimensionIndicator, dimensionNameCode, selfAssessedProficiencyScore.
- customFieldGroup
Template: CustomFieldGroup.
- links
Template: Links.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/core/v1/associates/{{=parameters.aoid}}/calendar-details/my-calendar.
The result is extracted from:{{=response.calendarDetail.calendar.calendarEvents}}.
The result is paginated.The action has the following user-defined parameters:
- aoid: Required. Specify Associate OID.
The following request parameters will be automatically processed:
-
$top:
-
$skip:
-
limit:
{{=parameters.batchSize}} -
offset:
{{=parameters.iterator}}
- calendarEventID
Template: ShortText.
- category
Field components:
-
Uses template:
ShortText. - Contains the following components: code, name.
-
Uses template:
- eventType
Field components:
-
Uses template:
ShortText. - Contains the following components: code, name.
-
Uses template:
- subject
Template: ShortText.
- timePeriod
Template: DateTimePeriod2.
- priority
Field components:
-
Uses template:
ShortText. - Contains the following components: code, name.
-
Uses template:
- calendarEventUri
Field components:
-
Uses template:
ShortText. - Contains the following components: href.
-
Uses template:
- objectRefUri
Field components:
-
Uses template:
ShortText. - Contains the following components: href.
-
Uses template:
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/core/v1/compliance-management/documents.
The result is extracted from:{{=response.documents}}.
The result is paginated.
- itemID
Template: ShortText.
- sourceApplicationFeatureID
Template: ShortText.
- documentTitle
Template: ShortText.
- documentDescription
Template: ShortText.
- documentTypeCode
Template: Code.
- fileTypeCode
Template: Code.
- categoryCode
Template: Code.
- subCategoryCode
Template: Code.
- mediaType
Template: ShortText.
- uploadedBy
Field components:
-
Uses template:
ShortText. - Contains the following components: associateOID, formattedName.
-
Uses template:
- uploadedDateTime
Template: DateTime.
- updatedBy
Field components:
-
Uses template:
ShortText. - Contains the following components: associateOID, formattedName.
-
Uses template:
- updatedDateTime
Template: DateTime.
- owner
Field components:
-
Uses template:
ShortText. - Contains the following components: associateOID, formattedName.
-
Uses template:
- organizationalUnitIDSets
Field components:
- An array.
- fileName
Template: ShortText.
- fileSize
Data type: DT_I4
- numberOfPages
Data type: DT_I4
- versionID
Template: ShortText.
- keywords
Template: ShortText.
- eSignatureSignedBy
Field components:
-
Uses template:
ShortText. - Contains the following components: associateOID, formattedName.
-
Uses template:
- eSignatureStatusCode
Template: Code.
- eSignatureSignedDate
Template: Date.
- eSignatureRequester
Field components:
-
Uses template:
ShortText. - Contains the following components: associateOID, formattedName.
-
Uses template:
- eSignatureRequestedDate
Template: Date.
- effectiveDateTime
Template: DateTime.
- expirationDateTime
Template: DateTime.
- documentStatusCode
Template: StatusCode.
- uploadStatusCode
Template: StatusCode.
- legacyID
Template: ShortText.
- applicationReferenceID
Template: ShortText.
- privateIndicator
Data type: DT_BOOL
- readOnlyIndicator
Data type: DT_BOOL
- customStringFields
Field components:
- An array.
- Contains the following components: itemID, nameCode, stringValue.
- links
Template: Links.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/payroll/v1/associates/{{=parameters.aoid}}/financial-account-details.
The result is extracted from:{{=response.financialAccountDetails.financialAccounts}}.
The result is paginated.The action has the following user-defined parameters:
- aoid: Required. Specify Associate OID.
The following request parameters will be automatically processed:
-
$top:
-
$skip:
-
limit:
{{=parameters.batchSize}} -
offset:
{{=parameters.iterator}}
- accountID
Template: PositionID.
- accountName
Template: ShortText.
- accountType
Template: LocCode.
- availableBalanceAmount
Template: Amount.
- accountTransactionDetails
Field components:
- An array.
- Contains the following components: transactionType, totalAmount, accountTransactions.
- cardIDs
Field components:
- An array.
- Contains the following components: cardID, cardUri.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/hr/v1/organizational-assets.
The result is extracted from:{{=response.organizationalAssets}}.
- itemID
Template: ShortText.
- assetID
Template: ShortText.
- assetTypeCode
Template: Code.
- manufacturerCode
Template: Code.
- modelID
Template: ShortText.
- serialNumber
Template: ShortText.
- assetStatusCode
Template: Code.
- availabilityStatusCode
Template: Code.
- descriptionText
Template: ShortText.
- assetValueAmount
Template: Amount.
- listPriceAmount
Template: Amount.
- costAmount
Template: Amount.
- specifications
Field components:
- An array.
- Contains the following components: itemID, specificationCode, specificationTypeCode, textValues, links.
- acquisitionDate
Template: Date.
- links
Template: Links.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/core/v1/paycard/organization-locations.
The result is extracted from:{{=response.locations}}.
- itemID
Template: ShortText.
- nameCode
Template: Code.
- aliasNames
Field components:
- An array.
- addresses
Field components:
- An array.
-
Uses template:
Address.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/staffing/v1/work-fulfillment/user-feedbacks.
The result is extracted from:{{=response.userFeedbacks}}.
- [Create] action
-
Endpoint URL address:
/events/staffing/v1/work-fulfillment/{{=item.event && item.event.eventNameCode.codeValue}}.The following request parameters will be automatically processed:
-
application/json:
{{=ADP.getActionData('userFeedback', item)}}
-
application/json:
- itemID
Template: ShortText.
- ratings
Field components:
- An array.
- Contains the following components: itemID, ratingCategoryCode, ratingValueCode.
- feedbackText
Template: ShortText.
- attachments
Field components:
- An array.
- Contains the following components: nameCode, attachmentLink, textValue.
- associatedObject
Field components:
-
Uses template:
IDValue. - Contains the following components: objectID, objectNameCode.
-
Uses template:
- feedbackContextCode
Template: Code.
- event
Template: PostEvent.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/talent/v2/associates/{{=parameters.aoid}}/associate-certifications.
The result is extracted from:{{=response.associateCertifications}}.The action has the following user-defined parameters:
- aoid: Required. Specify Associate OID.
The resource includes the fields from the Certification template.
- itemID
Template: ShortText.
- certificationID
Template: IDValue.
- issuingParty
Field components:
-
Uses template:
Code. - Contains the following components: nameCode, address.
-
Uses template:
- customFieldGroup
Template: CustomFieldGroup.
- links
Template: Links.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/hr/v1/associate-contacts.
The result is extracted from:{{=response.associateContacts}}.
- associateOID
Template: ShortText.
- legalName
Template: ShortName.
- preferredName
Template: ShortName.
- communication
Template: Communication.
- businessCommunication
Template: Communication.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/talent/v2/associates/{{=parameters.aoid}}/associate-licenses.
The result is extracted from:{{=response.associateLicenses}}.The action has the following user-defined parameters:
- aoid: Required. Specify Associate OID.
The resource includes the fields from the License template.
- itemID
Template: ShortText.
- endorsements
Field components:
- An array.
- Contains the following components: itemID, endorsementNameCode, issuingParty.
- restrictions
Field components:
- An array.
- Contains the following components: itemID, restrictionNameCode, issuingParty.
- violations
Field components:
- An array.
- Contains the following components: itemID, violationNameCode, violationPoints, issuingParty.
- customFieldGroup
Template: CustomFieldGroup.
- links
Template: Links.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/hr/v1/organizational-asset-assignments.
The result is extracted from:{{=response.organizationalAssetAssignments}}.
- itemID
Template: ShortText.
- assignmentDate
Template: Date.
- assignedAssets
Field components:
- An array.
- Contains the following components: itemID, assetTypeCode, manufacturerCode, modelID, serialNumber, assetStatusCode, availabilityStatusCode, descriptionText, assetValueAmount, listPriceAmount, costAmount, specifications, acquisitionDate, returnDate, assetID, relatedAssetID, links.
- associateOID
Template: ShortText.
- workerID
Template: IDValue.
- organizationalUnits
Template: OrganizationalUnits.
- workAssignmentID
Template: ShortText.
- descriptionText
Template: ShortText.
- formattedName
Template: ShortText.
- links
Template: Links.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/hr/v1/workers/{{=parameters.aoid}}/policy-acknowledgements.
The result is extracted from:{{=response.policyAcknowledgements}}.The action has the following user-defined parameters:
- aoid: Required. Specify Associate OID.
- objectID
Template: ShortText.
- policyID
Template: PositionID.
- policyName
Template: ShortText.
- policyDescription
Template: ShortText.
- policyVersionID
Template: ShortText.
- acknowledgementRequiredIndicator
Data type: DT_BOOL
- policyStatusCode
Template: StatusCode.
- links
Template: Links.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/core/v1/paycard/disclosures.
The result is extracted from:{{=response.disclosures}}.
- [Create] action
-
Endpoint URL address:
/events/core/v1/paycard/{{=item.event && item.event.eventNameCode.codeValue}}.The following request parameters will be automatically processed:
-
application/json:
{{=ADP.getActionData('disclosure', item)}}
-
application/json:
- itemID
Template: ShortText.
- disclosureTypeCode
Template: Code.
- acceptanceRequiredIndicator
Data type: DT_BOOL
- contentLink
Template: Link.
- contentLanguageCode
Template: Code.
- event
Template: PostEvent.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/talent/v2/associates/{{=parameters.aoid}}/associate-recognitions.
The result is extracted from:{{=response.associateRecognitions}}.The action has the following user-defined parameters:
- aoid: Required. Specify Associate OID.
The resource includes the fields from the Recognition template.
- itemID
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/talent/v2/associates/{{=parameters.aoid}}/associate-educational-degrees.
The result is extracted from:{{=response.associateEducationalDegrees}}.The action has the following user-defined parameters:
- aoid: Required. Specify Associate OID.
The resource includes the fields from the EducationalDegree template.
- itemID
Template: ShortText.
- educationalInstitutionAttendances
Field components:
- An array.
- Contains the following components: itemID, attendancePeriods, educationalInstitution, degreeIssuedIndicator.
- customFieldGroup
Template: CustomFieldGroup.
- links
Template: Links.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/payroll/v1/atm-locator.
The result is extracted from:{{=response.atmLocator}}.
- locationType
Field components:
-
Uses template:
ShortText. - Contains the following components: code, labelName, colorCode.
-
Uses template:
- locations
Field components:
- An array.
- Contains the following components: labelName, coordinate, distance, address, locationPropertyCodes.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/core/v1/associates/{{=parameters.aoid}}/news.
The result is extracted from:{{=response.news}}.The action has the following user-defined parameters:
- aoid: Required. Specify Associate OID.
- categoryCodeName
Template: ShortText.
- publicationDateTime
Template: DateTime.
- subject
Template: ShortText.
- descriptionText
Template: ShortText.
- newsEventUri
Field components:
-
Uses template:
ShortText. - Contains the following components: href.
-
Uses template:
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/talent/v2/associates/{{=parameters.aoid}}/associate-languages.
The result is extracted from:{{=response.associateLanguages}}.The action has the following user-defined parameters:
- aoid: Required. Specify Associate OID.
- itemID
Template: ShortText.
- hasCompetencyIndicator
Data type: DT_BOOL
- competencyDimensions
Field components:
- An array.
- Contains the following components: itemID, dimensionNameCode, hasDimensionIndicator, selfAssessedProficiencyScore.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/talent/v2/associates/{{=parameters.aoid}}/associate-memberships.
The result is extracted from:{{=response.associateMemberships}}.The action has the following user-defined parameters:
- aoid: Required. Specify Associate OID.
- itemID
Template: ShortText.
- membershipOrganization
Field components:
-
Uses template:
ShortText. - Contains the following components: chapterID, nameCode, address.
-
Uses template:
- customFieldGroup
Template: CustomFieldGroup.
- links
Template: Links.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/hr/v1/workers/{{=parameters.aoid}}/business-credit-cards.
The result is extracted from:{{=response.workerBusinessCreditCards}}.The action has the following user-defined parameters:
- aoid: Required. Specify Associate OID.
- itemID
Template: ShortText.
- associateOID
Template: ShortText.
- workerID
Template: IDValue.
- organizationalUnits
Template: OrganizationalUnits.
- workAssignmentID
Template: ShortText.
- businessCreditCards
Field components:
- An array.
- Contains the following components: itemID, cardTypeCode, cardNumber, securityCode, expirationDate, issueDate, returnDate, issuerParty, owningParty, cardStatusCode, accountStatusCode, primaryIndicator, cardholderName, billToPartyCode, links.
- links
Template: Links.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/payroll/v1/paycard/cardholders/{{=parameters.aoid}}/card-usage-expansions.
The result is extracted from:{{=response.cardsUsageExpansion}}.The action has the following user-defined parameters:
- aoid: Required. Specify Associate OID.
- itemID
Template: ShortText.
- cardID
Template: LongText. A composite field.
- cardAccount
Field components:
-
Uses template:
IDValue. - Contains the following components: routingTransitID, accountNumber.
-
Uses template:
- geoGraphicalBoundries
Field components:
- An array.
- Contains the following components: itemID, countrySubdivisionLevel1, countryCode, datePeriod.
- actions
Template: Actions.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/payroll/v1/paycard/consumer-fees.
The result is extracted from:{{=response.consumerFees}}.
- itemID
Template: ShortText.
- nameCode
Template: Code.
- percentage
Data type: DT_I4
- percentageBasisCode
Template: Code.
- amountValue
Data type: DT_R8
- currencyCode
Template: ShortText.
- unitTimeCode
Template: Code.
- links
Template: Links.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/time/v1/workers/{{=parameters.aoid}}/work-schedule-entry-swap-requests.
The result is extracted from:{{=response.scheduleEntrySwapRequests}].The action has the following user-defined parameters:
- aoid: Required. Specify Associate OID.
- requestID
Template: ShortText.
- requestDateTime
Template: DateTime.
- requestedApprovalDate
Template: Date.
- reviewRequest
Field components:
-
Uses template:
StatusCode. - Contains the following components: reviewStatusCode, comment, reviewDetails.
-
Uses template:
- requestorName
Template: ShortName.
- associateOID
Template: ShortText.
- workAssignmentID
Template: ShortText.
- workerName
Template: ShortName.
- comments
Field components:
- An array.
-
Uses template:
Comment.
- scheduleEntry
Field components:
-
Uses template:
ShortText. - Contains the following components: entryID, datePeriod, totalQuantity, earningAllocations.
-
Uses template:
- requestedSwaps
Field components:
- An array.
- Contains the following components: itemID, scheduleEntry, associateOID, workAssignmentID, workerName, reviewRequest.
- actions
Template: Actions.
- [Read] action
-
The following request parameters will be automatically processed:
-
$top:
{{=parameters.batchSize}} -
$skip:
{{=parameters.iterator}} -
_includeUserParameters:
{{=parameters}}
-
$top:
- [Create] action
-
The action uses POST method.The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}} -
application/json:
{{=item}}
-
_includeUserParameters:
- [Update] action
-
The action uses PUT method.The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}} -
application/json:
{{=item}}
-
_includeUserParameters:
- [Delete] action
-
The action uses DELETE method.
- ShortText
Data type: DT_WSTR ( length 255 )
- LongText
Data type: DT_WSTR ( length 1000 )
- DateTime
Data type: DT_DBTIMESTAMP
- Date
Data type: DT_DBDATE
- Code
Field components:
-
Uses template:
ShortText. - Contains the following components: codeValue, shortName, longName.
-
Uses template:
- StatusCode
Template: Code. Field components:
-
Uses template:
Date. - Contains the following components: effectiveDate.
-
Uses template:
- SubdivisionType
Template: Code. Field components:
-
Uses template:
ShortText. - Contains the following components: subdivisionType.
-
Uses template:
- GeoCoordinate
Field components:
- Contains the following components: latitude, longitude.
- Link
Field components:
-
Uses template:
ShortText. - Contains the following components: href, rel, canonicalUri, title, targetSchema, mediaType, method, encType, schema, payLoadArguments.
-
Uses template:
- Links
Field components:
- An array.
-
Uses template:
Link.
- DatePeriod
Field components:
-
Uses template:
Date. - Contains the following components: startDate, endDate.
-
Uses template:
- DateTimePeriod2
Field components:
-
Uses template:
DateTime. - Contains the following components: startDateTime, endDateTime.
-
Uses template:
- DateTimePeriod4
Field components:
-
Uses template:
Date. - Contains the following components: startDate, startTime, endDate, endTime.
-
Uses template:
- Address
Field components:
-
Uses template:
Code. - Contains the following components: nameCode, attentionOfName, careOfName, lineOne, lineTwo, lineThree, cityName, countrySubdivisionLevel1, countryCode, postalCode, geoCoordinate, scriptCode, lineFour, lineFive, buildingNumber, buildingName, blockName, streetName, streetTypeCode, unit, floor, stairCase, door, postOfficeBox, deliveryPoint, plotID, countrySubdivisionLevel2, sameAsAddressIndicator, sameAsAddressLink.
-
Uses template:
- ShortName
Field components:
-
Uses template:
ShortText. - Contains the following components: givenName, middleName, familyName1, familyName2, formattedName.
-
Uses template:
- Name
Field components:
-
Uses template:
ShortText. - Contains the following components: givenName, middleName, familyName1, familyName2, formattedName, nameCode, scriptCode, preferredSalutations, titlePrefixCodes, nickName, generationAffixCode, qualificationAffixCode, titleAffixCodes, familyName1Prefix, familyName2Prefix, initials.
-
Uses template:
- Phone
Field components:
-
Uses template:
Code. - Contains the following components: nameCode, countryDialing, areaDialing, dialNumber, extension, access, formattedNumber, notificationIndicator.
-
Uses template:
- Amount
Field components:
-
Uses template:
Code. - Contains the following components: nameCode, amountValue, currencyCode.
-
Uses template:
- Hours
Field components:
-
Uses template:
Code. - Contains the following components: hoursQuantity, unitCode.
-
Uses template:
- Uri
Field components:
-
Uses template:
Code. - Contains the following components: nameCode, uri, notificationIndicator.
-
Uses template:
Field components:
-
Uses template:
Code. - Contains the following components: nameCode, emailUri, notificationIndicator.
-
Uses template:
- Passport
Field components:
-
Uses template:
ShortText. - Contains the following components: documentID, countryCode, typeCode, issuingParty, issueDate, expirationDate.
-
Uses template:
- Notes
Field components:
- An array.
- Contains the following components: itemID, userName, associateRef, entryDateTime, appliesToElementName, commentType, noteText, privateNoteIndicator, metadataEntitlementCodes.
- Allocation
Field components:
-
Uses template:
ShortText. - Contains the following components: labelName, tableID, valueText.
-
Uses template:
- ItemTotal
Field components:
-
Uses template:
ShortText. - Contains the following components: codeName, rateCode, remunerationTypeCode, workShiftCode, earningAllocations, hoursValue, totalUnitValue, totalAmount, payNumber.
-
Uses template:
- LocCode
Field components:
-
Uses template:
ShortText. - Contains the following components: code, labelName.
-
Uses template:
- EntryStatus
Template: LocCode. Field components:
-
Uses template:
Date. - Contains the following components: effectiveDate.
-
Uses template:
- Table
Field components:
-
Uses template:
ShortText. - Contains the following components: labelName, tableID, typeCode, requiredIndicator, defaultCode, tableUri, table.
-
Uses template:
- Summary
Field components:
-
Uses template:
ShortText. - Contains the following components: entryID, codeName, totalAmount, timeEntryStatus, reasonCode, entryUri, exceptionType, metadataEntitlementCodes, earningAllocations, noteIndicator, entryNotes.
-
Uses template:
- TimeWorkedQuantity
Field components:
-
Uses template:
Code. - Contains the following components: quantityValue, unitTimeCode.
-
Uses template:
- PayrollAccumulations
Field components:
- An array.
- Contains the following components: itemID, accumulatorCode, accumulatorDescription, accumulatorTimeUnitCode, accumulatedAmount, accumulatedTimeWorkedQuantity.
- Communication
Field components:
- Contains the following components: landlines, mobiles, emails, socialNetworks, faxes, pagers, internetAddresses, instantMessages.
- IDValue
Field components:
-
Uses template:
ShortText. - Contains the following components: idValue, schemeCode.
-
Uses template:
- Account
Field components:
-
Uses template:
ShortText. - Contains the following components: BBAN, IBAN, UPIC, financialParty, financialAccount.
-
Uses template:
- ConfigurationTags
Field components:
- An array.
- Contains the following components: tagCode, tagType, tagValues.
- ImpoundInformation
Field components:
-
Uses template:
Code. - Contains the following components: impoundPartyCode, impoundAccount, configurationTags.
-
Uses template:
- TransactionID
Template: IDValue. Field components:
-
Uses template:
ShortText. - Contains the following components: idDescription, alternateDescriptions.
-
Uses template:
- StatutoryDeduction
Field components:
-
Uses template:
Code. - Contains the following components: statutoryJurisdiction, statutoryDeductionTypeCode, associateDeductionAmount, associateDeductionTakenAmount, associateDeductionUntakenAmount, associateDeductionInArrearsAmount, associateDeductionCarryOverAmount, associateTaxableAmount, employerTaxableAmount, employerPaidAmount, payrollAccumulations, configurationTags.
-
Uses template:
- NonStatutoryDeduction
Field components:
-
Uses template:
TransactionID. - Contains the following components: deductionID, associateDeductionAmount, associateDeductionTakenAmount, associateDeductionUntakenAmount, associateDeductionInArrearsAmount, associateDeductionCarryOverAmount, payrollAccumulations, configurationTags.
-
Uses template:
- UnitQuantity
Field components:
-
Uses template:
Code. - Contains the following components: quantityValue, unitCode.
-
Uses template:
- MemoItem
Field components:
-
Uses template:
TransactionID. - Contains the following components: memoID, memoAmount, memoQuantity, payrollAccumulations, configurationTags.
-
Uses template:
- ReimbursementsItem
Field components:
-
Uses template:
TransactionID. - Contains the following components: reimbursementID, reimbursementAmount, payrollAccumulations, configurationTags.
-
Uses template:
- ReportableEarningsAndBenefitsItem
Field components:
-
Uses template:
TransactionID. - Contains the following components: reportableEarningAndBenefitID, reportableEarningAndBenefitAmount, payrollAccumulations, configurationTags.
-
Uses template:
- EarningsItem
Field components:
-
Uses template:
TransactionID. - Contains the following components: earningID, earningClassificationCode, earningAmount, timeWorkedQuantity, configurationTags.
-
Uses template:
- Section
Field components:
-
Uses template:
ShortText. - Contains the following components: sectionCategory, sectionName.
-
Uses template:
- Rate
Field components:
-
Uses template:
ShortText. - Contains the following components: rateValue, currencyCode, unitCode, baseUnitCode, baseMultiplierValue.
-
Uses template:
- PayrollInstruction
Field components:
-
Uses template:
ShortText. - Contains the following components: itemID, payrollRegionCode, payrollGroupCode, payrollFileNumber, generalDeductionInstructions, garnishmentInstructions, benefitInstructions, retirementPlanInstructions.
-
Uses template:
- Author
Field components:
-
Uses template:
ShortText. - Contains the following components: associateOID, roleCode, formattedName.
-
Uses template:
- Comment
Field components:
-
Uses template:
DateTime. - Contains the following components: entryDateTime, author, textValue, commentCode, appliesToCode.
-
Uses template:
- EntryOverrideCodes
Field components:
- An array.
- Contains the following components: itemID, overrideCode, overrideTypeCode.
- ClockEntry
Field components:
-
Uses template:
ShortText. - Contains the following components: entryID, workAssignmentID, punchLocation, comments, links, deviceDateTime, entryDateTime, actionCode, validGeoLocationID, laborAllocations, entryOverrideCodes.
-
Uses template:
- CustomFieldGroup
Field components:
-
Uses template:
Links. - Contains the following components: amountFields, codeFields, dateFields, dateTimeFields, indicatorFields, numberFields, percentFields, stringFields, telephoneFields, links.
-
Uses template:
- Actions
Field components:
- An array.
- Contains the following components: operationID, canonicalUri, actionTypeCode, requestConfirmationIndicator, confirmationRequiredIndicator, commentAllowedIndicator, commentIndicator, defaultIndicator, sequence, colorCode, attestation, effectiveDateIndicator, effectiveDate, links.
- ExceptionItem
Field components:
-
Uses template:
Code. - Contains the following components: exceptionCode, exceptionTypeCode, exceptionDescription, actions, acknowledgementIndicator, links.
-
Uses template:
- TimeCard
Field components:
-
Uses template:
ShortText. - Contains the following components: timeCardID, reviewRequest, comment, reviewDetails, links, processingStatusCode, periodCode, periodStatusCode, timePeriod, associateOID, workerID, personLegalName, positionID, positionTitle, jobCode, jobTitle, workAssignmentID, exceptionCounts, periodTotals, dailyTotals, totalPeriodHourQuantity, totalPeriodTimeDuration, homeLaborAllocations, entryCommentIndicator, dayEntries, comments, actions, exceptionsIndicator.
-
Uses template:
- Status
Field components:
-
Uses template:
Code. - Contains the following components: statusCode, reasonCode, effectiveDate.
-
Uses template:
- PositionID
Field components:
-
Uses template:
ShortText. - Contains the following components: id, schemeName, schemeAgencyName.
-
Uses template:
- TimeQuantity
Field components:
-
Uses template:
ShortText. - Contains the following components: valueNumber, unitTimeCode, labelName.
-
Uses template:
- TimeValue
Field components:
-
Uses template:
ShortText. - Contains the following components: timeValue, labelName.
-
Uses template:
- RatePercentage
Field components:
-
Uses template:
Code. - Contains the following components: nameCode, percentageValue, baseUnitCode.
-
Uses template:
- Score
Field components:
-
Uses template:
Code. - Contains the following components: unitCode, scoreValue, scoreCode.
-
Uses template:
- Competency
Field components:
-
Uses template:
Code. - Contains the following components: competencyNameCode, competencyDescription, categoryCode, acquisitionDate, lastUsedDate, experienceDuration, selfAssessedProficiencyScore.
-
Uses template:
- EducationalDegree
Field components:
-
Uses template:
Code. - Contains the following components: nameCode, typeCode, statusCode, startDate, expectedCompletionDate, actualCompletionDate, completionDuration, academicCreditTypeCode, academicCreditsCompleted, issueDate, academicScore, majorProgramNameCodes, minorProgramNameCodes, honorsProgramNameCodes.
-
Uses template:
- Certification
Field components:
-
Uses template:
Code. - Contains the following components: certificationNameCode, certificationDescription, categoryCode, statusCode, firstIssueDate, lastIssueDate, expirationDate.
-
Uses template:
- Language
Field components:
-
Uses template:
Code. - Contains the following components: languageCode, nativeLanguageIndicator, acquisitionDate, lastUsedDate, experienceDuration, selfAssessedProficiencyScore.
-
Uses template:
- License
Field components:
-
Uses template:
IDValue. - Contains the following components: licenseID, licenseNameCode, licenseDescription, categoryCode, statusCode, firstIssueDate, lastIssueDate, expirationDate.
-
Uses template:
- Membership
Field components:
-
Uses template:
IDValue. - Contains the following components: membershipID, typeCode, memberTitle, membershipDescription, memberSinceDate, expirationDate.
-
Uses template:
- Recognition
Field components:
-
Uses template:
Code. - Contains the following components: nameCode, typeCode, issuingParty, issueDate, customFieldGroup.
-
Uses template:
- PayRate
Field components:
-
Uses template:
Amount. - Contains the following components: hourlyRateAmount, dailyRateAmount, weeklyRateAmount, monthlyRateAmount, annualRateAmount, commissionRatePercentage.
-
Uses template:
- EmploymentHistory
Field components:
- An array.
- Contains the following components: itemID, employmentStartDate, employmentEndDate, employerName, employerAddress, employerCommunication, allowContactEmployerIndicator, currentEmployerIndicator, positionHistory, links.
- Attachment
Field components:
-
Uses template:
Code. - Contains the following components: nameCode, attachmentLink, textValue.
-
Uses template:
- BaseRemuneration
Template: PayRate. Field components:
-
Uses template:
Code. - Contains the following components: recordingBasisCode, biweeklyRateAmount, semiMonthlyRateAmount, payPeriodRateAmount, commissionRatePercentage.
-
Uses template:
- ReportsTo
Field components:
- An array.
- Contains the following components: itemID, positionID, positionTitle, associateOID, workerID, reportsToWorkerName, reportsToRelationshipCode.
- Classifications
Field components:
- An array.
- Contains the following components: itemID, nameCode, classificationCode.
- GovernmentIDs
Field components:
- An array.
- Contains the following components: itemID, idValue, nameCode, countryCode, statusCode, expirationDate.
- BirthPlace
Field components:
-
Uses template:
ShortText. - Contains the following components: cityName, countrySubdivisionLevel1, countrySubdivisionLevel2, postalCode, countryCode, formattedBirthPlace.
-
Uses template:
- WorkLocation
Field components:
-
Uses template:
Code. - Contains the following components: nameCode, communication, address.
-
Uses template:
- OrganizationalUnits
Field components:
- An array.
- Contains the following components: itemID, nameCode, typeCode.
- TimeEntry
Field components:
-
Uses template:
ShortText. - Contains the following components: timeSheetID, positionID, positionTitle, payPeriod, totalPayPeriodHours, timeSheetStatus, exceptionType, meta, payPeriodItemTotals, dailyItemTotals, entries.
-
Uses template:
- EventMessage
Field components:
-
Uses template:
ShortText. - Contains the following components: eventID, serviceCategoryCode, eventNameCode, eventTitle, eventReasonCode, eventStatusCode, priorityCode, recordDateTime, creationDateTime, effectiveDateTime, expirationDateTime, dueDateTime, originator, actor, links.
-
Uses template:
- PostEvent
Template: EventMessage. Field components:
- Contains the following components: actAsParty, onBehalfOfParty, data.
Knowledge Base
- ADP Connection Manager Out of Memory Error Message
- Where can I find the documentation for the ADP Connection?
- ADP Connection Manager unable to retrieve all the records
- How to export key pair and certificate to .pfx file.
What's New
- Fixed: Corrected resource pagination definitions.
- New: Introduced connection.
Related documentation
COZYROC SSIS+ Components Suite is free for testing in your development environment.
A licensed version can be deployed on-premises, on Azure-SSIS IR and on COZYROC Cloud.