Jump to

• Request
• Response

Update a setup tasks

patch

/crmRestApi/resources/11.13.18.05/setupAssistants/{Name}

Request

Path Parameters

• Name(required): string
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

Header Parameters

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

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• AccountingCalendars: array Accounting Calendars
  Title: Accounting Calendars

  The Accounting Calendar resource is used to create accounting calendar.
• AdaptiveSearch: array Adaptive Searches
  Title: Adaptive Searches

  The adaptive search resource is used to view, create and update configuration for adaptive search. This configuration will be used to submit the adaptive search publish task.
• CompanyProfiles: array Company Profiles
  Title: Company Profiles

  The Company Profile resource is used to create the enterprise information.
• Competitors: array Competitors
  Title: Competitors

  The Competitors resource is used to create competitors.
• Data: string (byte)
  The data required to complete the setup task.
• Geographies: array Geographies
  Title: Geographies

  The Geographies resource is used to import geographies and enable geocoding.
• Opportunities: array Opportunities
  Title: Opportunities

  The Opportunities resource is used to create, view and update opportunity setup.
• ProductGroups: array Product Groups
  Title: Product Groups

  The Product Group resource is used to create the root product group.
• RoleMappings: array Role Mappings
  Title: Role Mappings

  The Resource Role Mapping resource is used to create resource roles and role mappings.
• SalesForecastings: array Sales Forecasts
  Title: Sales Forecasts

  The Sales Forecasting resource is used to setup owner based sales forecasting.
• SalesStages: array Sales Stages
  Title: Sales Stages

  The Sales Stages resource is used to create, view and update sales stages for the selected sales method.
• SetupHistory: array Setup Histories
  Title: Setup Histories

  The setup history resource is used to view setup data captured by the Setup Assistant.
• SetupProgress: array Setup Progress
  Title: Setup Progress

  The Setup Progress resource is used to monitor the progress of the setup tasks started by the Setup Assistant.
• SetupUsers: array Setup Users
  Title: Setup Users

  The Setup Users resource is used to create setup users.
• Status: string
  Maximum Length: 80

  The status of the setup task.
• TopSalesUsers: array Top Sales Users
  Title: Top Sales Users

  The Top Sales User resource is used to create the top sales user and set the user at the top of the sales hierarchy.

{
    "type":"object",
    "properties":{
        "Status":{
            "maxLength":"80",
            "type":"string",
            "description":"The status of the setup task.",
            "nullable":true
        },
        "SalesForecastings":{
            "title":"Sales Forecasts",
            "type":"array",
            "description":"The Sales Forecasting resource is used to setup owner based sales forecasting.",
            "items":{
                "$ref":"#/components/schemas/setupAssistants-SalesForecastings-item-patch-request"
            }
        },
        "CompanyProfiles":{
            "title":"Company Profiles",
            "type":"array",
            "description":"The Company Profile resource is used to create the enterprise information.",
            "items":{
                "$ref":"#/components/schemas/setupAssistants-CompanyProfiles-item-patch-request"
            }
        },
        "RoleMappings":{
            "title":"Role Mappings",
            "type":"array",
            "description":"The Resource Role Mapping resource is used to create resource roles and role mappings.",
            "items":{
                "$ref":"#/components/schemas/setupAssistants-RoleMappings-item-patch-request"
            }
        },
        "SetupProgress":{
            "title":"Setup Progress",
            "type":"array",
            "description":"The Setup Progress resource is used to monitor the progress of the setup tasks started by the Setup Assistant.",
            "items":{
                "$ref":"#/components/schemas/setupAssistants-SetupProgress-item-patch-request"
            }
        },
        "Data":{
            "type":"string",
            "description":"The data required to complete the setup task.",
            "format":"byte",
            "nullable":false
        },
        "AdaptiveSearch":{
            "title":"Adaptive Searches",
            "type":"array",
            "description":"The adaptive search resource is used to view, create and update configuration for adaptive search. This configuration will be used to submit the adaptive search publish task.",
            "items":{
                "$ref":"#/components/schemas/setupAssistants-AdaptiveSearch-item-patch-request"
            }
        },
        "Opportunities":{
            "title":"Opportunities",
            "type":"array",
            "description":"The Opportunities resource is used to create, view and update opportunity setup.",
            "items":{
                "$ref":"#/components/schemas/setupAssistants-Opportunities-item-patch-request"
            }
        },
        "SetupHistory":{
            "title":"Setup Histories",
            "type":"array",
            "description":"The setup history resource is used to view setup data captured by the Setup Assistant.",
            "items":{
                "$ref":"#/components/schemas/setupAssistants-SetupHistory-item-patch-request"
            }
        },
        "Geographies":{
            "title":"Geographies",
            "type":"array",
            "description":"The Geographies resource is used to import geographies and enable geocoding.",
            "items":{
                "$ref":"#/components/schemas/setupAssistants-Geographies-item-patch-request"
            }
        },
        "SalesStages":{
            "title":"Sales Stages",
            "type":"array",
            "description":"The Sales Stages resource is used to create, view and update sales stages for the selected sales method.",
            "items":{
                "$ref":"#/components/schemas/setupAssistants-SalesStages-item-patch-request"
            }
        },
        "AccountingCalendars":{
            "title":"Accounting Calendars",
            "type":"array",
            "description":"The Accounting Calendar resource is used to create accounting calendar.",
            "items":{
                "$ref":"#/components/schemas/setupAssistants-AccountingCalendars-item-patch-request"
            }
        },
        "TopSalesUsers":{
            "title":"Top Sales Users",
            "type":"array",
            "description":"The Top Sales User resource is used to create the top sales user and set the user at the top of the sales hierarchy.",
            "items":{
                "$ref":"#/components/schemas/setupAssistants-TopSalesUsers-item-patch-request"
            }
        },
        "Competitors":{
            "title":"Competitors",
            "type":"array",
            "description":"The Competitors resource is used to create competitors.",
            "items":{
                "$ref":"#/components/schemas/setupAssistants-Competitors-item-patch-request"
            }
        },
        "SetupUsers":{
            "title":"Setup Users",
            "type":"array",
            "description":"The Setup Users resource is used to create setup users.",
            "items":{
                "$ref":"#/components/schemas/setupAssistants-SetupUsers-item-patch-request"
            }
        },
        "ProductGroups":{
            "title":"Product Groups",
            "type":"array",
            "description":"The Product Group resource is used to create the root product group.",
            "items":{
                "$ref":"#/components/schemas/setupAssistants-ProductGroups-item-patch-request"
            }
        }
    }
}

Nested Schema : Accounting Calendars

Type: array

Title: Accounting Calendars

The Accounting Calendar resource is used to create accounting calendar.

Show Source

• Array of: object schema

{
    "title":"Accounting Calendars",
    "type":"array",
    "description":"The Accounting Calendar resource is used to create accounting calendar.",
    "items":{
        "$ref":"#/components/schemas/setupAssistants-AccountingCalendars-item-patch-request"
    }
}

Nested Schema : Adaptive Searches

Type: array

Title: Adaptive Searches

The adaptive search resource is used to view, create and update configuration for adaptive search. This configuration will be used to submit the adaptive search publish task.

Show Source

• Array of: object setupAssistants-AdaptiveSearch-item-patch-request

{
    "title":"Adaptive Searches",
    "type":"array",
    "description":"The adaptive search resource is used to view, create and update configuration for adaptive search. This configuration will be used to submit the adaptive search publish task.",
    "items":{
        "$ref":"#/components/schemas/setupAssistants-AdaptiveSearch-item-patch-request"
    }
}

Nested Schema : Company Profiles

Type: array

Title: Company Profiles

The Company Profile resource is used to create the enterprise information.

Show Source

• Array of: object setupAssistants-CompanyProfiles-item-patch-request

{
    "title":"Company Profiles",
    "type":"array",
    "description":"The Company Profile resource is used to create the enterprise information.",
    "items":{
        "$ref":"#/components/schemas/setupAssistants-CompanyProfiles-item-patch-request"
    }
}

Nested Schema : Competitors

Type: array

Title: Competitors

The Competitors resource is used to create competitors.

Show Source

• Array of: object setupAssistants-Competitors-item-patch-request

{
    "title":"Competitors",
    "type":"array",
    "description":"The Competitors resource is used to create competitors.",
    "items":{
        "$ref":"#/components/schemas/setupAssistants-Competitors-item-patch-request"
    }
}

Nested Schema : Geographies

Type: array

Title: Geographies

The Geographies resource is used to import geographies and enable geocoding.

Show Source

• Array of: object setupAssistants-Geographies-item-patch-request

{
    "title":"Geographies",
    "type":"array",
    "description":"The Geographies resource is used to import geographies and enable geocoding.",
    "items":{
        "$ref":"#/components/schemas/setupAssistants-Geographies-item-patch-request"
    }
}

Nested Schema : Opportunities

Type: array

Title: Opportunities

The Opportunities resource is used to create, view and update opportunity setup.

Show Source

• Array of: object setupAssistants-Opportunities-item-patch-request

{
    "title":"Opportunities",
    "type":"array",
    "description":"The Opportunities resource is used to create, view and update opportunity setup.",
    "items":{
        "$ref":"#/components/schemas/setupAssistants-Opportunities-item-patch-request"
    }
}

Nested Schema : Product Groups

Type: array

Title: Product Groups

The Product Group resource is used to create the root product group.

Show Source

• Array of: object setupAssistants-ProductGroups-item-patch-request

{
    "title":"Product Groups",
    "type":"array",
    "description":"The Product Group resource is used to create the root product group.",
    "items":{
        "$ref":"#/components/schemas/setupAssistants-ProductGroups-item-patch-request"
    }
}

Nested Schema : Role Mappings

Type: array

Title: Role Mappings

The Resource Role Mapping resource is used to create resource roles and role mappings.

Show Source

• Array of: object setupAssistants-RoleMappings-item-patch-request

{
    "title":"Role Mappings",
    "type":"array",
    "description":"The Resource Role Mapping resource is used to create resource roles and role mappings.",
    "items":{
        "$ref":"#/components/schemas/setupAssistants-RoleMappings-item-patch-request"
    }
}

Nested Schema : Sales Forecasts

Type: array

Title: Sales Forecasts

The Sales Forecasting resource is used to setup owner based sales forecasting.

Show Source

• Array of: object setupAssistants-SalesForecastings-item-patch-request

{
    "title":"Sales Forecasts",
    "type":"array",
    "description":"The Sales Forecasting resource is used to setup owner based sales forecasting.",
    "items":{
        "$ref":"#/components/schemas/setupAssistants-SalesForecastings-item-patch-request"
    }
}

Nested Schema : Sales Stages

Type: array

Title: Sales Stages

The Sales Stages resource is used to create, view and update sales stages for the selected sales method.

Show Source

• Array of: object setupAssistants-SalesStages-item-patch-request

{
    "title":"Sales Stages",
    "type":"array",
    "description":"The Sales Stages resource is used to create, view and update sales stages for the selected sales method.",
    "items":{
        "$ref":"#/components/schemas/setupAssistants-SalesStages-item-patch-request"
    }
}

Nested Schema : Setup Histories

Type: array

Title: Setup Histories

The setup history resource is used to view setup data captured by the Setup Assistant.

Show Source

• Array of: object setupAssistants-SetupHistory-item-patch-request

{
    "title":"Setup Histories",
    "type":"array",
    "description":"The setup history resource is used to view setup data captured by the Setup Assistant.",
    "items":{
        "$ref":"#/components/schemas/setupAssistants-SetupHistory-item-patch-request"
    }
}

Nested Schema : Setup Progress

Type: array

Title: Setup Progress

The Setup Progress resource is used to monitor the progress of the setup tasks started by the Setup Assistant.

Show Source

• Array of: object setupAssistants-SetupProgress-item-patch-request

{
    "title":"Setup Progress",
    "type":"array",
    "description":"The Setup Progress resource is used to monitor the progress of the setup tasks started by the Setup Assistant.",
    "items":{
        "$ref":"#/components/schemas/setupAssistants-SetupProgress-item-patch-request"
    }
}

Nested Schema : Setup Users

Type: array

Title: Setup Users

The Setup Users resource is used to create setup users.

Show Source

• Array of: object schema

{
    "title":"Setup Users",
    "type":"array",
    "description":"The Setup Users resource is used to create setup users.",
    "items":{
        "$ref":"#/components/schemas/setupAssistants-SetupUsers-item-patch-request"
    }
}

Nested Schema : Top Sales Users

Type: array

Title: Top Sales Users

The Top Sales User resource is used to create the top sales user and set the user at the top of the sales hierarchy.

Show Source

• Array of: object schema

{
    "title":"Top Sales Users",
    "type":"array",
    "description":"The Top Sales User resource is used to create the top sales user and set the user at the top of the sales hierarchy.",
    "items":{
        "$ref":"#/components/schemas/setupAssistants-TopSalesUsers-item-patch-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• Description: string
  Maximum Length: 255

  The description of the accounting calendar.
• Name: string
  Maximum Length: 15

  Default Value: Sales Calendar

  The name of the accounting calendar.
• PeriodFrequency: string
  Maximum Length: 25

  Default Value: MONTH

  The frequency of the accounting calendar.
• PeriodNameFormat: string
  Maximum Length: 25

  Default Value: MMMYYCY

  The period format associated with the accounting calendar.
• PeriodStartMonth: string
  Maximum Length: 20

  Default Value: 01

  The start month for the accounting calendar.
• PeriodStartYear: string
  Maximum Length: 4

  The start year for the accounting calendar.

{
    "type":"object",
    "properties":{
        "Description":{
            "maxLength":"255",
            "type":"string",
            "description":"The description of the accounting calendar.",
            "nullable":true
        },
        "PeriodStartYear":{
            "maxLength":"4",
            "type":"string",
            "description":"The start year for the accounting calendar.",
            "nullable":true
        },
        "PeriodFrequency":{
            "maxLength":"25",
            "type":"string",
            "description":"The frequency of the accounting calendar.",
            "nullable":true,
            "default":"MONTH",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PeriodNameFormat":{
            "maxLength":"25",
            "type":"string",
            "description":"The period format associated with the accounting calendar.",
            "nullable":true,
            "default":"MMMYYCY"
        },
        "PeriodStartMonth":{
            "maxLength":"20",
            "type":"string",
            "description":"The start month for the accounting calendar.",
            "nullable":true,
            "default":"01",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Name":{
            "maxLength":"15",
            "type":"string",
            "description":"The name of the accounting calendar.",
            "nullable":false,
            "default":"Sales Calendar"
        }
    }
}

Nested Schema : setupAssistants-AdaptiveSearch-item-patch-request

Type: object

Show Source

• Account: string
  Maximum Length: 80

  Default Value: Y

  Indicates whether the account has been selected for adaptive search publish.
• Activity: string
  Maximum Length: 80

  Default Value: Y

  Indicates whether the activity has been selected for adaptive search publish.
• Asset: string
  Maximum Length: 80

  Default Value: Y

  Indicates whether the Revenue Lines object has been selected for inclusion in the Adaptive Search Publish process. If true, then revenue lines are included in the process. By default, the value is true.
• Contact: string
  Maximum Length: 80

  Default Value: Y

  Indicates whether the contact has been selected for adaptive search publish.
• Lead: string
  Maximum Length: 80

  Default Value: Y

  Indicates whether the Asset object has been selected for inclusion in the Adaptive Search Publish process. If true, then assets are included in the process. By default, the value is true.
• Opportunity: string
  Maximum Length: 80

  Default Value: Y

  Indicates whether the opportunity has been selected for adaptive search publish.
• Partner: string
  Maximum Length: 80

  Default Value: N

  Indicates whether the partner has been selected for adaptive search publish.
• PartnerContact: string
  Maximum Length: 80

  Default Value: N

  Indicates whether the partner contact has been selected for adaptive search publish.
• Product: string
  Maximum Length: 80

  Default Value: Y

  Indicates whether Product has been selected for the adaptive search publish.
• ProductGroup: string
  Maximum Length: 80

  Default Value: Y

  Indicates whether Product Group has been selected for the adaptive search publish.
• RevenueLines: string
  Maximum Length: 80

  Default Value: Y

  Indicates whether the lead has been selected for adaptive search publish.
• ServiceRequest: string
  Maximum Length: 80

  Default Value: N

  Indicates whether the service request has been selected for adaptive search publish.

{
    "type":"object",
    "properties":{
        "Account":{
            "maxLength":"80",
            "type":"string",
            "description":"Indicates whether the account has been selected for adaptive search publish.",
            "nullable":false,
            "default":"Y"
        },
        "ProductGroup":{
            "maxLength":"80",
            "type":"string",
            "description":"Indicates whether Product Group has been selected for the adaptive search publish.",
            "nullable":false,
            "default":"Y"
        },
        "Activity":{
            "maxLength":"80",
            "type":"string",
            "description":"Indicates whether the activity has been selected for adaptive search publish.",
            "nullable":false,
            "default":"Y"
        },
        "Product":{
            "maxLength":"80",
            "type":"string",
            "description":"Indicates whether Product has been selected for the adaptive search publish.",
            "nullable":false,
            "default":"Y"
        },
        "RevenueLines":{
            "maxLength":"80",
            "type":"string",
            "description":"Indicates whether the lead has been selected for adaptive search publish.",
            "nullable":false,
            "default":"Y"
        },
        "PartnerContact":{
            "maxLength":"80",
            "type":"string",
            "description":"Indicates whether the partner contact has been selected for adaptive search publish.",
            "nullable":false,
            "default":"N"
        },
        "ServiceRequest":{
            "maxLength":"80",
            "type":"string",
            "description":"Indicates whether the service request has been selected for adaptive search publish.",
            "nullable":false,
            "default":"N"
        },
        "Contact":{
            "maxLength":"80",
            "type":"string",
            "description":"Indicates whether the contact has been selected for adaptive search publish.",
            "nullable":false,
            "default":"Y"
        },
        "Opportunity":{
            "maxLength":"80",
            "type":"string",
            "description":"Indicates whether the opportunity has been selected for adaptive search publish.",
            "nullable":false,
            "default":"Y"
        },
        "Lead":{
            "maxLength":"80",
            "type":"string",
            "description":"Indicates whether the Asset object has been selected for inclusion in the Adaptive Search Publish process. If true, then assets are included in the process. By default, the value is true.",
            "nullable":false,
            "default":"Y"
        },
        "Asset":{
            "maxLength":"80",
            "type":"string",
            "description":"Indicates whether the Revenue Lines object has been selected for inclusion in the Adaptive Search Publish process. If true, then revenue lines are included in the process. By default, the value is true.",
            "nullable":false,
            "default":"Y"
        },
        "Partner":{
            "maxLength":"80",
            "type":"string",
            "description":"Indicates whether the partner has been selected for adaptive search publish.",
            "nullable":false,
            "default":"N"
        }
    }
}

Nested Schema : setupAssistants-CompanyProfiles-item-patch-request

Type: object

Show Source

• Addressline: string
  Maximum Length: 100

  The first line of the organization address.
• BusinessUnit: string
  Maximum Length: 80

  Business Unit
• CorporateCurrency: string
  Maximum Length: 80

  Default Value: USD

  The default corporate currency code.
• Country: string
  Maximum Length: 80

  Default Value: US

  The country of the enterprise.
• EnterpriseName: string
  Maximum Length: 100

  The name of the enterprise.
• IsDataExisting: string
  Maximum Length: 80

  Indicates if the enterprise setup data was created before running the Setup Assistant.
• LegalEntity: string
  Maximum Length: 80

  Legal Entity
• TaxRegNumber: string
  Maximum Length: 80

  Enterprise Tax Registration Number

{
    "type":"object",
    "properties":{
        "LegalEntity":{
            "maxLength":"80",
            "type":"string",
            "description":"Legal Entity",
            "nullable":true
        },
        "TaxRegNumber":{
            "maxLength":"80",
            "type":"string",
            "description":"Enterprise Tax Registration Number",
            "nullable":true
        },
        "Addressline":{
            "maxLength":"100",
            "type":"string",
            "description":"The first line of the organization address.",
            "nullable":true
        },
        "CorporateCurrency":{
            "maxLength":"80",
            "type":"string",
            "description":"The default corporate currency code.",
            "nullable":false,
            "default":"USD",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "EnterpriseName":{
            "maxLength":"100",
            "type":"string",
            "description":"The name of the enterprise.",
            "nullable":true
        },
        "IsDataExisting":{
            "maxLength":"80",
            "type":"string",
            "description":"Indicates if the enterprise setup data was created before running the Setup Assistant.",
            "nullable":true
        },
        "BusinessUnit":{
            "maxLength":"80",
            "type":"string",
            "description":"Business Unit",
            "nullable":true
        },
        "Country":{
            "maxLength":"80",
            "type":"string",
            "description":"The country of the enterprise.",
            "nullable":true,
            "default":"US",
            "x-hints":{
                "controlType":"choice"
            }
        }
    }
}

Nested Schema : setupAssistants-Competitors-item-patch-request

Type: object

Show Source

• LineOfBusiness: string
  Maximum Length: 240

  The line of business of the competitor.
• Name: string
  Maximum Length: 360

  The name of the competitor.
• NameSuffix: string
  Maximum Length: 540

  The name suffix of the competitor.
• OrganizationSize: string
  Maximum Length: 80

  The size of the organization based on its revenue, number of employees, and others.
• ThreatLevel: string
  Maximum Length: 80

  The level of threat to signify the competitive risk.

{
    "type":"object",
    "properties":{
        "LineOfBusiness":{
            "maxLength":"240",
            "type":"string",
            "description":"The line of business of the competitor.",
            "nullable":true
        },
        "NameSuffix":{
            "maxLength":"540",
            "type":"string",
            "description":"The name suffix of the competitor.",
            "nullable":true
        },
        "OrganizationSize":{
            "maxLength":"80",
            "type":"string",
            "description":"The size of the organization based on its revenue, number of employees, and others.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ThreatLevel":{
            "maxLength":"80",
            "type":"string",
            "description":"The level of threat to signify the competitive risk.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Name":{
            "maxLength":"360",
            "type":"string",
            "description":"The name of the competitor.",
            "nullable":false
        }
    }
}

Nested Schema : setupAssistants-Geographies-item-patch-request

Type: object

Show Source

• CountryFirst: string
  Maximum Length: 80

  The first country for which the geography data has to be imported.
• CountrySecond: string
  Maximum Length: 80

  The second country for which the geography data has to be imported.
• CountryThird: string
  Maximum Length: 80

  The third country for which the geography data has to be imported.
• EnableGeoEncoding: string
  Maximum Length: 5

  Default Value: N

  Indicates if the geography encoding has to be enabled for the imported countries.

{
    "type":"object",
    "properties":{
        "CountryThird":{
            "maxLength":"80",
            "type":"string",
            "description":"The third country for which the geography data has to be imported.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CountrySecond":{
            "maxLength":"80",
            "type":"string",
            "description":"The second country for which the geography data has to be imported.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "EnableGeoEncoding":{
            "maxLength":"5",
            "type":"string",
            "description":"Indicates if the geography encoding has to be enabled for the imported countries.",
            "nullable":true,
            "default":"N",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CountryFirst":{
            "maxLength":"80",
            "type":"string",
            "description":"The first country for which the geography data has to be imported.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        }
    }
}

Nested Schema : setupAssistants-Opportunities-item-patch-request

Type: object

Show Source

• OptyCloseDate: string
  Maximum Length: 1000

  Default Value: 20

  The default date on which the opportunity will be closed.
• RequireCloseOptyCompetitor: string
  Maximum Length: 1

  Default Value: Y

  Indicates if you need to enter competitor details before closing an opportunity.
• RequireOptyCloseReason: string
  Maximum Length: 1

  Default Value: Y

  Indicates if you need to indicate the win or loss reason before closing an opportunity.
• SalesMethodNumber: string
  Maximum Length: 64

  The default sales method number if one isn't provided.
• SalesStages: array Sales Stages
  Title: Sales Stages

  The Sales Stages resource is used to create, view and update sales stages for the selected sales method.

{
    "type":"object",
    "properties":{
        "RequireOptyCloseReason":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates if you need to indicate the win or loss reason before closing an opportunity.",
            "nullable":false,
            "default":"Y",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SalesMethodNumber":{
            "maxLength":"64",
            "type":"string",
            "description":"The default sales method number if one isn't provided.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RequireCloseOptyCompetitor":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates if you need to enter competitor details before closing an opportunity.",
            "nullable":false,
            "default":"Y",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "OptyCloseDate":{
            "maxLength":"1000",
            "type":"string",
            "description":"The default date on which the opportunity will be closed.",
            "nullable":false,
            "default":"20"
        },
        "SalesStages":{
            "title":"Sales Stages",
            "type":"array",
            "description":"The Sales Stages resource is used to create, view and update sales stages for the selected sales method.",
            "items":{
                "$ref":"#/components/schemas/setupAssistants-Opportunities-SalesStages-item-patch-request"
            }
        }
    }
}

Nested Schema : Sales Stages

Type: array

Title: Sales Stages

The Sales Stages resource is used to create, view and update sales stages for the selected sales method.

Show Source

• Array of: object setupAssistants-Opportunities-SalesStages-item-patch-request

{
    "title":"Sales Stages",
    "type":"array",
    "description":"The Sales Stages resource is used to create, view and update sales stages for the selected sales method.",
    "items":{
        "$ref":"#/components/schemas/setupAssistants-Opportunities-SalesStages-item-patch-request"
    }
}

Nested Schema : setupAssistants-Opportunities-SalesStages-item-patch-request

Type: object

Show Source

• DeletedFlag: boolean
  Maximum Length: 2

  Default Value: false

  Indicates if the sales method can be deleted.
• DescriptionText: string
  Maximum Length: 255

  The description of the sales stage.
• Name: string
  Maximum Length: 50

  The name of the sales stage.
• PhaseCd: string
  Maximum Length: 30

  Default Value: QUALIFICATION-DISCOVERY

  The code for phase of sales stage.
• RcmndWinProb: string
  Maximum Length: 22

  The win probability of sales stage.
• StageStatusCd: string
  Maximum Length: 30

  Default Value: OPEN

  A code indicating the status of the sales stage.
• StgOrder: string
  Maximum Length: 22

  The order in which the sales stage will be displayed.

{
    "type":"object",
    "properties":{
        "StageStatusCd":{
            "maxLength":"30",
            "type":"string",
            "description":"A code indicating the status of the sales stage.",
            "nullable":false,
            "default":"OPEN",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RcmndWinProb":{
            "maxLength":"22",
            "type":"string",
            "description":"The win probability of sales stage.",
            "nullable":true
        },
        "DeletedFlag":{
            "maxLength":"2",
            "type":"boolean",
            "description":"Indicates if the sales method can be deleted.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PhaseCd":{
            "maxLength":"30",
            "type":"string",
            "description":"The code for phase of sales stage.",
            "nullable":false,
            "default":"QUALIFICATION-DISCOVERY",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "DescriptionText":{
            "maxLength":"255",
            "type":"string",
            "description":"The description of the sales stage.",
            "nullable":true
        },
        "StgOrder":{
            "maxLength":"22",
            "type":"string",
            "description":"The order in which the sales stage will be displayed.",
            "nullable":false
        },
        "Name":{
            "maxLength":"50",
            "type":"string",
            "description":"The name of the sales stage.",
            "nullable":false
        }
    }
}

Nested Schema : setupAssistants-ProductGroups-item-patch-request

Type: object

Show Source

• Description: string
  Maximum Length: 1000

  A description for the product group.
• DisplayName: string
  Maximum Length: 150

  The name of the product group.
• InternalName: string
  Maximum Length: 150

  The internal name of the product group.

{
    "type":"object",
    "properties":{
        "DisplayName":{
            "maxLength":"150",
            "type":"string",
            "description":"The name of the product group.",
            "nullable":false
        },
        "Description":{
            "maxLength":"1000",
            "type":"string",
            "description":"A description for the product group.",
            "nullable":true
        },
        "InternalName":{
            "maxLength":"150",
            "type":"string",
            "description":"The internal name of the product group.",
            "nullable":false
        }
    }
}

Nested Schema : setupAssistants-RoleMappings-item-patch-request

Type: object

Show Source

• ResourceRoleName: string
  Maximum Length: 60

  The role name of the resource.
• RoleCommonNameCode: string
  The code value application job role to which resource role will be mapped.

{
    "type":"object",
    "properties":{
        "ResourceRoleName":{
            "maxLength":"60",
            "type":"string",
            "description":"The role name of the resource.",
            "nullable":false
        },
        "RoleCommonNameCode":{
            "type":"string",
            "description":"The code value application job role to which resource role will be mapped.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        }
    }
}

Nested Schema : setupAssistants-SalesForecastings-item-patch-request

Type: object

Show Source

• EnableNGSForecasting: string
  Maximum Length: 1

  Default Value: N

  Indicates if sales forecast setup has to be done.

{
    "type":"object",
    "properties":{
        "EnableNGSForecasting":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates if sales forecast setup has to be done.",
            "nullable":false,
            "default":"N"
        }
    }
}

Nested Schema : setupAssistants-SalesStages-item-patch-request

Type: object

Show Source

• DeletedFlag: boolean
  Maximum Length: 2

  Default Value: false

  Indicates if the sales method can be deleted.
• DescriptionText: string
  Maximum Length: 255

  The description of the sales stage.
• Name: string
  Maximum Length: 50

  The name of the sales stage.
• PhaseCd: string
  Maximum Length: 30

  Default Value: QUALIFICATION-DISCOVERY

  The code for phase of sales stage.
• RcmndWinProb: string
  Maximum Length: 22

  The win probability of sales stage.
• StageStatusCd: string
  Maximum Length: 30

  Default Value: OPEN

  A code indicating the status of the sales stage.
• StgOrder: string
  Maximum Length: 22

  The order in which the sales stage will be displayed.

{
    "type":"object",
    "properties":{
        "StageStatusCd":{
            "maxLength":"30",
            "type":"string",
            "description":"A code indicating the status of the sales stage.",
            "nullable":false,
            "default":"OPEN",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RcmndWinProb":{
            "maxLength":"22",
            "type":"string",
            "description":"The win probability of sales stage.",
            "nullable":true
        },
        "DeletedFlag":{
            "maxLength":"2",
            "type":"boolean",
            "description":"Indicates if the sales method can be deleted.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PhaseCd":{
            "maxLength":"30",
            "type":"string",
            "description":"The code for phase of sales stage.",
            "nullable":false,
            "default":"QUALIFICATION-DISCOVERY",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "DescriptionText":{
            "maxLength":"255",
            "type":"string",
            "description":"The description of the sales stage.",
            "nullable":true
        },
        "StgOrder":{
            "maxLength":"22",
            "type":"string",
            "description":"The order in which the sales stage will be displayed.",
            "nullable":false
        },
        "Name":{
            "maxLength":"50",
            "type":"string",
            "description":"The name of the sales stage.",
            "nullable":false
        }
    }
}

Nested Schema : setupAssistants-SetupHistory-item-patch-request

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

Nested Schema : setupAssistants-SetupProgress-item-patch-request

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

Nested Schema : schema

Type: object

Show Source

• Email: string
  Maximum Length: 320

  The email of the setup user to whom updates will be sent.
• FirstName: string
  Maximum Length: 150

  The first name of the setup user.
• LastName: string
  Maximum Length: 150

  The last name of the setup user.

{
    "type":"object",
    "properties":{
        "Email":{
            "maxLength":"320",
            "type":"string",
            "description":"The email of the setup user to whom updates will be sent.",
            "nullable":false
        },
        "LastName":{
            "maxLength":"150",
            "type":"string",
            "description":"The last name of the setup user.",
            "nullable":false
        },
        "FirstName":{
            "maxLength":"150",
            "type":"string",
            "description":"The first name of the setup user.",
            "nullable":false
        }
    }
}

Nested Schema : schema

Type: object

Show Source

• EMail: string
  Maximum Length: 320

  The email of the top sales user.
• FirstName: string
  Maximum Length: 150

  The first name of the top sales user.
• LastName: string
  Maximum Length: 150

  The last name of the top sales user.
• ResourceOrganization: string
  Maximum Length: 240

  The resource organization to which the sales user belongs.

{
    "type":"object",
    "properties":{
        "LastName":{
            "maxLength":"150",
            "type":"string",
            "description":"The last name of the top sales user.",
            "nullable":false
        },
        "ResourceOrganization":{
            "maxLength":"240",
            "type":"string",
            "description":"The resource organization to which the sales user belongs.",
            "nullable":false
        },
        "EMail":{
            "maxLength":"320",
            "type":"string",
            "description":"The email of the top sales user.",
            "nullable":false
        },
        "FirstName":{
            "maxLength":"150",
            "type":"string",
            "description":"The first name of the top sales user.",
            "nullable":false
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

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

Body ()

Root Schema : setupAssistants-item-response

Type: object

Show Source

• AccountingCalendars: array Accounting Calendars
  Title: Accounting Calendars

  The Accounting Calendar resource is used to create accounting calendar.
• AdaptiveSearch: array Adaptive Searches
  Title: Adaptive Searches

  The adaptive search resource is used to view, create and update configuration for adaptive search. This configuration will be used to submit the adaptive search publish task.
• CompanyProfiles: array Company Profiles
  Title: Company Profiles

  The Company Profile resource is used to create the enterprise information.
• Competitors: array Competitors
  Title: Competitors

  The Competitors resource is used to create competitors.
• Data: string (byte)
  The data required to complete the setup task.
• Geographies: array Geographies
  Title: Geographies

  The Geographies resource is used to import geographies and enable geocoding.
• Id: string
  The unique identifier of a setup task.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Name: string
  Maximum Length: 30

  A unique name for the setup task.
• Opportunities: array Opportunities
  Title: Opportunities

  The Opportunities resource is used to create, view and update opportunity setup.
• ProductGroups: array Product Groups
  Title: Product Groups

  The Product Group resource is used to create the root product group.
• RoleMappings: array Role Mappings
  Title: Role Mappings

  The Resource Role Mapping resource is used to create resource roles and role mappings.
• SalesForecastings: array Sales Forecasts
  Title: Sales Forecasts

  The Sales Forecasting resource is used to setup owner based sales forecasting.
• SalesStages: array Sales Stages
  Title: Sales Stages

  The Sales Stages resource is used to create, view and update sales stages for the selected sales method.
• SetupHistory: array Setup Histories
  Title: Setup Histories

  The setup history resource is used to view setup data captured by the Setup Assistant.
• SetupProgress: array Setup Progress
  Title: Setup Progress

  The Setup Progress resource is used to monitor the progress of the setup tasks started by the Setup Assistant.
• SetupUsers: array Setup Users
  Title: Setup Users

  The Setup Users resource is used to create setup users.
• Status: string
  Maximum Length: 80

  The status of the setup task.
• TopSalesUsers: array Top Sales Users
  Title: Top Sales Users

  The Top Sales User resource is used to create the top sales user and set the user at the top of the sales hierarchy.

{
    "type":"object",
    "properties":{
        "Status":{
            "maxLength":"80",
            "type":"string",
            "description":"The status of the setup task.",
            "nullable":true,
            "x-queryable":true
        },
        "SalesForecastings":{
            "title":"Sales Forecasts",
            "type":"array",
            "description":"The Sales Forecasting resource is used to setup owner based sales forecasting.",
            "items":{
                "$ref":"#/components/schemas/setupAssistants-SalesForecastings-item-response"
            }
        },
        "CompanyProfiles":{
            "title":"Company Profiles",
            "type":"array",
            "description":"The Company Profile resource is used to create the enterprise information.",
            "items":{
                "$ref":"#/components/schemas/setupAssistants-CompanyProfiles-item-response"
            }
        },
        "RoleMappings":{
            "title":"Role Mappings",
            "type":"array",
            "description":"The Resource Role Mapping resource is used to create resource roles and role mappings.",
            "items":{
                "$ref":"#/components/schemas/setupAssistants-RoleMappings-item-response"
            }
        },
        "SetupProgress":{
            "title":"Setup Progress",
            "type":"array",
            "description":"The Setup Progress resource is used to monitor the progress of the setup tasks started by the Setup Assistant.",
            "items":{
                "$ref":"#/components/schemas/setupAssistants-SetupProgress-item-response"
            }
        },
        "Data":{
            "type":"string",
            "description":"The data required to complete the setup task.",
            "format":"byte",
            "nullable":false,
            "x-queryable":true
        },
        "AdaptiveSearch":{
            "title":"Adaptive Searches",
            "type":"array",
            "description":"The adaptive search resource is used to view, create and update configuration for adaptive search. This configuration will be used to submit the adaptive search publish task.",
            "items":{
                "$ref":"#/components/schemas/setupAssistants-AdaptiveSearch-item-response"
            }
        },
        "Opportunities":{
            "title":"Opportunities",
            "type":"array",
            "description":"The Opportunities resource is used to create, view and update opportunity setup.",
            "items":{
                "$ref":"#/components/schemas/setupAssistants-Opportunities-item-response"
            }
        },
        "SetupHistory":{
            "title":"Setup Histories",
            "type":"array",
            "description":"The setup history resource is used to view setup data captured by the Setup Assistant.",
            "items":{
                "$ref":"#/components/schemas/setupAssistants-SetupHistory-item-response"
            }
        },
        "Geographies":{
            "title":"Geographies",
            "type":"array",
            "description":"The Geographies resource is used to import geographies and enable geocoding.",
            "items":{
                "$ref":"#/components/schemas/setupAssistants-Geographies-item-response"
            }
        },
        "Name":{
            "maxLength":"30",
            "type":"string",
            "description":"A unique name for the setup task.",
            "nullable":false,
            "x-queryable":true
        },
        "SalesStages":{
            "title":"Sales Stages",
            "type":"array",
            "description":"The Sales Stages resource is used to create, view and update sales stages for the selected sales method.",
            "items":{
                "$ref":"#/components/schemas/setupAssistants-SalesStages-item-response"
            }
        },
        "AccountingCalendars":{
            "title":"Accounting Calendars",
            "type":"array",
            "description":"The Accounting Calendar resource is used to create accounting calendar.",
            "items":{
                "$ref":"#/components/schemas/setupAssistants-AccountingCalendars-item-response"
            }
        },
        "TopSalesUsers":{
            "title":"Top Sales Users",
            "type":"array",
            "description":"The Top Sales User resource is used to create the top sales user and set the user at the top of the sales hierarchy.",
            "items":{
                "$ref":"#/components/schemas/setupAssistants-TopSalesUsers-item-response"
            }
        },
        "Competitors":{
            "title":"Competitors",
            "type":"array",
            "description":"The Competitors resource is used to create competitors.",
            "items":{
                "$ref":"#/components/schemas/setupAssistants-Competitors-item-response"
            }
        },
        "SetupUsers":{
            "title":"Setup Users",
            "type":"array",
            "description":"The Setup Users resource is used to create setup users.",
            "items":{
                "$ref":"#/components/schemas/setupAssistants-SetupUsers-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "Id":{
            "type":"string",
            "description":"The unique identifier of a setup task.",
            "nullable":false,
            "x-queryable":true
        },
        "ProductGroups":{
            "title":"Product Groups",
            "type":"array",
            "description":"The Product Group resource is used to create the root product group.",
            "items":{
                "$ref":"#/components/schemas/setupAssistants-ProductGroups-item-response"
            }
        }
    }
}

Nested Schema : Accounting Calendars

Type: array

Title: Accounting Calendars

The Accounting Calendar resource is used to create accounting calendar.

Show Source

• Array of: object setupAssistants-AccountingCalendars-item-response

{
    "title":"Accounting Calendars",
    "type":"array",
    "description":"The Accounting Calendar resource is used to create accounting calendar.",
    "items":{
        "$ref":"#/components/schemas/setupAssistants-AccountingCalendars-item-response"
    }
}

Nested Schema : Adaptive Searches

Type: array

Title: Adaptive Searches

The adaptive search resource is used to view, create and update configuration for adaptive search. This configuration will be used to submit the adaptive search publish task.

Show Source

• Array of: object setupAssistants-AdaptiveSearch-item-response

{
    "title":"Adaptive Searches",
    "type":"array",
    "description":"The adaptive search resource is used to view, create and update configuration for adaptive search. This configuration will be used to submit the adaptive search publish task.",
    "items":{
        "$ref":"#/components/schemas/setupAssistants-AdaptiveSearch-item-response"
    }
}

Nested Schema : Company Profiles

Type: array

Title: Company Profiles

The Company Profile resource is used to create the enterprise information.

Show Source

• Array of: object setupAssistants-CompanyProfiles-item-response

{
    "title":"Company Profiles",
    "type":"array",
    "description":"The Company Profile resource is used to create the enterprise information.",
    "items":{
        "$ref":"#/components/schemas/setupAssistants-CompanyProfiles-item-response"
    }
}

Nested Schema : Competitors

Type: array

Title: Competitors

The Competitors resource is used to create competitors.

Show Source

• Array of: object setupAssistants-Competitors-item-response

{
    "title":"Competitors",
    "type":"array",
    "description":"The Competitors resource is used to create competitors.",
    "items":{
        "$ref":"#/components/schemas/setupAssistants-Competitors-item-response"
    }
}

Nested Schema : Geographies

Type: array

Title: Geographies

The Geographies resource is used to import geographies and enable geocoding.

Show Source

• Array of: object setupAssistants-Geographies-item-response

{
    "title":"Geographies",
    "type":"array",
    "description":"The Geographies resource is used to import geographies and enable geocoding.",
    "items":{
        "$ref":"#/components/schemas/setupAssistants-Geographies-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : Opportunities

Type: array

Title: Opportunities

The Opportunities resource is used to create, view and update opportunity setup.

Show Source

• Array of: object setupAssistants-Opportunities-item-response

{
    "title":"Opportunities",
    "type":"array",
    "description":"The Opportunities resource is used to create, view and update opportunity setup.",
    "items":{
        "$ref":"#/components/schemas/setupAssistants-Opportunities-item-response"
    }
}

Nested Schema : Product Groups

Type: array

Title: Product Groups

The Product Group resource is used to create the root product group.

Show Source

• Array of: object setupAssistants-ProductGroups-item-response

{
    "title":"Product Groups",
    "type":"array",
    "description":"The Product Group resource is used to create the root product group.",
    "items":{
        "$ref":"#/components/schemas/setupAssistants-ProductGroups-item-response"
    }
}

Nested Schema : Role Mappings

Type: array

Title: Role Mappings

The Resource Role Mapping resource is used to create resource roles and role mappings.

Show Source

• Array of: object setupAssistants-RoleMappings-item-response

{
    "title":"Role Mappings",
    "type":"array",
    "description":"The Resource Role Mapping resource is used to create resource roles and role mappings.",
    "items":{
        "$ref":"#/components/schemas/setupAssistants-RoleMappings-item-response"
    }
}

Nested Schema : Sales Forecasts

Type: array

Title: Sales Forecasts

The Sales Forecasting resource is used to setup owner based sales forecasting.

Show Source

• Array of: object setupAssistants-SalesForecastings-item-response

{
    "title":"Sales Forecasts",
    "type":"array",
    "description":"The Sales Forecasting resource is used to setup owner based sales forecasting.",
    "items":{
        "$ref":"#/components/schemas/setupAssistants-SalesForecastings-item-response"
    }
}

Nested Schema : Sales Stages

Type: array

Title: Sales Stages

The Sales Stages resource is used to create, view and update sales stages for the selected sales method.

Show Source

• Array of: object setupAssistants-SalesStages-item-response

{
    "title":"Sales Stages",
    "type":"array",
    "description":"The Sales Stages resource is used to create, view and update sales stages for the selected sales method.",
    "items":{
        "$ref":"#/components/schemas/setupAssistants-SalesStages-item-response"
    }
}

Nested Schema : Setup Histories

Type: array

Title: Setup Histories

The setup history resource is used to view setup data captured by the Setup Assistant.

Show Source

• Array of: object setupAssistants-SetupHistory-item-response

{
    "title":"Setup Histories",
    "type":"array",
    "description":"The setup history resource is used to view setup data captured by the Setup Assistant.",
    "items":{
        "$ref":"#/components/schemas/setupAssistants-SetupHistory-item-response"
    }
}

Nested Schema : Setup Progress

Type: array

Title: Setup Progress

The Setup Progress resource is used to monitor the progress of the setup tasks started by the Setup Assistant.

Show Source

• Array of: object setupAssistants-SetupProgress-item-response

{
    "title":"Setup Progress",
    "type":"array",
    "description":"The Setup Progress resource is used to monitor the progress of the setup tasks started by the Setup Assistant.",
    "items":{
        "$ref":"#/components/schemas/setupAssistants-SetupProgress-item-response"
    }
}

Nested Schema : Setup Users

Type: array

Title: Setup Users

The Setup Users resource is used to create setup users.

Show Source

• Array of: object setupAssistants-SetupUsers-item-response

{
    "title":"Setup Users",
    "type":"array",
    "description":"The Setup Users resource is used to create setup users.",
    "items":{
        "$ref":"#/components/schemas/setupAssistants-SetupUsers-item-response"
    }
}

Nested Schema : Top Sales Users

Type: array

Title: Top Sales Users

The Top Sales User resource is used to create the top sales user and set the user at the top of the sales hierarchy.

Show Source

• Array of: object setupAssistants-TopSalesUsers-item-response

{
    "title":"Top Sales Users",
    "type":"array",
    "description":"The Top Sales User resource is used to create the top sales user and set the user at the top of the sales hierarchy.",
    "items":{
        "$ref":"#/components/schemas/setupAssistants-TopSalesUsers-item-response"
    }
}

Nested Schema : setupAssistants-AccountingCalendars-item-response

Type: object

Show Source

• Description: string
  Maximum Length: 255

  The description of the accounting calendar.
• Id: string
  The unique identifier of an accounting calendar setup task.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Name: string
  Maximum Length: 15

  Default Value: Sales Calendar

  The name of the accounting calendar.
• PeriodFrequency: string
  Maximum Length: 25

  Default Value: MONTH

  The frequency of the accounting calendar.
• PeriodNameFormat: string
  Maximum Length: 25

  Default Value: MMMYYCY

  The period format associated with the accounting calendar.
• PeriodStartMonth: string
  Maximum Length: 20

  Default Value: 01

  The start month for the accounting calendar.
• PeriodStartYear: string
  Maximum Length: 4

  The start year for the accounting calendar.

{
    "type":"object",
    "properties":{
        "Description":{
            "maxLength":"255",
            "type":"string",
            "description":"The description of the accounting calendar.",
            "nullable":true,
            "x-queryable":true
        },
        "PeriodStartYear":{
            "maxLength":"4",
            "type":"string",
            "description":"The start year for the accounting calendar.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "Id":{
            "type":"string",
            "description":"The unique identifier of an accounting calendar setup task.",
            "nullable":false,
            "x-queryable":true
        },
        "PeriodFrequency":{
            "maxLength":"25",
            "type":"string",
            "description":"The frequency of the accounting calendar.",
            "nullable":true,
            "default":"MONTH",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PeriodNameFormat":{
            "maxLength":"25",
            "type":"string",
            "description":"The period format associated with the accounting calendar.",
            "nullable":true,
            "default":"MMMYYCY",
            "x-queryable":true
        },
        "PeriodStartMonth":{
            "maxLength":"20",
            "type":"string",
            "description":"The start month for the accounting calendar.",
            "nullable":true,
            "default":"01",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Name":{
            "maxLength":"15",
            "type":"string",
            "description":"The name of the accounting calendar.",
            "nullable":false,
            "default":"Sales Calendar",
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : setupAssistants-AdaptiveSearch-item-response

Type: object

Show Source

• Account: string
  Maximum Length: 80

  Default Value: Y

  Indicates whether the account has been selected for adaptive search publish.
• Activity: string
  Maximum Length: 80

  Default Value: Y

  Indicates whether the activity has been selected for adaptive search publish.
• Asset: string
  Maximum Length: 80

  Default Value: Y

  Indicates whether the Revenue Lines object has been selected for inclusion in the Adaptive Search Publish process. If true, then revenue lines are included in the process. By default, the value is true.
• Contact: string
  Maximum Length: 80

  Default Value: Y

  Indicates whether the contact has been selected for adaptive search publish.
• Id: string
  Maximum Length: 80

  The unique identifier of the adaptive search setup task.
• Lead: string
  Maximum Length: 80

  Default Value: Y

  Indicates whether the Asset object has been selected for inclusion in the Adaptive Search Publish process. If true, then assets are included in the process. By default, the value is true.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Opportunity: string
  Maximum Length: 80

  Default Value: Y

  Indicates whether the opportunity has been selected for adaptive search publish.
• Partner: string
  Maximum Length: 80

  Default Value: N

  Indicates whether the partner has been selected for adaptive search publish.
• PartnerContact: string
  Maximum Length: 80

  Default Value: N

  Indicates whether the partner contact has been selected for adaptive search publish.
• Product: string
  Maximum Length: 80

  Default Value: Y

  Indicates whether Product has been selected for the adaptive search publish.
• ProductGroup: string
  Maximum Length: 80

  Default Value: Y

  Indicates whether Product Group has been selected for the adaptive search publish.
• RevenueLines: string
  Maximum Length: 80

  Default Value: Y

  Indicates whether the lead has been selected for adaptive search publish.
• ServiceRequest: string
  Maximum Length: 80

  Default Value: N

  Indicates whether the service request has been selected for adaptive search publish.

{
    "type":"object",
    "properties":{
        "Account":{
            "maxLength":"80",
            "type":"string",
            "description":"Indicates whether the account has been selected for adaptive search publish.",
            "nullable":false,
            "default":"Y",
            "x-queryable":true
        },
        "ProductGroup":{
            "maxLength":"80",
            "type":"string",
            "description":"Indicates whether Product Group has been selected for the adaptive search publish.",
            "nullable":false,
            "default":"Y",
            "x-queryable":true
        },
        "Activity":{
            "maxLength":"80",
            "type":"string",
            "description":"Indicates whether the activity has been selected for adaptive search publish.",
            "nullable":false,
            "default":"Y",
            "x-queryable":true
        },
        "Product":{
            "maxLength":"80",
            "type":"string",
            "description":"Indicates whether Product has been selected for the adaptive search publish.",
            "nullable":false,
            "default":"Y",
            "x-queryable":true
        },
        "RevenueLines":{
            "maxLength":"80",
            "type":"string",
            "description":"Indicates whether the lead has been selected for adaptive search publish.",
            "nullable":false,
            "default":"Y",
            "x-queryable":true
        },
        "PartnerContact":{
            "maxLength":"80",
            "type":"string",
            "description":"Indicates whether the partner contact has been selected for adaptive search publish.",
            "nullable":false,
            "default":"N",
            "x-queryable":true
        },
        "ServiceRequest":{
            "maxLength":"80",
            "type":"string",
            "description":"Indicates whether the service request has been selected for adaptive search publish.",
            "nullable":false,
            "default":"N",
            "x-queryable":true
        },
        "Contact":{
            "maxLength":"80",
            "type":"string",
            "description":"Indicates whether the contact has been selected for adaptive search publish.",
            "nullable":false,
            "default":"Y",
            "x-queryable":true
        },
        "Opportunity":{
            "maxLength":"80",
            "type":"string",
            "description":"Indicates whether the opportunity has been selected for adaptive search publish.",
            "nullable":false,
            "default":"Y",
            "x-queryable":true
        },
        "Lead":{
            "maxLength":"80",
            "type":"string",
            "description":"Indicates whether the Asset object has been selected for inclusion in the Adaptive Search Publish process. If true, then assets are included in the process. By default, the value is true.",
            "nullable":false,
            "default":"Y",
            "x-queryable":true
        },
        "Asset":{
            "maxLength":"80",
            "type":"string",
            "description":"Indicates whether the Revenue Lines object has been selected for inclusion in the Adaptive Search Publish process. If true, then revenue lines are included in the process. By default, the value is true.",
            "nullable":false,
            "default":"Y",
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "Id":{
            "maxLength":"80",
            "type":"string",
            "description":"The unique identifier of the adaptive search setup task.",
            "nullable":false,
            "x-queryable":true
        },
        "Partner":{
            "maxLength":"80",
            "type":"string",
            "description":"Indicates whether the partner has been selected for adaptive search publish.",
            "nullable":false,
            "default":"N",
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : setupAssistants-CompanyProfiles-item-response

Type: object

Show Source

• Addressline: string
  Maximum Length: 100

  The first line of the organization address.
• BusinessUnit: string
  Maximum Length: 80

  Business Unit
• CorporateCurrency: string
  Maximum Length: 80

  Default Value: USD

  The default corporate currency code.
• Country: string
  Maximum Length: 80

  Default Value: US

  The country of the enterprise.
• EnterpriseName: string
  Maximum Length: 100

  The name of the enterprise.
• Id: string
  Maximum Length: 80

  The unique identifier of the company profile setup task.
• IsDataExisting: string
  Maximum Length: 80

  Indicates if the enterprise setup data was created before running the Setup Assistant.
• LegalEntity: string
  Maximum Length: 80

  Legal Entity
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• TaxRegNumber: string
  Maximum Length: 80

  Enterprise Tax Registration Number

{
    "type":"object",
    "properties":{
        "LegalEntity":{
            "maxLength":"80",
            "type":"string",
            "description":"Legal Entity",
            "nullable":true,
            "x-queryable":true
        },
        "TaxRegNumber":{
            "maxLength":"80",
            "type":"string",
            "description":"Enterprise Tax Registration Number",
            "nullable":true,
            "x-queryable":true
        },
        "Addressline":{
            "maxLength":"100",
            "type":"string",
            "description":"The first line of the organization address.",
            "nullable":true,
            "x-queryable":true
        },
        "CorporateCurrency":{
            "maxLength":"80",
            "type":"string",
            "description":"The default corporate currency code.",
            "nullable":false,
            "default":"USD",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "EnterpriseName":{
            "maxLength":"100",
            "type":"string",
            "description":"The name of the enterprise.",
            "nullable":true,
            "x-queryable":true
        },
        "IsDataExisting":{
            "maxLength":"80",
            "type":"string",
            "description":"Indicates if the enterprise setup data was created before running the Setup Assistant.",
            "nullable":true,
            "x-queryable":true
        },
        "BusinessUnit":{
            "maxLength":"80",
            "type":"string",
            "description":"Business Unit",
            "nullable":true,
            "x-queryable":true
        },
        "Country":{
            "maxLength":"80",
            "type":"string",
            "description":"The country of the enterprise.",
            "nullable":true,
            "default":"US",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "Id":{
            "maxLength":"80",
            "type":"string",
            "description":"The unique identifier of the company profile setup task.",
            "nullable":false,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : setupAssistants-Competitors-item-response

Type: object

Show Source

• Id: string
  Maximum Length: 80

  The unique identifier of a competitor.
• LineOfBusiness: string
  Maximum Length: 240

  The line of business of the competitor.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Name: string
  Maximum Length: 360

  The name of the competitor.
• NameSuffix: string
  Maximum Length: 540

  The name suffix of the competitor.
• OrganizationSize: string
  Maximum Length: 80

  The size of the organization based on its revenue, number of employees, and others.
• ThreatLevel: string
  Maximum Length: 80

  The level of threat to signify the competitive risk.

{
    "type":"object",
    "properties":{
        "OrganizationSize":{
            "maxLength":"80",
            "type":"string",
            "description":"The size of the organization based on its revenue, number of employees, and others.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ThreatLevel":{
            "maxLength":"80",
            "type":"string",
            "description":"The level of threat to signify the competitive risk.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LineOfBusiness":{
            "maxLength":"240",
            "type":"string",
            "description":"The line of business of the competitor.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "NameSuffix":{
            "maxLength":"540",
            "type":"string",
            "description":"The name suffix of the competitor.",
            "nullable":true,
            "x-queryable":true
        },
        "Id":{
            "maxLength":"80",
            "type":"string",
            "description":"The unique identifier of a competitor.",
            "nullable":false,
            "x-queryable":true
        },
        "Name":{
            "maxLength":"360",
            "type":"string",
            "description":"The name of the competitor.",
            "nullable":false,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : setupAssistants-Geographies-item-response

Type: object

Show Source

• CountryFirst: string
  Maximum Length: 80

  The first country for which the geography data has to be imported.
• CountrySecond: string
  Maximum Length: 80

  The second country for which the geography data has to be imported.
• CountryThird: string
  Maximum Length: 80

  The third country for which the geography data has to be imported.
• EnableGeoEncoding: string
  Maximum Length: 5

  Default Value: N

  Indicates if the geography encoding has to be enabled for the imported countries.
• Id: string
  The unique identifier of geography setup task.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "CountryThird":{
            "maxLength":"80",
            "type":"string",
            "description":"The third country for which the geography data has to be imported.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CountrySecond":{
            "maxLength":"80",
            "type":"string",
            "description":"The second country for which the geography data has to be imported.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Id":{
            "type":"string",
            "description":"The unique identifier of geography setup task.",
            "nullable":false,
            "x-queryable":true
        },
        "EnableGeoEncoding":{
            "maxLength":"5",
            "type":"string",
            "description":"Indicates if the geography encoding has to be enabled for the imported countries.",
            "nullable":true,
            "default":"N",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CountryFirst":{
            "maxLength":"80",
            "type":"string",
            "description":"The first country for which the geography data has to be imported.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : setupAssistants-Opportunities-item-response

Type: object

Show Source

• Id: string
  The unique identifier of opportunity setup task.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OptyCloseDate: string
  Maximum Length: 1000

  Default Value: 20

  The default date on which the opportunity will be closed.
• RequireCloseOptyCompetitor: string
  Maximum Length: 1

  Default Value: Y

  Indicates if you need to enter competitor details before closing an opportunity.
• RequireOptyCloseReason: string
  Maximum Length: 1

  Default Value: Y

  Indicates if you need to indicate the win or loss reason before closing an opportunity.
• SalesMethodNumber: string
  Maximum Length: 64

  The default sales method number if one isn't provided.
• SalesStages: array Sales Stages
  Title: Sales Stages

  The Sales Stages resource is used to create, view and update sales stages for the selected sales method.

{
    "type":"object",
    "properties":{
        "RequireOptyCloseReason":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates if you need to indicate the win or loss reason before closing an opportunity.",
            "nullable":false,
            "default":"Y",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SalesMethodNumber":{
            "maxLength":"64",
            "type":"string",
            "description":"The default sales method number if one isn't provided.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RequireCloseOptyCompetitor":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates if you need to enter competitor details before closing an opportunity.",
            "nullable":false,
            "default":"Y",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "OptyCloseDate":{
            "maxLength":"1000",
            "type":"string",
            "description":"The default date on which the opportunity will be closed.",
            "nullable":false,
            "default":"20",
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "Id":{
            "type":"string",
            "description":"The unique identifier of opportunity setup task.",
            "nullable":false,
            "x-queryable":true
        },
        "SalesStages":{
            "title":"Sales Stages",
            "type":"array",
            "description":"The Sales Stages resource is used to create, view and update sales stages for the selected sales method.",
            "items":{
                "$ref":"#/components/schemas/setupAssistants-Opportunities-SalesStages-item-response"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : Sales Stages

Type: array

Title: Sales Stages

The Sales Stages resource is used to create, view and update sales stages for the selected sales method.

Show Source

• Array of: object setupAssistants-Opportunities-SalesStages-item-response

{
    "title":"Sales Stages",
    "type":"array",
    "description":"The Sales Stages resource is used to create, view and update sales stages for the selected sales method.",
    "items":{
        "$ref":"#/components/schemas/setupAssistants-Opportunities-SalesStages-item-response"
    }
}

Nested Schema : setupAssistants-Opportunities-SalesStages-item-response

Type: object

Show Source

• DeletedFlag: boolean
  Maximum Length: 2

  Default Value: false

  Indicates if the sales method can be deleted.
• DescriptionText: string
  Maximum Length: 255

  The description of the sales stage.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Name: string
  Maximum Length: 50

  The name of the sales stage.
• PhaseCd: string
  Maximum Length: 30

  Default Value: QUALIFICATION-DISCOVERY

  The code for phase of sales stage.
• RcmndWinProb: string
  Maximum Length: 22

  The win probability of sales stage.
• StageNumber: string
  Read Only: true

  Maximum Length: 64

  Default Value: -1

  An alternate unique identifier of the stage.
• StageStatusCd: string
  Maximum Length: 30

  Default Value: OPEN

  A code indicating the status of the sales stage.
• StgId: integer
  The unique identifier of the sales stage.
• StgOrder: string
  Maximum Length: 22

  The order in which the sales stage will be displayed.

{
    "type":"object",
    "properties":{
        "StageNumber":{
            "maxLength":"64",
            "type":"string",
            "description":"An alternate unique identifier of the stage.",
            "nullable":true,
            "readOnly":true,
            "default":"-1",
            "x-queryable":true
        },
        "StageStatusCd":{
            "maxLength":"30",
            "type":"string",
            "description":"A code indicating the status of the sales stage.",
            "nullable":false,
            "default":"OPEN",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "StgId":{
            "type":"integer",
            "description":"The unique identifier of the sales stage.",
            "nullable":false,
            "x-queryable":true
        },
        "RcmndWinProb":{
            "maxLength":"22",
            "type":"string",
            "description":"The win probability of sales stage.",
            "nullable":true,
            "x-queryable":true
        },
        "DeletedFlag":{
            "maxLength":"2",
            "type":"boolean",
            "description":"Indicates if the sales method can be deleted.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PhaseCd":{
            "maxLength":"30",
            "type":"string",
            "description":"The code for phase of sales stage.",
            "nullable":false,
            "default":"QUALIFICATION-DISCOVERY",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "DescriptionText":{
            "maxLength":"255",
            "type":"string",
            "description":"The description of the sales stage.",
            "nullable":true,
            "x-queryable":true
        },
        "StgOrder":{
            "maxLength":"22",
            "type":"string",
            "description":"The order in which the sales stage will be displayed.",
            "nullable":false,
            "x-queryable":true
        },
        "Name":{
            "maxLength":"50",
            "type":"string",
            "description":"The name of the sales stage.",
            "nullable":false,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : setupAssistants-ProductGroups-item-response

Type: object

Show Source

• Description: string
  Maximum Length: 1000

  A description for the product group.
• DisplayName: string
  Maximum Length: 150

  The name of the product group.
• Id: string
  The unique identifier of the product group.
• InternalName: string
  Maximum Length: 150

  The internal name of the product group.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "DisplayName":{
            "maxLength":"150",
            "type":"string",
            "description":"The name of the product group.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "Id":{
            "type":"string",
            "description":"The unique identifier of the product group.",
            "nullable":false,
            "x-queryable":true
        },
        "Description":{
            "maxLength":"1000",
            "type":"string",
            "description":"A description for the product group.",
            "nullable":true,
            "x-queryable":true
        },
        "InternalName":{
            "maxLength":"150",
            "type":"string",
            "description":"The internal name of the product group.",
            "nullable":false,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : setupAssistants-RoleMappings-item-response

Type: object

Show Source

• Id: string
  The unique identifier of resource role and mapping setup details.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ResourceRoleName: string
  Maximum Length: 60

  The role name of the resource.
• RoleCommonNameCode: string
  The code value application job role to which resource role will be mapped.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ResourceRoleName":{
            "maxLength":"60",
            "type":"string",
            "description":"The role name of the resource.",
            "nullable":false,
            "x-queryable":true
        },
        "Id":{
            "type":"string",
            "description":"The unique identifier of resource role and mapping setup details.",
            "nullable":false,
            "x-queryable":true
        },
        "RoleCommonNameCode":{
            "type":"string",
            "description":"The code value application job role to which resource role will be mapped.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : setupAssistants-SalesForecastings-item-response

Type: object

Show Source

• EnableNGSForecasting: string
  Maximum Length: 1

  Default Value: N

  Indicates if sales forecast setup has to be done.
• Id: string
  The unique identifier of the sales forecast setup task.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "EnableNGSForecasting":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates if sales forecast setup has to be done.",
            "nullable":false,
            "default":"N",
            "x-queryable":true
        },
        "Id":{
            "type":"string",
            "description":"The unique identifier of the sales forecast setup task.",
            "nullable":false,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : setupAssistants-SalesStages-item-response

Type: object

Show Source

• DeletedFlag: boolean
  Maximum Length: 2

  Default Value: false

  Indicates if the sales method can be deleted.
• DescriptionText: string
  Maximum Length: 255

  The description of the sales stage.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Name: string
  Maximum Length: 50

  The name of the sales stage.
• PhaseCd: string
  Maximum Length: 30

  Default Value: QUALIFICATION-DISCOVERY

  The code for phase of sales stage.
• RcmndWinProb: string
  Maximum Length: 22

  The win probability of sales stage.
• StageNumber: string
  Read Only: true

  Maximum Length: 64

  Default Value: -1

  An alternate unique identifier of the stage.
• StageStatusCd: string
  Maximum Length: 30

  Default Value: OPEN

  A code indicating the status of the sales stage.
• StgId: integer
  The unique identifier of the sales stage.
• StgOrder: string
  Maximum Length: 22

  The order in which the sales stage will be displayed.

{
    "type":"object",
    "properties":{
        "StageNumber":{
            "maxLength":"64",
            "type":"string",
            "description":"An alternate unique identifier of the stage.",
            "nullable":true,
            "readOnly":true,
            "default":"-1",
            "x-queryable":true
        },
        "StageStatusCd":{
            "maxLength":"30",
            "type":"string",
            "description":"A code indicating the status of the sales stage.",
            "nullable":false,
            "default":"OPEN",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "StgId":{
            "type":"integer",
            "description":"The unique identifier of the sales stage.",
            "nullable":false,
            "x-queryable":true
        },
        "RcmndWinProb":{
            "maxLength":"22",
            "type":"string",
            "description":"The win probability of sales stage.",
            "nullable":true,
            "x-queryable":true
        },
        "DeletedFlag":{
            "maxLength":"2",
            "type":"boolean",
            "description":"Indicates if the sales method can be deleted.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PhaseCd":{
            "maxLength":"30",
            "type":"string",
            "description":"The code for phase of sales stage.",
            "nullable":false,
            "default":"QUALIFICATION-DISCOVERY",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "DescriptionText":{
            "maxLength":"255",
            "type":"string",
            "description":"The description of the sales stage.",
            "nullable":true,
            "x-queryable":true
        },
        "StgOrder":{
            "maxLength":"22",
            "type":"string",
            "description":"The order in which the sales stage will be displayed.",
            "nullable":false,
            "x-queryable":true
        },
        "Name":{
            "maxLength":"50",
            "type":"string",
            "description":"The name of the sales stage.",
            "nullable":false,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : setupAssistants-SetupHistory-item-response

Type: object

Show Source

• History: string
  Read Only: true

  The setup data history of the setup task.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• TaskCode: string
  Read Only: true

  The code value of the setup task in the Setup Assistant.

{
    "type":"object",
    "properties":{
        "History":{
            "type":"string",
            "description":"The setup data history of the setup task.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "TaskCode":{
            "type":"string",
            "description":"The code value of the setup task in the Setup Assistant.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : setupAssistants-SetupProgress-item-response

Type: object

Show Source

• Active: string
  Read Only: true

  Maximum Length: 255

  Indicates if the this setup task is active.
• ErrorMessage: string
  Read Only: true

  The error message associated with a failed setup task.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• TaskCode: string
  Read Only: true

  The code value of the setup task in the Setup Assistant.
• TaskName: string
  Read Only: true

  The name of the setup task in the Setup Assistant.
• TaskOrder: string
  Read Only: true

  Maximum Length: 255

  The order in which setup task will be displayed.
• TaskStatus: string
  Read Only: true

  The status of the setup task in the Setup Assistant.
• TaskStatusCode: string
  Read Only: true

  The code value of setup task status displayed in the Status page of the Setup Assistant.

{
    "type":"object",
    "properties":{
        "TaskOrder":{
            "maxLength":"255",
            "type":"string",
            "description":"The order in which setup task will be displayed.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TaskCode":{
            "type":"string",
            "description":"The code value of the setup task in the Setup Assistant.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Active":{
            "maxLength":"255",
            "type":"string",
            "description":"Indicates if the this setup task is active.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TaskName":{
            "type":"string",
            "description":"The name of the setup task in the Setup Assistant.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TaskStatusCode":{
            "type":"string",
            "description":"The code value of setup task status displayed in the Status page of the Setup Assistant.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "TaskStatus":{
            "type":"string",
            "description":"The status of the setup task in the Setup Assistant.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ErrorMessage":{
            "type":"string",
            "description":"The error message associated with a failed setup task.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : setupAssistants-SetupUsers-item-response

Type: object

Show Source

• Email: string
  Maximum Length: 320

  The email of the setup user to whom updates will be sent.
• FirstName: string
  Maximum Length: 150

  The first name of the setup user.
• Id: string
  Maximum Length: 80

  The unique identifier of a setup user setup task.
• LastName: string
  Maximum Length: 150

  The last name of the setup user.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "Id":{
            "maxLength":"80",
            "type":"string",
            "description":"The unique identifier of a setup user setup task.",
            "nullable":false,
            "x-queryable":true
        },
        "Email":{
            "maxLength":"320",
            "type":"string",
            "description":"The email of the setup user to whom updates will be sent.",
            "nullable":false,
            "x-queryable":true
        },
        "LastName":{
            "maxLength":"150",
            "type":"string",
            "description":"The last name of the setup user.",
            "nullable":false,
            "x-queryable":true
        },
        "FirstName":{
            "maxLength":"150",
            "type":"string",
            "description":"The first name of the setup user.",
            "nullable":false,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : setupAssistants-TopSalesUsers-item-response

Type: object

Show Source

• EMail: string
  Maximum Length: 320

  The email of the top sales user.
• FirstName: string
  Maximum Length: 150

  The first name of the top sales user.
• Id: string
  The unique identifier of top sales user setup details.
• LastName: string
  Maximum Length: 150

  The last name of the top sales user.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ResourceOrganization: string
  Maximum Length: 240

  The resource organization to which the sales user belongs.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "Id":{
            "type":"string",
            "description":"The unique identifier of top sales user setup details.",
            "nullable":false,
            "x-queryable":true
        },
        "LastName":{
            "maxLength":"150",
            "type":"string",
            "description":"The last name of the top sales user.",
            "nullable":false,
            "x-queryable":true
        },
        "ResourceOrganization":{
            "maxLength":"240",
            "type":"string",
            "description":"The resource organization to which the sales user belongs.",
            "nullable":false,
            "x-queryable":true
        },
        "EMail":{
            "maxLength":"320",
            "type":"string",
            "description":"The email of the top sales user.",
            "nullable":false,
            "x-queryable":true
        },
        "FirstName":{
            "maxLength":"150",
            "type":"string",
            "description":"The first name of the top sales user.",
            "nullable":false,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Links

AccountingCalendars

Operation: /crmRestApi/resources/11.13.18.05/setupAssistants/{Name}/child/AccountingCalendars

Parameters:

• Name: $request.path.Name

The Accounting Calendar resource is used to create accounting calendar.

AdaptiveSearch

Operation: /crmRestApi/resources/11.13.18.05/setupAssistants/{Name}/child/AdaptiveSearch

Parameters:

• Name: $request.path.Name

The adaptive search resource is used to view, create and update configuration for adaptive search. This configuration will be used to submit the adaptive search publish task.

CompanyProfiles

Operation: /crmRestApi/resources/11.13.18.05/setupAssistants/{Name}/child/CompanyProfiles

Parameters:

• Name: $request.path.Name

The Company Profile resource is used to create the enterprise information.

Competitors

Operation: /crmRestApi/resources/11.13.18.05/setupAssistants/{Name}/child/Competitors

Parameters:

• Name: $request.path.Name

The Competitors resource is used to create competitors.

Geographies

Operation: /crmRestApi/resources/11.13.18.05/setupAssistants/{Name}/child/Geographies

Parameters:

• Name: $request.path.Name

The Geographies resource is used to import geographies and enable geocoding.

Opportunities

Operation: /crmRestApi/resources/11.13.18.05/setupAssistants/{Name}/child/Opportunities

Parameters:

• Name: $request.path.Name

The Opportunities resource is used to create, view and update opportunity setup.

ProductGroups

Operation: /crmRestApi/resources/11.13.18.05/setupAssistants/{Name}/child/ProductGroups

Parameters:

• Name: $request.path.Name

The Product Group resource is used to create the root product group.

RoleMappings

Operation: /crmRestApi/resources/11.13.18.05/setupAssistants/{Name}/child/RoleMappings

Parameters:

• Name: $request.path.Name

The Resource Role Mapping resource is used to create resource roles and role mappings.

SalesForecastings

Operation: /crmRestApi/resources/11.13.18.05/setupAssistants/{Name}/child/SalesForecastings

Parameters:

• Name: $request.path.Name

The Sales Forecasting resource is used to setup owner based sales forecasting.

SalesStages

Operation: /crmRestApi/resources/11.13.18.05/setupAssistants/{Name}/child/SalesStages

Parameters:

• Name: $request.path.Name

The Sales Stages resource is used to create, view and update sales stages for the selected sales method.

SetupHistory

Operation: /crmRestApi/resources/11.13.18.05/setupAssistants/{Name}/child/SetupHistory

Parameters:

• Name: $request.path.Name

The setup history resource is used to view setup data captured by the Setup Assistant.

SetupProgress

Operation: /crmRestApi/resources/11.13.18.05/setupAssistants/{Name}/child/SetupProgress

Parameters:

• Name: $request.path.Name

The Setup Progress resource is used to monitor the progress of the setup tasks started by the Setup Assistant.

SetupUsers

Operation: /crmRestApi/resources/11.13.18.05/setupAssistants/{Name}/child/SetupUsers

Parameters:

• Name: $request.path.Name

The Setup Users resource is used to create setup users.

TopSalesUsers

Operation: /crmRestApi/resources/11.13.18.05/setupAssistants/{Name}/child/TopSalesUsers

Parameters:

• Name: $request.path.Name

The Top Sales User resource is used to create the top sales user and set the user at the top of the sales hierarchy.

Back to Top