SuperOffice API
Getting access, Developing, Testing
Back to SuperOfficeSaves a key belonging to the ForeignApp and ForeignDevice specified.
Input
type: object
properties:
parameters:
type: object
properties:
foreignKey:
description: "Carrier object for ForeignKey.\r\nServices for the ForeignKey Carrier is available from the <see cref=\"T:SuperOffice.CRM.Services.IForeignSystemAgent\">ForeignSystem Agent</see>."
type: object
properties:
Key:
description: Subkey (optional)
type: string
Value:
description: Key value
type: string
RecordId:
format: int32
description: Record in the referenced table
type: integer
CreatedDate:
format: date-time
description: Registered when in UTC.
type: string
UpdatedDate:
format: date-time
description: Last updated when in UTC.
type: string
UpdatedBy:
description: Name of the person that last updated the foreign key
type: string
CreatedBy:
description: Name of the person that created the foreign key
type: string
TableName:
description: >-
Table name, transformed to and from numeric table id by the
service layer
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
applicationName:
type: string
description: The name of the foreign application.
deviceName:
type: string
description: The name of the foreign device.
deviceIdentifier:
type: string
description: The device identifier. Optional if device identifier is not used.
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:
- foreignKey
- applicationName
- deviceName
- deviceIdentifier
title: Parameters