Skip to main content

Patch an Org configuration property

Patch configuration of the current org using http://jsonpatch.com/ syntax. Commonly used for changing the time zone of an org. Request will require a security scope of:

  • 'idn:org-config:write'
  • 'idn:org-config-internal:write'
Request Body array required

A list of schema attribute update operations according to the JSON Patch standard.

  • op string required

    Possible values: [add, remove, replace, move, copy, test]

    The operation to be performed

  • path string required

    A string JSON Pointer representing the target path to an element to be affected by the operation

  • value object

    The value to be used for the operation, required for "add" and "replace" operations

    anyOf

  • string
Responses

The Org was successfully patched.


Schema
  • orgName string

    The name of the org.

  • timeZone string

    The selected time zone which is to be used for the org. This directly affects when scheduled tasks are executed. Valid options can be found at /beta/org-config/valid-time-zones

  • lcsChangeHonorsSourceEnableFeature boolean

    Flag to determine whether the LCS_CHANGE_HONORS_SOURCE_ENABLE_FEATURE flag is enabled for the current org.

  • armCustomerId string

    ARM Customer ID

  • armSapSystemIdMappings string

    A list of IDN::sourceId to ARM::systemId mappings.

  • armAuth string

    ARM authentication string

  • armDb string

    ARM database name

  • armSsoUrl string

    ARM SSO URL

  • iaiEnableCertificationRecommendations boolean

    Flag to determine whether IAI Certification Recommendations are enabled for the current org

  • sodReportConfigs object[]
  • columnName string

    Name of column in report

  • required boolean

    Default value: false

    If true, column is required in all reports, and this entry is immutable. A 400 error will result from any attempt to modify the column's definition.

  • included boolean

    Default value: false

    If true, column is included in the report. A 400 error will be thrown if an attempt is made to set included=false if required==true.

  • order int32

    Possible values: <= 2147483647

    Relative sort order for the column. Columns will be displayed left-to-right in nondecreasing order.

Loading...