Skip to main content

Get entity from Settings by key

GET 
/Settings(:id)

Get entity from Settings by key

Request​

Path Parameters

    id uuidrequired

    Possible values: Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

    key: id of Settings

Query Parameters

    $select string[]

    Possible values: [primaryColor, nextQuotationNumber, quotationNumberFormat, lastQuotationDateTime, quotationNumberResetPeriod, accentColor, customCss, customCssEms, crmAccountId, logoUrl, lightLogoUrl, homeImageUrl, faviconUrl, primaryFontColor, accentFontColor, fontFamily, disableConflictDialog, disableConflictDialogOrderEntry, featureModelVersioning, enableArticleCodeInEditor, quotationExpiresInDays, sendQuotationRequestMail, sendMailToCustomer, allowGroupAmount, requireLogin, defaultVatId, displayVatPrices, quotationRequestedAction, quotationRequestRedirectUrl, divergentFeatureModelNodePrices, mandatoryCrmValues, mandatoryCrmContactValues, privacyPolicyAppendixIFrame, disableFullOverview, requireTermsAndConditions, disableTablePresetEditing, disableImageCropping, autoArchiveQuotations, defaultArchivedStatusId, defaultRevisedStatusId, defaultExpiredStatusId, enableConfigurator, enableMultipleConfigurations, enableWelcomePage, enableOverviewPage, welcomePageBackgroundUrl, welcomePageYouTubeId, loginPageBackgroundUrl, productSelectionPageBackgroundUrl, disableProductSelection, map3DToNodes, enable3dFootprint, enable3dLabel, allowDifferentShipToAddress, hideCustomerFieldInShowroom, hideDeliveryDateFieldInShowroom, hideRemarksFieldInShowroom, hideShippingAddressFieldInShowroom, displayCreateQuotationInLastStep, requiredQuotationFields, hiddenQuotationFields, disabledQuotationFields, checkoutQuotationPropertyIds, displayedShowroomCrmFields, quotationActionsPerStatus, currencyDeterminationMethod, crmShareType, id, createdDate, updatedDate, organizationId, reference, creatorId, customField1, customField2, customField3, customField4, customField5, organization]

    Select properties to be returned

    $expand string[]

    Possible values: [*, organization]

    Expand related entities

Responses​

Retrieved entity

Schema

    primaryColor string
    nextQuotationNumber int32

    Possible values: >= -2147483648 and <= 2147483647

    quotationNumberFormat string
    lastQuotationDateTime date-time
    quotationNumberResetPeriod
    accentColor string
    customCss string
    customCssEms string
    crmAccountId uuid
    logoUrl string
    lightLogoUrl string
    homeImageUrl string
    faviconUrl string
    primaryFontColor string
    accentFontColor string
    fontFamily string
    disableConflictDialog boolean
    disableConflictDialogOrderEntry boolean
    featureModelVersioning boolean
    enableArticleCodeInEditor boolean
    quotationExpiresInDays int32

    Possible values: >= -2147483648 and <= 2147483647

    sendQuotationRequestMail string
    sendMailToCustomer boolean
    allowGroupAmount boolean
    requireLogin boolean
    defaultVatId uuid
    displayVatPrices boolean
    quotationRequestedAction
    quotationRequestRedirectUrl string
    divergentFeatureModelNodePrices boolean
    mandatoryCrmValues string
    mandatoryCrmContactValues string
    privacyPolicyAppendixIFrame string
    disableFullOverview boolean
    requireTermsAndConditions boolean
    disableTablePresetEditing boolean
    disableImageCropping boolean
    autoArchiveQuotations boolean
    defaultArchivedStatusId uuid
    defaultRevisedStatusId uuid
    defaultExpiredStatusId uuid
    enableConfigurator boolean
    enableMultipleConfigurations boolean
    enableWelcomePage boolean
    enableOverviewPage boolean
    welcomePageBackgroundUrl string
    welcomePageYouTubeId string
    loginPageBackgroundUrl string
    productSelectionPageBackgroundUrl string
    disableProductSelection boolean
    map3DToNodes boolean
    enable3dFootprint boolean
    enable3dLabel boolean
    allowDifferentShipToAddress boolean
    hideCustomerFieldInShowroom boolean
    hideDeliveryDateFieldInShowroom boolean
    hideRemarksFieldInShowroom boolean
    hideShippingAddressFieldInShowroom boolean
    displayCreateQuotationInLastStep boolean
    requiredQuotationFields string[]
    hiddenQuotationFields string[]
    disabledQuotationFields string[]
    checkoutQuotationPropertyIds string[]
    displayedShowroomCrmFields string[]
    quotationActionsPerStatus undefined[]
    currencyDeterminationMethod
    crmShareType
    id uuid
    createdDate date-time
    updatedDate date-time
    organizationId uuid
    reference string
    creatorId uuid
    customField1 string
    customField2 string
    customField3 string
    customField4 string
    customField5 string
    organization
Loading...