Поделиться через


Параметр пользовательского запроса API (CustomAPIRequestParameter) table/entity reference (Microsoft Dataverse)

Сущность, определяющая параметр запроса для пользовательского API

Messages

В следующей таблице перечислены сообщения для таблицы Custom API Request Parameter (CustomAPIRequestParameter). Сообщения представляют собой операции, которые могут быть выполнены с таблицей. Они также могут быть событиями.

Имя
Является ли событие?
Операция веб-API SDK для .NET
Associate
Событие: Правда
Ассоциированные записи Ассоциированные записи
Create
Событие: Правда
POST /customapirequestparameters
Смотреть Создание
Создание записей
Delete
Событие: Правда
DELETE /customapirequestparameters(customapirerequestparameterid)
См. Удалить
Удаление записей
Disassociate
Событие: Правда
Отмена связи записей Отмена связи записей
Retrieve
Событие: Правда
GET /customapirequestparameters(customapirerequestparameterid)
Смотреть Извлечение
Извлечение записей
RetrieveMultiple
Событие: Правда
GET /customapirequestparameters
Смотрите раздел Запрос данных
Запрос данных
Update
Событие: Правда
PATCH /customapirequestparameters(customapirerequestparameterid)
Смотреть обновление
Обновление записей
Upsert
Событие: Ложь
PATCH /customapirequestparameters(customapirerequestparameterid)
Просмотр Upsert a table row
UpsertRequest

Свойства

В следующей таблице перечислены выбранные свойства для таблицы Custom API Request Parameter (CustomAPIRequestParameter).

Недвижимость Ценность
DisplayName Параметр пользовательского запроса API
DisplayCollectionName (ИмяDisplayCollectionName) Параметры пользовательского запроса API
SchemaName (Имя схемы) CustomAPIRequestParameter
ИмяСхемы коллекции CustomAPIRequestParameters
EntitySetName (ИмяНабора сущностей) customapirequestparameters
Логическое имя customapirequestparameter
ЛогическоеИмяКоллекции customapirequestparameters
ПервичныйIdAttribute customapirequestparameterid
PrimaryNameAttribute (ПервичныйNameAttribute) name
Тип стола Standard
Тип владения None

Записываемые столбцы/атрибуты

Эти столбцы и атрибуты возвращают true для IsValidForCreate или IsValidForUpdate (обычно для обоих). Перечислен по SchemaName.

CustomAPIId

Недвижимость Ценность
Description Уникальный идентификатор пользовательского API, которому принадлежит этот параметр запроса пользовательского API
Отображаемое имя Пользовательский API
IsValidForForm (ИсВалидДляФормы) True
IsValidForRead True
LogicalName customapiid
RequiredLevel ТребуетсяSystemRequired
Тип Lookup
Targets Пользовательский API

CustomAPIRequestParameterId

Недвижимость Ценность
Description Уникальный идентификатор для экземпляров параметров запроса пользовательского API
Отображаемое имя Параметр пользовательского запроса API
IsValidForForm (ИсВалидДляФормы) Неправда
IsValidForRead True
LogicalName customapirequestparameterid
RequiredLevel ТребуетсяSystemRequired
Тип Uniqueidentifier

Description

Недвижимость Ценность
Description Локализованное описание для экземпляров пользовательских экземпляров параметров запроса API
Отображаемое имя Описание
IsValidForForm (ИсВалидДляФормы) True
IsValidForRead True
LogicalName description
RequiredLevel ПрименениеОбязательно
Тип String
Формат Текст
ИмяФормата Текст
ImeMode Auto
IsLocalizable True
МаксДлина 300

Отображаемое имя

Недвижимость Ценность
Description Локализованное отображаемое имя для экземпляров настраиваемых экземпляров параметров запроса API
Отображаемое имя Отображаемое имя
IsValidForForm (ИсВалидДляФормы) True
IsValidForRead True
LogicalName displayname
RequiredLevel ПрименениеОбязательно
Тип String
Формат Текст
ИмяФормата Текст
ImeMode Auto
IsLocalizable True
МаксДлина 100

Порядковый номер импорта

Недвижимость Ценность
Description Порядковый номер импорта, создавшего эту запись.
Отображаемое имя Импорт порядкового номера
IsValidForForm (ИсВалидДляФормы) Неправда
IsValidForRead True
LogicalName importsequencenumber
RequiredLevel None
Тип Целое число
Максимальное значение 2147483647
Минимальное значение -2147483648

IsCustomizable

Недвижимость Ценность
Description Только для внутреннего использования.
Отображаемое имя Настраивается
IsValidForForm (ИсВалидДляФормы) Неправда
IsValidForRead True
LogicalName iscustomizable
RequiredLevel ТребуетсяSystemRequired
Тип ManagedProperty

IsOptional

Недвижимость Ценность
Description Указывает, является ли настраиваемый параметр запроса API необязательным.
Отображаемое имя Необязательный
IsValidForForm (ИсВалидДляФормы) True
IsValidForRead True
LogicalName isoptional
RequiredLevel ТребуетсяSystemRequired
Тип Boolean
ГлобальноеChoiceName (ГлобальноеChoiceName) customapirequestparameter_isoptional
Значение по умолчанию Неправда
Истинная этикетка Да
Фальшивая метка нет

LogicalEntityName

Недвижимость Ценность
Description Логическое имя сущности, привязанной к параметру пользовательского запроса API
Отображаемое имя Логическое имя привязанной сущности
IsValidForForm (ИсВалидДляФормы) True
IsValidForRead True
LogicalName logicalentityname
RequiredLevel None
Тип String
Формат Текст
ИмяФормата Текст
ImeMode Auto
IsLocalizable Неправда
МаксДлина 100

Имя

Недвижимость Ценность
Description Основное имя настраиваемого параметра запроса API
Отображаемое имя Имя
IsValidForForm (ИсВалидДляФормы) True
IsValidForRead True
LogicalName name
RequiredLevel ПрименениеОбязательно
Тип String
Формат Текст
ИмяФормата Текст
ImeMode Auto
IsLocalizable Неправда
МаксДлина 100

OverriddenCreatedOn

Недвижимость Ценность
Description Дата и время переноса записи.
Отображаемое имя Запись создана
IsValidForForm (ИсВалидДляФормы) Неправда
IsValidForRead True
LogicalName overriddencreatedon
RequiredLevel None
Тип DateTime
CanChangeDateTimeBehavior Неправда
DateTimeBehavior (Поведение даты и времени) ПользовательскийЛокальный
Формат DateOnly
ImeMode Неактивное
SourceTypeMask (Маска источника) 0

Код штата

Недвижимость Ценность
Description Состояние параметра пользовательского запроса API
Отображаемое имя Статус
IsValidForForm (ИсВалидДляФормы) True
IsValidForRead True
LogicalName statecode
RequiredLevel ТребуетсяSystemRequired
Тип Государство
ЗначениеDefaultFormValue
ГлобальноеChoiceName (ГлобальноеChoiceName) customapirequestparameter_statecode

Варианты и параметры statecode

Ценность Сведения
0 Метка: Активный
DefaultStatus: 1
InvariantName: Active
1 Метка: Неактивно
DefaultStatus: 2
InvariantName: Inactive

Код состояния

Недвижимость Ценность
Description Причина состояния параметра пользовательского запроса API
Отображаемое имя Причина статуса
IsValidForForm (ИсВалидДляФормы) True
IsValidForRead True
LogicalName statuscode
RequiredLevel None
Тип Состояние
ЗначениеDefaultFormValue
ГлобальноеChoiceName (ГлобальноеChoiceName) customapirequestparameter_statuscode

statuscode Варианты/Параметры

Ценность Сведения
1 Метка: Активный
Штат:0
TransitionData: нет
2 Метка: Неактивно
Штат:1
TransitionData: нет

TimeZoneRuleVersionNumber

Недвижимость Ценность
Description Только для внутреннего использования.
Отображаемое имя Номер версии правила часового пояса
IsValidForForm (ИсВалидДляФормы) Неправда
IsValidForRead True
LogicalName timezoneruleversionnumber
RequiredLevel None
Тип Целое число
Максимальное значение 2147483647
Минимальное значение -1

Тип

Недвижимость Ценность
Description Тип данных настраиваемого параметра запроса API
Отображаемое имя Тип
IsValidForForm (ИсВалидДляФормы) True
IsValidForRead True
LogicalName type
RequiredLevel ТребуетсяSystemRequired
Тип Список выбора
ЗначениеDefaultFormValue 0
ГлобальноеChoiceName (ГлобальноеChoiceName) customapifieldtype

Варианты типов/опции

Ценность Этикетка
0 Boolean
1 DateTime
2 Decimal
3 Сущность
4 EntityCollection (EntityCollection)
5 EntityReference
6 Акции в свободном обращении
7 Целое число
8 Деньги
9 Раскрывающийся список
10 строка
11 StringArray
12 Guid

УникальноеИмя

Недвижимость Ценность
Description Уникальное имя для параметра пользовательского запроса API
Отображаемое имя Уникальное имя
IsValidForForm (ИсВалидДляФормы) True
IsValidForRead True
LogicalName uniquename
RequiredLevel ТребуетсяSystemRequired
Тип String
Формат Текст
ИмяФормата Текст
ImeMode Auto
IsLocalizable Неправда
МаксДлина 128

UTCConversionTimeZoneCode

Недвижимость Ценность
Description Код часового пояса, который использовался при создании записи.
Отображаемое имя Код часового пояса преобразования UTC
IsValidForForm (ИсВалидДляФормы) Неправда
IsValidForRead True
LogicalName utcconversiontimezonecode
RequiredLevel None
Тип Целое число
Максимальное значение 2147483647
Минимальное значение -1

Столбцы/атрибуты только для чтения

Эти столбцы и атрибуты возвращают false как для IsValidForCreate, так и для IsValidForUpdate. Перечислен по SchemaName.

ComponentIdUnique (Уникальный идентификатор компонента)

Недвижимость Ценность
Description Только для внутреннего использования.
Отображаемое имя Уникальный идентификатор строки
IsValidForForm (ИсВалидДляФормы) Неправда
IsValidForRead True
LogicalName componentidunique
RequiredLevel ТребуетсяSystemRequired
Тип Uniqueidentifier

ComponentState (Состояние компонента)

Недвижимость Ценность
Description Только для внутреннего использования.
Отображаемое имя Состояние компонента
IsValidForForm (ИсВалидДляФормы) Неправда
IsValidForRead True
LogicalName componentstate
RequiredLevel ТребуетсяSystemRequired
Тип Список выбора
ЗначениеDefaultFormValue
ГлобальноеChoiceName (ГлобальноеChoiceName) componentstate

Варианты/параметры ComponentState

Ценность Этикетка
0 Опубликованные
1 Неопубликованные
2 Удалено
3 Удалено Неопубликовано

Создано пользователем

Недвижимость Ценность
Description Уникальный идентификатор пользователя, создавшего запись.
Отображаемое имя Создано
IsValidForForm (ИсВалидДляФормы) True
IsValidForRead True
LogicalName createdby
RequiredLevel None
Тип Lookup
Targets systemuser

CreatedOn

Недвижимость Ценность
Description Дата и время создания записи.
Отображаемое имя Создано в
IsValidForForm (ИсВалидДляФормы) True
IsValidForRead True
LogicalName createdon
RequiredLevel None
Тип DateTime
CanChangeDateTimeBehavior Неправда
DateTimeBehavior (Поведение даты и времени) ПользовательскийЛокальный
Формат ДатаИВремя
ImeMode Неактивное
SourceTypeMask (Маска источника) 0

CreatedOnBehalfBy

Недвижимость Ценность
Description Уникальный идентификатор пользователя-делегата, создавшего запись.
Отображаемое имя Создано (Делегат)
IsValidForForm (ИсВалидДляФормы) True
IsValidForRead True
LogicalName createdonbehalfby
RequiredLevel None
Тип Lookup
Targets systemuser

IsManaged

Недвижимость Ценность
Description Указывает, является ли компонент решения частью управляемого решения.
Отображаемое имя Управляется
IsValidForForm (ИсВалидДляФормы) Неправда
IsValidForRead True
LogicalName ismanaged
RequiredLevel ТребуетсяSystemRequired
Тип Boolean
ГлобальноеChoiceName (ГлобальноеChoiceName) ismanaged
Значение по умолчанию Неправда
Истинная этикетка Управляется
Фальшивая метка Неуправляемые

ModifiedBy

Недвижимость Ценность
Description Уникальный идентификатор пользователя, изменившего запись.
Отображаемое имя Изменено
IsValidForForm (ИсВалидДляФормы) True
IsValidForRead True
LogicalName modifiedby
RequiredLevel None
Тип Lookup
Targets systemuser

ModifiedOn

Недвижимость Ценность
Description Дата и время изменения записи.
Отображаемое имя Модифицировано
IsValidForForm (ИсВалидДляФормы) True
IsValidForRead True
LogicalName modifiedon
RequiredLevel None
Тип DateTime
CanChangeDateTimeBehavior Неправда
DateTimeBehavior (Поведение даты и времени) ПользовательскийЛокальный
Формат ДатаИВремя
ImeMode Неактивное
SourceTypeMask (Маска источника) 0

ModifiedOnBehalfBy

Недвижимость Ценность
Description Уникальный идентификатор пользователя-делегата, изменившего запись.
Отображаемое имя Изменено (делегатом)
IsValidForForm (ИсВалидДляФормы) True
IsValidForRead True
LogicalName modifiedonbehalfby
RequiredLevel None
Тип Lookup
Targets systemuser

Время перезаписи

Недвижимость Ценность
Description Только для внутреннего использования.
Отображаемое имя Время перезаписи записи
IsValidForForm (ИсВалидДляФормы) Неправда
IsValidForRead True
LogicalName overwritetime
RequiredLevel ТребуетсяSystemRequired
Тип DateTime
CanChangeDateTimeBehavior Неправда
DateTimeBehavior (Поведение даты и времени) ПользовательскийЛокальный
Формат ДатаИВремя
ImeMode Неактивное
SourceTypeMask (Маска источника) 0

Идентификатор владельца

Недвижимость Ценность
Description Идентификатор владельца
Отображаемое имя Owner
IsValidForForm (ИсВалидДляФормы) True
IsValidForRead True
LogicalName ownerid
RequiredLevel ТребуетсяSystemRequired
Тип Владелец
Targets Системный пользователь, команда

OwnerIdType (Тип OwnerId)

Недвижимость Ценность
Description Тип идентификатора владельца
Отображаемое имя Тип идентификатора владельца
IsValidForForm (ИсВалидДляФормы) Неправда
IsValidForRead True
LogicalName owneridtype
RequiredLevel ТребуетсяSystemRequired
Тип EntityName (ИмяСущности)

ВладеющаяБизнес-единица

Недвижимость Ценность
Description Уникальный идентификатор бизнес-единицы, которой принадлежит запись
Отображаемое имя Бизнес-единица «Владелец»
IsValidForForm (ИсВалидДляФормы) Неправда
IsValidForRead True
LogicalName owningbusinessunit
RequiredLevel None
Тип Lookup
Targets бизнес-единица

Владеющая команда

Недвижимость Ценность
Description Уникальный идентификатор команды, которой принадлежит запись.
Отображаемое имя Владеющая команда
IsValidForForm (ИсВалидДляФормы) Неправда
IsValidForRead True
LogicalName owningteam
RequiredLevel None
Тип Lookup
Targets team

ВладелецПользователь

Недвижимость Ценность
Description Уникальный идентификатор пользователя, которому принадлежит запись.
Отображаемое имя Владеющий пользователь
IsValidForForm (ИсВалидДляФормы) Неправда
IsValidForRead True
LogicalName owninguser
RequiredLevel None
Тип Lookup
Targets systemuser

Идентификатор решения

Недвижимость Ценность
Description Уникальный идентификатор связанного решения.
Отображаемое имя Solution
IsValidForForm (ИсВалидДляФормы) Неправда
IsValidForRead True
LogicalName solutionid
RequiredLevel ТребуетсяSystemRequired
Тип Uniqueidentifier

SupportingSolutionId (Идентификатор SupportingSolutionId)

Недвижимость Ценность
Description Только для внутреннего использования.
Отображаемое имя Solution
IsValidForForm (ИсВалидДляФормы) Неправда
IsValidForRead Неправда
LogicalName supportingsolutionid
RequiredLevel None
Тип Uniqueidentifier

VersionNumber

Недвижимость Ценность
Description Номер версии
Отображаемое имя Номер версии
IsValidForForm (ИсВалидДляФормы) Неправда
IsValidForRead True
LogicalName versionnumber
RequiredLevel None
Тип БигИнт
Максимальное значение 9223372036854775807
Минимальное значение -9223372036854775808

Отношения "многие-к-одному"

Эти отношения являются отношениями «многие к одному». Перечислен по SchemaName.

customapi_customapirequestparameter

Связь с однимTo-Many: customapi customapi_customapirequestparameter

Недвижимость Ценность
ReferencedEntity (ReferencedEntity) customapi
Атрибут referencedAttribute customapiid
ReferencingAttribute customapiid
Имя_свойства ReferencingEntityNavigationNavigation CustomAPIId
IsHierarchical
CascadeConfiguration Архив: NoCascade
Назначать: NoCascade
Удалить: Cascade
Сливать: NoCascade
Переродитель: Cascade
Просмотр роллапВ: NoCascade
Предоставить общий доступ: NoCascade
Отменить общий доступ: NoCascade

lk_customapirequestparameter_createdby

СвязьTo-Many: системный lk_customapirequestparameter_createdby

Недвижимость Ценность
ReferencedEntity (ReferencedEntity) systemuser
Атрибут referencedAttribute systemuserid
ReferencingAttribute createdby
Имя_свойства ReferencingEntityNavigationNavigation createdby
IsHierarchical
CascadeConfiguration Архив: NoCascade
Назначать: NoCascade
Удалить: NoCascade
Сливать: NoCascade
Переродитель: NoCascade
Просмотр роллапВ: NoCascade
Предоставить общий доступ: NoCascade
Отменить общий доступ: NoCascade

lk_customapirequestparameter_createdonbehalfby

СвязьTo-Many: systemuser lk_customapirequestparameter_createdonbehalfby

Недвижимость Ценность
ReferencedEntity (ReferencedEntity) systemuser
Атрибут referencedAttribute systemuserid
ReferencingAttribute createdonbehalfby
Имя_свойства ReferencingEntityNavigationNavigation createdonbehalfby
IsHierarchical
CascadeConfiguration Архив: NoCascade
Назначать: NoCascade
Удалить: NoCascade
Сливать: NoCascade
Переродитель: NoCascade
Просмотр роллапВ: NoCascade
Предоставить общий доступ: NoCascade
Отменить общий доступ: NoCascade

lk_customapirequestparameter_modifiedby

СвязьTo-Many: systemuser lk_customapirequestparameter_modifiedby

Недвижимость Ценность
ReferencedEntity (ReferencedEntity) systemuser
Атрибут referencedAttribute systemuserid
ReferencingAttribute modifiedby
Имя_свойства ReferencingEntityNavigationNavigation modifiedby
IsHierarchical
CascadeConfiguration Архив: NoCascade
Назначать: NoCascade
Удалить: NoCascade
Сливать: NoCascade
Переродитель: NoCascade
Просмотр роллапВ: NoCascade
Предоставить общий доступ: NoCascade
Отменить общий доступ: NoCascade

lk_customapirequestparameter_modifiedonbehalfby

СвязьTo-Many: systemuser lk_customapirequestparameter_modifiedonbehalfby

Недвижимость Ценность
ReferencedEntity (ReferencedEntity) systemuser
Атрибут referencedAttribute systemuserid
ReferencingAttribute modifiedonbehalfby
Имя_свойства ReferencingEntityNavigationNavigation modifiedonbehalfby
IsHierarchical
CascadeConfiguration Архив: NoCascade
Назначать: NoCascade
Удалить: NoCascade
Сливать: NoCascade
Переродитель: NoCascade
Просмотр роллапВ: NoCascade
Предоставить общий доступ: NoCascade
Отменить общий доступ: NoCascade

Отношения «один ко многим»

Эти отношения являются отношениями «один ко многим». Перечислен по SchemaName.

customapirequestparameter_AsyncOperations

Связь "Многие"To-One: асинхронная customapirequestparameter_AsyncOperations

Недвижимость Ценность
Ссылающаяся сущность asyncoperation
ReferencingAttribute regardingobjectid
ReferencedEntityNavigationPropertyName customapirequestparameter_AsyncOperations
IsCustomizable True
АссоциированноеМенюКонфигурация ДоступноВ автономном режиме: Правда
Поведение: DoNotDisplay
Группа: Details
Ярлык:
MenuId: null
Порядок:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

customapirequestparameter_BulkDeleteFailures

Связь "МногиеTo-One": bulkdeletefailure customapirequestparameter_BulkDeleteFailures

Недвижимость Ценность
Ссылающаяся сущность bulkdeletefailure
ReferencingAttribute regardingobjectid
ReferencedEntityNavigationPropertyName customapirequestparameter_BulkDeleteFailures
IsCustomizable True
АссоциированноеМенюКонфигурация ДоступноВ автономном режиме: Правда
Поведение: DoNotDisplay
Группа: Details
Ярлык:
MenuId: null
Порядок:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

customapirequestparameter_MailboxTrackingFolders

Связь со многимиTo-One: почтовые ящики с customapirequestparameter_MailboxTrackingFolders

Недвижимость Ценность
Ссылающаяся сущность mailboxtrackingfolder
ReferencingAttribute regardingobjectid
ReferencedEntityNavigationPropertyName customapirequestparameter_MailboxTrackingFolders
IsCustomizable True
АссоциированноеМенюКонфигурация ДоступноВ автономном режиме: Правда
Поведение: DoNotDisplay
Группа: Details
Ярлык:
MenuId: null
Порядок:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

customapirequestparameter_PrincipalObjectAttributeAccesses

Связь "Многие"To-One: principalobjectattributeaccess customapirequestparameter_PrincipalObjectAttributeAccesses

Недвижимость Ценность
Ссылающаяся сущность principalobjectattributeaccess
ReferencingAttribute objectid
ReferencedEntityNavigationPropertyName customapirequestparameter_PrincipalObjectAttributeAccesses
IsCustomizable True
АссоциированноеМенюКонфигурация ДоступноВ автономном режиме: Правда
Поведение: DoNotDisplay
Группа: Details
Ярлык:
MenuId: null
Порядок:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

customapirequestparameter_ProcessSession

Связь "МногиеTo-One": customapirequestparameter_ProcessSession обработки

Недвижимость Ценность
Ссылающаяся сущность processsession
ReferencingAttribute regardingobjectid
ReferencedEntityNavigationPropertyName customapirequestparameter_ProcessSession
IsCustomizable True
АссоциированноеМенюКонфигурация ДоступноВ автономном режиме: Правда
Поведение: DoNotDisplay
Группа: Details
Ярлык:
MenuId: null
Порядок:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

customapirequestparameter_SyncErrors

Связь со многимиTo-One: синхронизатор customapirequestparameter_SyncErrors

Недвижимость Ценность
Ссылающаяся сущность syncerror
ReferencingAttribute regardingobjectid
ReferencedEntityNavigationPropertyName customapirequestparameter_SyncErrors
IsCustomizable True
АссоциированноеМенюКонфигурация ДоступноВ автономном режиме: Правда
Поведение: DoNotDisplay
Группа: Details
Ярлык:
MenuId: null
Порядок:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

См. также

Справочник по таблицам/сущностям Dataverse
Справочник по веб-API Dataverse
customapirequestparameter