Skip to main content

Get entities from Settings

GET 
/Settings

Get entities from Settings

Request​

Query Parameters

    $top integer

    Show only the first n items

    $skip integer

    Skip the first n items

    $search string

    Search items by search phrases

    $filter string

    Filter items by property values

    $count boolean

    Include count of items

    $orderby string[]

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

    Order items by property values

    $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, 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 entities

Schema

    value

    object[]

  • Array [

    • 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
    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...