Get a setup task
get
/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=
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
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.
There's no request body for this operation.
Back to TopResponse
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.
Root Schema : setupAssistants-item-response
Type:
Show Source
object
-
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.
Nested Schema : Accounting Calendars
Type:
array
Title:
Accounting Calendars
The Accounting Calendar resource is used to create accounting calendar.
Show Source
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
Nested Schema : Company Profiles
Type:
array
Title:
Company Profiles
The Company Profile resource is used to create the enterprise information.
Show Source
Nested Schema : Competitors
Type:
array
Title:
Competitors
The Competitors resource is used to create competitors.
Show Source
Nested Schema : Geographies
Type:
array
Title:
Geographies
The Geographies resource is used to import geographies and enable geocoding.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Opportunities
Type:
array
Title:
Opportunities
The Opportunities resource is used to create, view and update opportunity setup.
Show Source
Nested Schema : Product Groups
Type:
array
Title:
Product Groups
The Product Group resource is used to create the root product group.
Show Source
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
Nested Schema : Sales Forecasts
Type:
array
Title:
Sales Forecasts
The Sales Forecasting resource is used to setup owner based sales forecasting.
Show Source
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
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
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
Nested Schema : Setup Users
Type:
array
Title:
Setup Users
The Setup Users resource is used to create setup users.
Show Source
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
Nested Schema : setupAssistants-AccountingCalendars-item-response
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : setupAssistants-AdaptiveSearch-item-response
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : setupAssistants-CompanyProfiles-item-response
Type:
Show Source
object
-
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
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : setupAssistants-Competitors-item-response
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : setupAssistants-Geographies-item-response
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : setupAssistants-Opportunities-item-response
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
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
Nested Schema : setupAssistants-Opportunities-SalesStages-item-response
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : setupAssistants-ProductGroups-item-response
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : setupAssistants-RoleMappings-item-response
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : setupAssistants-SalesForecastings-item-response
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : setupAssistants-SalesStages-item-response
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : setupAssistants-SetupHistory-item-response
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : setupAssistants-SetupProgress-item-response
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : setupAssistants-SetupUsers-item-response
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : setupAssistants-TopSalesUsers-item-response
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- AccountingCalendars
-
Parameters:
- Name:
$request.path.Name
The Accounting Calendar resource is used to create accounting calendar. - Name:
- 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. - Name:
- CompanyProfiles
-
Parameters:
- Name:
$request.path.Name
The Company Profile resource is used to create the enterprise information. - Name:
- Competitors
-
Parameters:
- Name:
$request.path.Name
The Competitors resource is used to create competitors. - Name:
- Geographies
-
Parameters:
- Name:
$request.path.Name
The Geographies resource is used to import geographies and enable geocoding. - Name:
- Opportunities
-
Parameters:
- Name:
$request.path.Name
The Opportunities resource is used to create, view and update opportunity setup. - Name:
- ProductGroups
-
Parameters:
- Name:
$request.path.Name
The Product Group resource is used to create the root product group. - Name:
- RoleMappings
-
Parameters:
- Name:
$request.path.Name
The Resource Role Mapping resource is used to create resource roles and role mappings. - Name:
- SalesForecastings
-
Parameters:
- Name:
$request.path.Name
The Sales Forecasting resource is used to setup owner based sales forecasting. - Name:
- SalesStages
-
Parameters:
- Name:
$request.path.Name
The Sales Stages resource is used to create, view and update sales stages for the selected sales method. - Name:
- SetupHistory
-
Parameters:
- Name:
$request.path.Name
The setup history resource is used to view setup data captured by the Setup Assistant. - Name:
- 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. - Name:
- SetupUsers
-
Parameters:
- Name:
$request.path.Name
The Setup Users resource is used to create setup users. - Name:
- 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. - Name: