Skip to main content

Get Connections Details

POST 
/getConnectionDetails

This API returns connection details in SSM.

The Authorization must have Bearer followed by Token.

Mandatory params: connectiontype or connectionname(if both are passed then connectionkey will be considered)

Request​

Body

    connectionkeystring
    Example: 120
    connectionnamestring
    Example: Workday

Responses​

Get Connections Details - Success

Response Headers

  • Access-Control-Allow-Credentials

    string

  • Access-Control-Allow-Origin

    string

  • Cache-Control

    string

  • Date

    string

  • Expires

    string

  • Referrer-Policy

    string

  • Server

    string

  • Set-Cookie

    string

  • Strict-Transport-Security

    string

  • X-Content-Type-Options

    string

  • X-Frame-Options

    string

Schema

    connectionattributes

    object

    ACCOUNTS_IMPORT_JSONstring
    Example:
    CHANGEPASSJSONstring
    COMBINEDCREATEREQUESTstring
    Example:
    CONNECTIONJSONstring
    Example: { "authentications": { "login": { "authType": "basic", "properties": { "SOAP_ENDPOINT": "https://wd2-impl-services1.workday.com/ccx/service/saviynt_pt1/Human_Resources/34.0", "USERNAME": "ISU001@saviynt_pt1", "PASSWORD": "S@v1ynt@321", "PASSWORD_TYPE": "PasswordText", "REQUESTPARAMS": { "CONTENT-TYPE": "text/xml;charset=UTF-8", "Connection": "Keep-Alive", "Keep-Alive": "timeout=600, max=1000" } } } } }
    CREATEACCOUNTJSONstring
    Example:
    DATA_TO_IMPORTstring
    Example:
    DATEFORMATstring
    Example:
    DELETEACCOUNTJSONstring
    Example:
    DISABLEACCOUNTJSONstring
    Example:
    ENABLEACCOUNTJSONstring
    Example:
    GRANTACCESSJSONstring
    Example:
    HR_IMPORT_JSONstring
    Example: { "REQUESTXML1": "<soapenv:Envelope xmlns:bsvc=\"urn:com.workday/bsvc\" xmlns:soapenv=\"http://schemas.xmlsoap.org/soap/envelope/\"><soapenv:Header><wsse:Security soapenv:mustUnderstand=\"1\" xmlns:wsse=\"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd\" xmlns:wsu=\"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd\"><wsse:UsernameToken wsu:Id=\"UsernameToken-AF7DBE0D8832CC288F150119366041544\"><wsse:Username>${USERNAME}</wsse:Username><wsse:Password Type=\"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText\">${PASSWORD}</wsse:Password><wsse:Nonce EncodingType=\"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-soap-message-security-1.0#Base64Binary\">hVovDsRjkofd3OphNZ83kg==</wsse:Nonce><wsu:Created>2017-07-27T22:14:20.415Z</wsu:Created></wsse:UsernameToken></wsse:Security></soapenv:Header><soapenv:Body><bsvc:Get_Workers_Request bsvc:version=\"v33.1\"><bsvc:Request_Criteria><bsvc:Exclude_Inactive_Workers>false</bsvc:Exclude_Inactive_Workers><bsvc:Exclude_Employees>false</bsvc:Exclude_Employees><bsvc:Exclude_Contingent_Workers>false</bsvc:Exclude_Contingent_Workers></bsvc:Request_Criteria><bsvc:Response_Filter><bsvc:Page>${PAGE_NUMBER}</bsvc:Page><bsvc:Count>${PAGE_SIZE}</bsvc:Count></bsvc:Response_Filter><bsvc:Response_Group><bsvc:Include_Reference>false</bsvc:Include_Reference><bsvc:Include_Personal_Information>true</bsvc:Include_Personal_Information><bsvc:Include_Additional_Jobs>false</bsvc:Include_Additional_Jobs><bsvc:Include_Employment_Information>true</bsvc:Include_Employment_Information><bsvc:Include_Compensation>false</bsvc:Include_Compensation><bsvc:Include_Organizations>true</bsvc:Include_Organizations><bsvc:Exclude_Organization_Support_Role_Data>true</bsvc:Exclude_Organization_Support_Role_Data><bsvc:Exclude_Location_Hierarchies>true</bsvc:Exclude_Location_Hierarchies><bsvc:Exclude_Cost_Centers>false</bsvc:Exclude_Cost_Centers><bsvc:Exclude_Cost_Center_Hierarchies>true</bsvc:Exclude_Cost_Center_Hierarchies><bsvc:Exclude_Companies>true</bsvc:Exclude_Companies><bsvc:Exclude_Company_Hierarchies>true</bsvc:Exclude_Company_Hierarchies><bsvc:Exclude_Matrix_Organizations>true</bsvc:Exclude_Matrix_Organizations><bsvc:Exclude_Pay_Groups>true</bsvc:Exclude_Pay_Groups><bsvc:Exclude_Regions>true</bsvc:Exclude_Regions><bsvc:Exclude_Region_Hierarchies>true</bsvc:Exclude_Region_Hierarchies><bsvc:Exclude_Supervisory_Organizations>true</bsvc:Exclude_Supervisory_Organizations><bsvc:Exclude_Teams>true</bsvc:Exclude_Teams><bsvc:Exclude_Custom_Organizations>true</bsvc:Exclude_Custom_Organizations><bsvc:Include_Roles>true</bsvc:Include_Roles><bsvc:Include_Management_Chain_Data>true</bsvc:Include_Management_Chain_Data><bsvc:Include_Multiple_Managers_in_Management_Chain_Data>false</bsvc:Include_Multiple_Managers_in_Management_Chain_Data><bsvc:Include_Benefit_Enrollments>false</bsvc:Include_Benefit_Enrollments><bsvc:Include_Benefit_Eligibility>false</bsvc:Include_Benefit_Eligibility><bsvc:Include_Related_Persons>false</bsvc:Include_Related_Persons><bsvc:Include_Qualifications>false</bsvc:Include_Qualifications><bsvc:Include_Employee_Review>false</bsvc:Include_Employee_Review><bsvc:Include_Goals>false</bsvc:Include_Goals><bsvc:Include_Development_Items>false</bsvc:Include_Development_Items><bsvc:Include_Skills>false</bsvc:Include_Skills><bsvc:Include_Photo>false</bsvc:Include_Photo><bsvc:Include_Worker_Documents>false</bsvc:Include_Worker_Documents><bsvc:Include_Transaction_Log_Data>false</bsvc:Include_Transaction_Log_Data><bsvc:Include_Subevents_for_Corrected_Transaction>false</bsvc:Include_Subevents_for_Corrected_Transaction><bsvc:Include_Subevents_for_Rescinded_Transaction>false</bsvc:Include_Subevents_for_Rescinded_Transaction><bsvc:Include_Succession_Profile>false</bsvc:Include_Succession_Profile><bsvc:Include_Talent_Assessment>false</bsvc:Include_Talent_Assessment><bsvc:Include_Employee_Contract_Data>true</bsvc:Include_Employee_Contract_Data><bsvc:Include_Collective_Agreement_Data>false</bsvc:Include_Collective_Agreement_Data><bsvc:Include_Probation_Period_Data>false</bsvc:Include_Probation_Period_Data><bsvc:Include_Feedback_Received>false</bsvc:Include_Feedback_Received><bsvc:Include_User_Account>false</bsvc:Include_User_Account><bsvc:Include_Career>false</bsvc:Include_Career><bsvc:Include_Account_Provisioning>false</bsvc:Include_Account_Provisioning><bsvc:Include_Background_Check_Data>false</bsvc:Include_Background_Check_Data><bsvc:Include_Contingent_Worker_Tax_Authority_Form_Information>false</bsvc:Include_Contingent_Worker_Tax_Authority_Form_Information><bsvc:Exclude_Funds>true</bsvc:Exclude_Funds><bsvc:Exclude_Fund_Hierarchies>true</bsvc:Exclude_Fund_Hierarchies><bsvc:Exclude_Grants>true</bsvc:Exclude_Grants><bsvc:Exclude_Grant_Hierarchies>true</bsvc:Exclude_Grant_Hierarchies><bsvc:Exclude_Business_Units>true</bsvc:Exclude_Business_Units><bsvc:Exclude_Business_Unit_Hierarchies>true</bsvc:Exclude_Business_Unit_Hierarchies><bsvc:Exclude_Programs>true</bsvc:Exclude_Programs><bsvc:Exclude_Program_Hierarchies>true</bsvc:Exclude_Program_Hierarchies><bsvc:Exclude_Gifts>true</bsvc:Exclude_Gifts><bsvc:Exclude_Gift_Hierarchies>true</bsvc:Exclude_Gift_Hierarchies></bsvc:Response_Group></bsvc:Get_Workers_Request></soapenv:Body></soapenv:Envelope>", "USERMAPPING1": "CITY:Worker_Data.Personal_Data.Contact_Data.Address_Data(Usage_Data->Type_Data->Type_Reference->ID=='WORK').Municipality,COMPANYNAME:Worker_Data.Employment_Data.Worker_Job_Data.Position_Organizations_Data.Position_Organization_Data.Organization_Data.Organization_Name,COSTCENTER:Worker_Data.Employment_Data.Worker_Job_Data.Position_Organizations_Data.Position_Organization_Data.Organization_Data.Organization_Code,COUNTRY:Worker_Data.Employment_Data.Worker_Job_Data.Position_Data.Business_Site_Summary_Data.Address_Data.Country_Reference.ID(@type=='ISO_3166-1_Alpha-3_Code'),CUSTOMPROPERTY16:Worker_Data.Employment_Data.Worker_Job_Data.Position_Data.Job_Profile_Summary_Data.Job_Family_Reference.ID(@type=='Job_Family_ID'),CUSTOMPROPERTY18:Worker_Data.Personal_Data.Name_Data.Preferred_Name_Data.Name_Detail_Data.Last_Name,CUSTOMPROPERTY20:Worker_Data.Employment_Data.Worker_Job_Data.Position_Data.Pay_Rate_Type_Reference.ID(@type=='Pay_Rate_Type_ID'),CUSTOMPROPERTY21:Worker_Data.Employment_Data.Worker_Job_Data.Position_Data.Business_Site_Summary_Data.Name,CUSTOMPROPERTY22:Worker_Data.User_ID,EMAIL:Worker_Data.Personal_Data.Contact_Data.Email_Address_Data(Usage_Data->Type_Data->Type_Reference->ID=='WORK').Email_Address,EMPLOYEEID:Worker_Data.Worker_ID,FIRSTNAME:Worker_Data.Personal_Data.Name_Data.Legal_Name_Data.Name_Detail_Data.First_Name,JOBCODE:Worker_Data.Employment_Data.Worker_Job_Data.Position_Data.Job_Profile_Summary_Data.Job_Profile_Reference.ID(@type=='Job_Profile_ID'),JOBCODEDESC:Worker_Data.Employment_Data.Worker_Job_Data.Position_Data.Job_Profile_Summary_Data.Job_Profile_Name,LASTNAME:Worker_Data.Personal_Data.Name_Data.Legal_Name_Data.Name_Detail_Data.Last_Name,LOCATION:Worker_Data.Employment_Data.Worker_Job_Data.Position_Data.Business_Site_Summary_Data.Location_Reference.ID(@type=='Location_ID'),CUSTOMPROPERTY30:Worker_Data.Employment_Data.Worker_Job_Data.Position_Data.Business_Site_Summary_Data.Location_Reference.ID(@type=='Location_ID'),LOCATIONDESC:Worker_Data.Employment_Data.Worker_Job_Data.Position_Data.Business_Site_Summary_Data.Location_Type_Reference.ID(@type=='Location_Type_ID'), MIDDLENAME:Worker_Data.Personal_Data.Name_Data.Legal_Name_Data.Name_Detail_Data.Middle_Name,PHONENUMBER:Worker_Data.Personal_Data.Contact_Data.Phone_Data(Usage_Data->Type_Data->Type_Reference->ID=='WORK').@Formatted_Phone,PREFEREDFIRSTNAME:Worker_Data.Personal_Data.Name_Data.Preferred_Name_Data.Name_Detail_Data.First_Name,REGIONCODE:Worker_Data.Personal_Data.Contact_Data.Address_Data(Usage_Data->Type_Data->Type_Reference->ID=='WORK').Postal_Code,STARTDATE:Worker_Data.Employment_Data.Worker_Status_Data.Hire_Date,STATE:Worker_Data.Personal_Data.Contact_Data.Address_Data(Usage_Data->Type_Data->Type_Reference->ID=='WORK').Country_Region_Descriptor,STATUSKEY:Worker_Data.Employment_Data.Worker_Status_Data.Active,STREET:Worker_Data.Personal_Data.Contact_Data.Address_Data(Usage_Data->Type_Data->Type_Reference->ID=='WORK').Address_Line_Data(@Type=='ADDRESS_LINE_1'),TITLE:Worker_Data.Employment_Data.Worker_Job_Data.Position_Data.Business_Title,USERNAME:Worker_Data.Worker_ID,OWNER:Worker_Data.Employment_Data.Worker_Job_Data.Position_Data.Manager_as_of_last_detected_manager_change_Reference.ID(@type=='Employee_ID')", "PREFIX1": "wd", "RESPONSETOTALRESULTS1": "Body.Get_Workers_Response.Response_Results.Total_Results", "RESPONSEPAGERESULTS1": "Body.Get_Workers_Response.Response_Results.Page_Results", "RESPONSEDATAPATH1": "Body.Get_Workers_Response.Response_Data.Worker" }
    PAGE_SIZEstring
    Example:
    PASSWORDstring
    Example: y//A5/5dsRuThK42K5e8rA==
    PASSWORD_MAX_LENGTHstring
    Example:
    PASSWORD_MIN_LENGTHstring
    Example:
    PASSWORD_NOOFCAPSALPHAstring
    Example:
    PASSWORD_NOOFDIGITSstring
    Example:
    PASSWORD_NOOFSPLCHARSstring
    Example:
    PASSWORD_TYPEstring
    Example: PasswordText
    RESPONSEPATH_PAGERESULTSstring
    Example:
    RESPONSEPATH_TOTALRESULTSstring
    Example:
    RESPONSEPATH_USERLISTstring
    Example:
    REVOKEACCESSJSONstring
    Example:
    SOAP_ENDPOINTstring
    Example: https://wd2-impl-services1.workday.com/ccx/service/saviynt_pt1/Human_Resources/34.0
    UPDATEACCOUNTJSONstring
    Example:
    UPDATEUSERJSONstring
    Example:
    USERNAMEstring
    Example: ISU001@saviynt_pt1
    connectionkeynumber
    Example: 120
    connectionnamestring
    Example: Workday
    connectiontypestring
    Example: Workday-SOAP
    createdbystring
    Example: admin(null null)
    createdonstring
    Example: 2020-03-12T11:49:15Z
    defaultsavrolesstring
    Example:
    descriptionstring
    Example: Workday
    emailtemplatestring
    Example:
    errorcodenumber
    Example: 0
    msgstring
    Example: success
    statusnumber
    Example: 1
    updatedbystring
    Example: admin(adminfname adminlname)