SuperOffice API
Getting access, Developing, Testing
Back to SuperOfficeSave a ListEntity resolved by the provided name.
Input
type: object
properties:
parameters:
type: object
properties:
name:
type: string
description: The name of the list to save.
listEntity:
description: "The list entity contains information about a specific list\r\n<para />\r\nCarrier object for ListEntity.\r\nServices for the ListEntity Carrier is available from the <see cref=\"T:SuperOffice.CRM.Services.IListAgent\">List Agent</see>."
type: object
properties:
Id:
format: int32
description: The identity of the list
type: integer
Name:
description: The name of the list
type: string
Tooltip:
description: The tooltip of the list
type: string
Deleted:
description: True if the list item is marked as deleted
type: boolean
Rank:
format: int32
description: The rank of the list
type: integer
IsCustomList:
description: Indicates if this is a custom list or a standard list
type: boolean
IsMDOList:
description: Indicates if this is a MDO list
type: boolean
UseGroupsAndHeadings:
description: Indicates if this list should use groups and headings
type: boolean
ListType:
description: >-
The type of this list, often indicated by the database name, but
not necessarily
type: string
InUseByUserDefinedFields:
description: True if this in use by one or more udfields
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
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:
- name
- listEntity
title: Parameters