Referencia de tabla o entidad CustomAPIRequestParameter

Nota

¿No está seguro de tabla frente a entidad? Vea Desarrolladores: comprender la terminología en Microsoft Dataverse.

Entity that defines a request parameter for a custom API

Añadido por: solución Custom API Framework

Mensajes

Mensaje Operación de API web Método o clase de SDK
Create POST [org URI]/api/data/v9.0/customapirequestparameters
Vea Crear
CreateRequest o
Create
Delete DELETE [org URI]/api/data/v9.0/customapirequestparameters(customapirequestparameterid)
Vea Eliminar
DeleteRequest o
Delete
Retrieve GET [org URI]/api/data/v9.0/customapirequestparameters(customapirequestparameterid)
Vea Recuperar
RetrieveRequest o
Retrieve
RetrieveMultiple GET [org URI]/api/data/v9.0/customapirequestparameters
Vea Consultar datos
RetrieveMultipleRequest o
RetrieveMultiple
Update PATCH [org URI]/api/data/v9.0/customapirequestparameters(customapirequestparameterid)
Vea Actualizar
UpdateRequest o
Update

Propiedades

Propiedad Valor
CollectionSchemaName CustomAPIRequestParameters
DisplayCollectionName Custom API Request Parameters
DisplayName Custom API Request Parameter
EntitySetName customapirequestparameters
IsBPFEntity False
LogicalCollectionName customapirequestparameters
LogicalName customapirequestparameter
OwnershipType None
PrimaryIdAttribute customapirequestparameterid
PrimaryNameAttribute name
SchemaName CustomAPIRequestParameter

Columnas/atributos que se pueden escribir

Estas columnas o atributos devuelven true para IsValidForCreate o IsValidForUpdate (generalmente ambos). Listado por SchemaName.

CustomAPIId

Propiedad Valor
Description Unique identifier for the custom API that owns this custom API request parameter
DisplayName Custom API
IsValidForForm True
IsValidForRead True
IsValidForUpdate False
LogicalName customapiid
RequiredLevel SystemRequired
Targets customapi
Type Lookup

CustomAPIRequestParameterId

Propiedad Valor
Description Unique identifier for custom API request parameter instances
DisplayName Custom API Request Parameter
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName customapirequestparameterid
RequiredLevel SystemRequired
Type Uniqueidentifier

Description

Propiedad Valor
Description Localized description for custom API request parameter instances
DisplayName Description
FormatName Text
IsLocalizable True
IsValidForForm True
IsValidForRead True
LogicalName description
MaxLength 300
RequiredLevel ApplicationRequired
Type String

DisplayName

Propiedad Valor
Description Localized display name for custom API request parameter instances
DisplayName Display Name
FormatName Text
IsLocalizable True
IsValidForForm True
IsValidForRead True
LogicalName displayname
MaxLength 100
RequiredLevel ApplicationRequired
Type String

ImportSequenceNumber

Añadido por: solución Basic Solution

Propiedad Valor
Description Sequence number of the import that created this record.
DisplayName Import Sequence Number
Format None
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName importsequencenumber
MaxValue 2147483647
MinValue -2147483648
RequiredLevel None
Type Integer

IsCustomizable

Añadido por: solución Basic Solution

Propiedad Valor
Description For internal use only.
DisplayName Is Customizable
IsValidForForm False
IsValidForRead True
LogicalName iscustomizable
RequiredLevel SystemRequired
Type ManagedProperty

IsOptional

Propiedad Valor
Description Indicates if the custom API request parameter is optional
DisplayName Is Optional
IsValidForForm True
IsValidForRead True
LogicalName isoptional
RequiredLevel SystemRequired
Type Boolean

Elecciones/opciones de IsOptional

Valor Etiqueta Descripción
1 Yes
0 No

Valor predeterminado: 0

LogicalEntityName

Propiedad Valor
Description The logical name of the entity bound to the custom API request parameter
DisplayName Bound Entity Logical Name
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName logicalentityname
MaxLength 100
RequiredLevel None
Type String

Name

Propiedad Valor
Description The primary name of the custom API request parameter
DisplayName Name
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName name
MaxLength 100
RequiredLevel ApplicationRequired
Type String

OverriddenCreatedOn

Propiedad Valor
DateTimeBehavior UserLocal
Description Date and time that the record was migrated.
DisplayName Record Created On
Format DateOnly
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName overriddencreatedon
RequiredLevel None
Type DateTime

statecode

Propiedad Valor
Description Status of the Custom API Request Parameter
DisplayName Status
IsValidForCreate False
IsValidForForm True
IsValidForRead True
LogicalName statecode
RequiredLevel SystemRequired
Type State

Elecciones/opciones de statecode

Valor Etiqueta Estado predeterminado Nombre invariable
0 Active 1 Active
1 Inactive 2 Inactive

statuscode

Propiedad Valor
Description Reason for the status of the Custom API Request Parameter
DisplayName Status Reason
IsValidForForm True
IsValidForRead True
LogicalName statuscode
RequiredLevel None
Type Status

Elecciones/opciones de statuscode

Valor Etiqueta Estado
1 Active 0
2 Inactive 1

TimeZoneRuleVersionNumber

Propiedad Valor
Description For internal use only.
DisplayName Time Zone Rule Version Number
Format None
IsValidForForm False
IsValidForRead True
LogicalName timezoneruleversionnumber
MaxValue 2147483647
MinValue -1
RequiredLevel None
Type Integer

Type

Propiedad Valor
Description The data type of the custom API request parameter
DisplayName Type
IsValidForForm True
IsValidForRead True
LogicalName type
RequiredLevel SystemRequired
Type Picklist

Elecciones/opciones de Type

Valor Etiqueta Descripción
0 Boolean
1 DateTime
2 Decimal
3 Entity
4 EntityCollection
5 EntityReference
6 Float
7 Integer
8 Money
9 Picklist
10 String
11 StringArray
12 Guid

UniqueName

Propiedad Valor
Description Unique name for the custom API request parameter
DisplayName Unique Name
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
IsValidForUpdate False
LogicalName uniquename
MaxLength 128
RequiredLevel SystemRequired
Type String

UTCConversionTimeZoneCode

Propiedad Valor
Description Time zone code that was in use when the record was created.
DisplayName UTC Conversion Time Zone Code
Format None
IsValidForForm False
IsValidForRead True
LogicalName utcconversiontimezonecode
MaxValue 2147483647
MinValue -1
RequiredLevel None
Type Integer

Columnas/atributos de sólo lectura

Estas columnas o atributos devuelven false tanto para IsValidForCreate como para IsValidForUpdate. Listado por SchemaName.

ComponentIdUnique

Añadido por: solución Basic Solution

Propiedad Valor
Description For internal use only.
DisplayName Row id unique
IsValidForForm False
IsValidForRead True
LogicalName componentidunique
RequiredLevel SystemRequired
Type Uniqueidentifier

ComponentState

Añadido por: solución Basic Solution

Propiedad Valor
Description For internal use only.
DisplayName Component State
IsValidForForm False
IsValidForRead True
LogicalName componentstate
RequiredLevel SystemRequired
Type Picklist

Elecciones/opciones de ComponentState

Valor Etiqueta Descripción
0 Published
1 Unpublished
2 Deleted
3 Deleted Unpublished

CreatedBy

Añadido por: solución Active Solution

Propiedad Valor
Description Unique identifier of the user who created the record.
DisplayName Created By
IsValidForForm True
IsValidForRead True
LogicalName createdby
RequiredLevel None
Targets systemuser
Type Lookup

CreatedByName

Añadido por: solución Active Solution

Propiedad Valor
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName createdbyname
MaxLength 100
RequiredLevel None
Type String

CreatedByYomiName

Añadido por: solución Active Solution

Propiedad Valor
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName createdbyyominame
MaxLength 100
RequiredLevel SystemRequired
Type String

CreatedOn

Propiedad Valor
DateTimeBehavior UserLocal
Description Date and time when the record was created.
DisplayName Created On
Format DateAndTime
IsValidForForm True
IsValidForRead True
LogicalName createdon
RequiredLevel None
Type DateTime

CreatedOnBehalfBy

Añadido por: solución Active Solution

Propiedad Valor
Description Unique identifier of the delegate user who created the record.
DisplayName Created By (Delegate)
IsValidForForm True
IsValidForRead True
LogicalName createdonbehalfby
RequiredLevel None
Targets systemuser
Type Lookup

CreatedOnBehalfByName

Añadido por: solución Active Solution

Propiedad Valor
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName createdonbehalfbyname
MaxLength 100
RequiredLevel None
Type String

CreatedOnBehalfByYomiName

Añadido por: solución Active Solution

Propiedad Valor
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName createdonbehalfbyyominame
MaxLength 100
RequiredLevel SystemRequired
Type String

CustomAPIIdName

Propiedad Valor
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName customapiidname
MaxLength 100
RequiredLevel None
Type String

IsManaged

Añadido por: solución Basic Solution

Propiedad Valor
Description Indicates whether the solution component is part of a managed solution.
DisplayName Is Managed
IsValidForForm False
IsValidForRead True
LogicalName ismanaged
RequiredLevel SystemRequired
Type Boolean

Elecciones/opciones de IsManaged

Valor Etiqueta Descripción
1 Managed
0 Unmanaged

Valor predeterminado: 0

ModifiedBy

Añadido por: solución Active Solution

Propiedad Valor
Description Unique identifier of the user who modified the record.
DisplayName Modified By
IsValidForForm True
IsValidForRead True
LogicalName modifiedby
RequiredLevel None
Targets systemuser
Type Lookup

ModifiedByName

Añadido por: solución Active Solution

Propiedad Valor
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName modifiedbyname
MaxLength 100
RequiredLevel None
Type String

ModifiedByYomiName

Añadido por: solución Active Solution

Propiedad Valor
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName modifiedbyyominame
MaxLength 100
RequiredLevel SystemRequired
Type String

ModifiedOn

Propiedad Valor
DateTimeBehavior UserLocal
Description Date and time when the record was modified.
DisplayName Modified On
Format DateAndTime
IsValidForForm True
IsValidForRead True
LogicalName modifiedon
RequiredLevel None
Type DateTime

ModifiedOnBehalfBy

Añadido por: solución Active Solution

Propiedad Valor
Description Unique identifier of the delegate user who modified the record.
DisplayName Modified By (Delegate)
IsValidForForm True
IsValidForRead True
LogicalName modifiedonbehalfby
RequiredLevel None
Targets systemuser
Type Lookup

ModifiedOnBehalfByName

Añadido por: solución Active Solution

Propiedad Valor
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName modifiedonbehalfbyname
MaxLength 100
RequiredLevel None
Type String

ModifiedOnBehalfByYomiName

Añadido por: solución Active Solution

Propiedad Valor
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName modifiedonbehalfbyyominame
MaxLength 100
RequiredLevel SystemRequired
Type String

OverwriteTime

Añadido por: solución Basic Solution

Propiedad Valor
DateTimeBehavior UserLocal
Description For internal use only.
DisplayName Record Overwrite Time
Format DateAndTime
IsValidForForm False
IsValidForRead True
LogicalName overwritetime
RequiredLevel SystemRequired
Type DateTime

OwnerId

Añadido por: solución Active Solution

Propiedad Valor
Description Owner Id
DisplayName Owner
IsValidForForm True
IsValidForRead True
LogicalName ownerid
RequiredLevel SystemRequired
Targets systemuser,team
Type Owner

OwnerIdType

Añadido por: solución Active Solution

Propiedad Valor
Description Owner Id Type
DisplayName Owner Id Type
IsValidForForm False
IsValidForRead True
LogicalName owneridtype
RequiredLevel SystemRequired
Type EntityName

OwningBusinessUnit

Añadido por: solución Active Solution

Propiedad Valor
Description Unique identifier for the business unit that owns the record
DisplayName Owning Business Unit
IsValidForForm False
IsValidForRead True
LogicalName owningbusinessunit
RequiredLevel None
Targets businessunit
Type Lookup

OwningTeam

Añadido por: solución Active Solution

Propiedad Valor
Description Unique identifier for the team that owns the record.
DisplayName Owning Team
IsValidForForm False
IsValidForRead True
LogicalName owningteam
RequiredLevel None
Targets team
Type Lookup

OwningUser

Añadido por: solución Active Solution

Propiedad Valor
Description Unique identifier for the user that owns the record.
DisplayName Owning User
IsValidForForm False
IsValidForRead True
LogicalName owninguser
RequiredLevel None
Targets systemuser
Type Lookup

SolutionId

Añadido por: solución Basic Solution

Propiedad Valor
Description Unique identifier of the associated solution.
DisplayName Solution
IsValidForForm False
IsValidForRead True
LogicalName solutionid
RequiredLevel SystemRequired
Type Uniqueidentifier

SupportingSolutionId

Añadido por: solución Basic Solution

Propiedad Valor
Description For internal use only.
DisplayName Solution
IsValidForForm False
IsValidForRead False
LogicalName supportingsolutionid
RequiredLevel None
Type Uniqueidentifier

VersionNumber

Añadido por: solución Active Solution

Propiedad Valor
Description Version Number
DisplayName Version Number
IsValidForForm False
IsValidForRead True
LogicalName versionnumber
MaxValue 9223372036854775807
MinValue -9223372036854775808
RequiredLevel None
Type BigInt

Relaciones de uno a varios

Listado por SchemaName.

customapirequestparameter_SyncErrors

Añadido por: solución System Solution

Igual que la relación de varios a uno customapirequestparameter_SyncErrors de la tabla syncerror.

Propiedad Valor
ReferencingEntity syncerror
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName customapirequestparameter_SyncErrors
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: Cascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

customapirequestparameter_AsyncOperations

Añadido por: solución System Solution

Igual que la relación de varios a uno customapirequestparameter_AsyncOperations de la tabla asyncoperation.

Propiedad Valor
ReferencingEntity asyncoperation
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName customapirequestparameter_AsyncOperations
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

customapirequestparameter_MailboxTrackingFolders

Añadido por: solución System Solution

Igual que la relación de varios a uno customapirequestparameter_MailboxTrackingFolders de la tabla mailboxtrackingfolder.

Propiedad Valor
ReferencingEntity mailboxtrackingfolder
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName customapirequestparameter_MailboxTrackingFolders
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: Cascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

customapirequestparameter_ProcessSession

Añadido por: solución System Solution

Igual que la relación de varios a uno customapirequestparameter_ProcessSession de la tabla processsession.

Propiedad Valor
ReferencingEntity processsession
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName customapirequestparameter_ProcessSession
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

customapirequestparameter_BulkDeleteFailures

Añadido por: solución System Solution

Igual que la relación de varios a uno customapirequestparameter_BulkDeleteFailures de la tabla bulkdeletefailure.

Propiedad Valor
ReferencingEntity bulkdeletefailure
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName customapirequestparameter_BulkDeleteFailures
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: Cascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

customapirequestparameter_PrincipalObjectAttributeAccesses

Añadido por: solución System Solution

Igual que la relación de varios a uno customapirequestparameter_PrincipalObjectAttributeAccesses de la tabla principalobjectattributeaccess.

Propiedad Valor
ReferencingEntity principalobjectattributeaccess
ReferencingAttribute objectid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName customapirequestparameter_PrincipalObjectAttributeAccesses
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: Cascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

Relaciones de varios a uno

Cada relación de varios a uno se define mediante una relación de uno a varios correspondiente con la tabla relacionada. Listado por SchemaName.

lk_customapirequestparameter_createdby

Añadido por: solución System Solution

Consulte la relación de uno a varios lk_customapirequestparameter_createdby de la tabla systemuser.

lk_customapirequestparameter_createdonbehalfby

Añadido por: solución System Solution

Consulte la relación de uno a varios lk_customapirequestparameter_createdonbehalfby de la tabla systemuser.

lk_customapirequestparameter_modifiedby

Añadido por: solución System Solution

Consulte la relación de uno a varios lk_customapirequestparameter_modifiedby de la tabla systemuser.

lk_customapirequestparameter_modifiedonbehalfby

Añadido por: solución System Solution

Consulte la relación de uno a varios lk_customapirequestparameter_modifiedonbehalfby de la tabla systemuser.

customapi_customapirequestparameter

Consulte la relación de uno a varios customapi_customapirequestparameter de la tabla customapi.

Consultar también

Referencia de tabla o entidad de Dataverse Referencia de la API web customapirequestparameter EntityType