SuperOffice

Links

    SuperOffice API

    Getting access, Developing, Testing

    Back to SuperOffice

    Creates a new DashboardTile

    Calls the Dashboard agent service SaveDashboardTile.

    Input

    type: object properties: parameters: type: object properties: newEntity: description: "Dashboard Tile configuration\r\n<para />\r\nCarrier object for DashboardTile.\r\nServices for the DashboardTile Carrier is available from the <see cref=\"T:SuperOffice.CRM.Services.IDashboardAgent\">Dashboard Agent</see>." type: object properties: DashboardTileId: format: int32 description: The tile id type: integer Caption: description: The tile caption type: string Description: description: The tile description type: string ChartName: description: The original chart name type: string ChartId: description: The original chart Id type: string IsDefault: description: True if this is one of the default tiles type: boolean AssociateId: format: int32 description: Id of the associate who owns this tile type: integer GroupId: format: int32 description: Id of the associates primary group at storage time type: integer SelectionId: format: int32 description: The selection that defines the data filter/restrictions type: integer Config: description: The tile config type: string Type: description: The tile type, what kind of tile this is enum: - None - Chart - Web - List - Bignum type: string EntityType: description: The tile entity type enum: - None - Company - Project - Sale - Product - Activity - Document - WebPanel - Followup type: string Options: description: The tile options type: array items: description: "Dashboard Tile option\r\n<para />\r\nCarrier object for DashboardTileOption.\r\nServices for the DashboardTileOption Carrier is available from the <see cref=\"T:SuperOffice.CRM.Services.IDashboardAgent\">Dashboard Agent</see>." type: object properties: Name: description: Name of option, usually not visible to users type: string Description: description: Option description, visible to users type: string Type: description: The type of option - integer, list, boolean (checkbox) etc. enum: - None - String - Integer - Boolean - List type: string ListName: description: >- An MDO list name, used if the type is list and no ListOptions are given type: string ListItems: description: List options given directly, not via MDO list name type: array items: description: "Carrier object for MDOListItem.\r\nServices for the MDOListItem Carrier is available from the <see cref=\"T:SuperOffice.CRM.Services.IMDOAgent\">MDO Agent</see>." type: object properties: Id: format: int32 description: The Id of the ListItem type: integer Name: description: The name of the ListItem type: string ToolTip: description: The tooltip of the ListItem type: string Deleted: description: The deleted status of the ListItem type: boolean Rank: format: int32 description: The rank of the ListItem type: integer Type: description: The type of the ListItem. Custom field. type: string ChildItems: description: The child items of the MDOListItem type: array IconHint: description: The Icon hint of the ListItem. Custom field. type: string ColorBlock: format: int32 description: The color indicator of the ListItem color block type: integer ExtraInfo: description: >- Extra information added to the ListItem. Could be information such as sort order etc or other meta data. Custom field. type: string StyleHint: description: >- Style hint indicating, information such as background color etc. Custom field. type: string FullName: description: The name of the ListItem in its context type: string TableRight: type: object properties: Mask: enum: - None - Select - Update - Insert - Delete - Filtering - RestrictedUpdate - Unused1 - Uninitialized - FULL - WRITE - URU - UDR - UR - URI - R - RI - RF - F - FI type: string Reason: type: string FieldProperties: type: object additionalProperties: type: object properties: FieldRight: type: object properties: Mask: enum: - None - Read - Write - Update - Unused1 - Unused2 - Unused3 - Unused4 - Nullable - UIHintMandatory - UIHintReadOnly - FULL - UIHints type: string Reason: type: string FieldType: type: string FieldLength: format: int32 type: integer Value: description: >- The value, encoded as string, Id:Name of list item if type is list type: string DefaultDataOption: description: >- True if this option only applies to the default data source, not selections type: boolean TableRight: type: object properties: Mask: enum: - None - Select - Update - Insert - Delete - Filtering - RestrictedUpdate - Unused1 - Uninitialized - FULL - WRITE - URU - UDR - UR - URI - R - RI - RF - F - FI type: string Reason: type: string FieldProperties: type: object additionalProperties: type: object properties: FieldRight: type: object properties: Mask: enum: - None - Read - Write - Update - Unused1 - Unused2 - Unused3 - Unused4 - Nullable - UIHintMandatory - UIHintReadOnly - FULL - UIHints type: string Reason: type: string FieldType: type: string FieldLength: format: int32 type: integer VisibleFor: description: The set of users or groups the record is visible for type: array items: description: "Carrier object for VisibleFor.\r\nServices for the VisibleFor Carrier is available from the <see cref=\"T:SuperOffice.CRM.Services.ISentryAgent\">Sentry Agent</see>." type: object properties: VisibleId: format: int32 description: '' type: integer Visibility: description: '' enum: - All - Associate - Group type: string DisplayValue: description: '' type: string TableRight: type: object properties: Mask: enum: - None - Select - Update - Insert - Delete - Filtering - RestrictedUpdate - Unused1 - Uninitialized - FULL - WRITE - URU - UDR - UR - URI - R - RI - RF - F - FI type: string Reason: type: string FieldProperties: type: object additionalProperties: type: object properties: FieldRight: type: object properties: Mask: enum: - None - Read - Write - Update - Unused1 - Unused2 - Unused3 - Unused4 - Nullable - UIHintMandatory - UIHintReadOnly - FULL - UIHints type: string Reason: type: string FieldType: type: string FieldLength: format: int32 type: integer TableRight: type: object properties: Mask: enum: - None - Select - Update - Insert - Delete - Filtering - RestrictedUpdate - Unused1 - Uninitialized - FULL - WRITE - URU - UDR - UR - URI - R - RI - RF - F - FI type: string Reason: type: string FieldProperties: type: object additionalProperties: type: object properties: FieldRight: type: object properties: Mask: enum: - None - Read - Write - Update - Unused1 - Unused2 - Unused3 - Unused4 - Nullable - UIHintMandatory - UIHintReadOnly - FULL - UIHints type: string Reason: type: string FieldType: type: string FieldLength: format: int32 type: integer $select: type: string description: >- Optional comma separated list of properties to include in the result. Other fields are then nulled out to reduce payload size: "Name,department,category" Default = show all fields. Accept-Language: type: string description: >- Convert string references and multi-language values into a specified language (iso2) code. SO-Language: type: string description: >- Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value. SO-Culture: type: string description: >- Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set. SO-TimeZone: type: string description: >- Specify the timezone code that you would like date/time responses converted to. SO-AppToken: type: string description: >- The application token that identifies the partner app. Used when calling Online WebAPI from a server. required: - newEntity title: Parameters