Dimension Member Name Update API

1 Minute to read

Print
Dark
Light
PDF

Article summary

Did you find this summary helpful?

Thank you for your feedback

Usage

This API updates the dimension member's name in a given dimension for the Main Hierarchy. The dimension member name update is available for Financial Dimension members.

Note:

Users cannot update the Dimension Member code.

Request

Shell Syntax

UpdateDimensionMembersResponse UpdateNameforDimensionMember(string DimensionCode, List<DimensionMembers> Dimension Members, string LoginName, string Password, string TenantCode)

Parameters

DimensionCode (string) - Provide the dimension name
Code (string) - Provide the dimension member code to identify the member to update the name
Name (string) - Provide the new name for the dimension member
LoginName, Password, and TenantCode – Provide user credentials to authenticate the API connection

XML

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://www.demo.planful.com/API/SOAP">
   <soapenv:Header/>
   <soapenv:Body>
      <ns:UpdateNameForDimensionMember>
       <ns:DimensionCode>code</ns:DimensionCode>
        <ns:DimensionMembers>
             <ns:DimensionMember>
              <ns:Code>exisitng_dimension_member_code</ns:Code>
              <ns:Name>new_name</ns:Name>
            </ns:DimensionMember>
         </ns:DimensionMembers>
         <ns:LoginName>benparker@planful.com</ns:LoginName>
          <ns:Password>password</ns:Password>
         <ns:TenantCode>Tenantname</ns:TenantCode>
      </ns:UpdateNameForDimensionMember>
   </soapenv:Body>
</soapenv:Envelope>

Response

Status - Enum (success, Failure, CompletedwithErrors)

Message - String

MembersStatus - List Object (each object in list will have Code - string, Status - enum. Message - Success or reason for failure

Was this article helpful?

Table of contents

Usage
Request
Response