Jump to

• Request
• Response

Delete a user column instance.

delete

/hcmRestApi/resources/11.13.18.05/userColumnInstances/{userColumnInstancesUniqID}

Request

Path Parameters

• userColumnInstancesUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- UserColumnInstanceId, EffectiveStartDate and EffectiveEndDate ---for the User Column Instances resource and used to uniquely identify an instance of User Column Instances. The client should not generate the hash key value. Instead, the client should query on the User Column Instances collection resource with a filter on the primary key values in order to navigate to a specific instance of User Column Instances.
  
  For example: userColumnInstances?q=UserColumnInstanceId=<value1>;EffectiveStartDate=<value2>;EffectiveEndDate=<value3>

Header Parameters

• Effective-Of:
  This header accepts a string value. The string is a semi-colon separated list of =. It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers.
• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Default Response

No Content. This task does not return elements in the response body.

Back to Top