Referencia de campos de las API de REST

Aprenda sobre los recursos y extremos relacionados con el campo en las API de REST de SharePoint.

Última modificación: lunes, 9 de marzo de 2015

Hace referencia a: apps for SharePoint | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013

Acerca de los ejemplos de solicitudes en este artículo

En los ejemplos de este artículo se utilizan solicitudes AJAX de jQuery. Antes de intentar utilizar los ejemplos, haga lo siguiente:

  • Cambie los datos de <url de sitio> y otros marcadores de posición, como cualquier identificador, nombre o ruta de acceso de entidades de SharePoint.

  • Si utiliza la biblioteca entre dominios, necesitará cambiar el formato de la solicitud. Por ejemplo, podría ser similar al siguiente.

    executor.executeAsync({
      url: "<app web url>/_api/SP.AppContextSite(@target)/web/fields?@target='<host web url>'",
      method: "POST",
      body: "{ '__metadata': { 'type': 'SP.Field' }, 'Title': 'Comments', 'FieldTypeKind': 3 }",
      headers: {
        "accept": "application/json;odata=verbose",
        "content-type": "application/json;odata=verbose"
      },
      success: successHandler,
      error: errorHandler
    });
    
  • Si está utilizando OAuth, agregue un encabezado Authorization ("Authorization": "Bearer " + <access token>) para enviar el token de acceso OAuth.

  • Quite los saltos de línea de los valores de propiedad url y data en los ejemplos de solicitud. Se agregan saltos de línea a los ejemplos para facilitar la lectura.

  • Si quiere que el servidor devuelva respuestas en formato Atom, quite el encabezado "accept": "application/json; odata=verbose".

Consulte Cómo difieren las solicitudes REST por entorno. para obtener más información acerca del cambio de solicitudes. Consulte Recursos adicionales para obtener más información acerca del uso de la biblioteca entre dominios, OAuth y el servicio REST de SharePoint.

Sugerencia

El servicio REST de SharePoint Online admite la combinación de varias solicitudes en una sola llamada al servicio mediante el uso de la opción de consulta $batch de OData. Para obtener información detallada y vínculos a los ejemplos de código, vea Realizar solicitudes de lote con las API de REST. Esta opción aún no está disponible para la implementación de SharePoint local.

Recurso campo

URI del extremo  |  Propiedades  |  Métodos  |  Representación OData

Representa un campo de una lista SharePoint.

URI del extremo

http://<url de sitio>/_api/web/fields('<id. de campo>')
http://<url de sitio>/_api/web/lists(guid'<id. de lista>')/fields('<id. de campo>')

Métodos HTTP compatibles

GET  |  POST  |  DELETE  |  MERGE  |  PUT

Ejemplos de solicitudes

Ejemplo de solicitud GET: obtener un campo

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')",
  type: "GET",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

También puede usar el método GetByTitle del recurso FieldCollection para obtener una vista por su título (con distinción de mayúsculas y minúsculas). Ejemplo: …/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')/fields/getbytitle('Start Date').

Ejemplo de solicitud POST: crear un campo

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields",
  type: "POST",
  data: "{ '__metadata': { 'type': 'SP.Field' }, 'Title': 'Comments', 'FieldTypeKind': 3 }",
  headers: { 
    "X-RequestDigest": <form digest value>,
    "accept": "application/json; odata=verbose",
    "content-type": "application/json;odata=verbose",
    "content-length": <length of body data>
  },
  success: successHandler,
  error: errorHandler
});

Ejemplo de solicitud POST: crear un campo incluido el esquema del campo. Para enviar un esquema complejo, puede usar el método CreateFieldAsXml.

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields",
  type: "POST",
  data: { '__metadata': { 'type': 'SP.Field' }, 'FieldTypeKind': 20, 'Title':
    'Stakeholders', 'SchemaXml': '<Field Type=\"UserMulti\" Required=\"TRUE\"
    UserSelectionMode=\"PeopleAndGroups\" UserSelectionScope=\"0\" Mult=\"TRUE\" />' },
  headers: { 
    "X-RequestDigest": <form digest value>,
    "accept": "application/json; odata=verbose",
    "content-type": "application/json;odata=verbose",
    "content-length": <length of body data>
  },
  success: successHandler,
  error: errorHandler
});

Consulte Métodos de FieldCollection para conocer otras maneras de crear un campo.

Ejemplo de solicitud MERGE: cambiar un campo

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')",
  type: "POST",
  data: "{ '__metadata': { 'type': 'SP.Field' }, 'Title': 'Internal stakeholders' }",
  headers: { 
    "X-RequestDigest": <form digest value>,
    "content-type": "application/json;odata=verbose",
    "content-length": <length of body data>,
    "X-HTTP-Method": "MERGE"
  },
  success: successHandler,
  error: errorHandler
});

Consulte Notas de implementación para obtener información acerca de cómo especificar el tipo de campo en una solicitud MERGE o PUT.

Ejemplo de solicitud DELETE: eliminar un campo

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')",
  type: "POST",
  headers: { 
    "X-RequestDigest": <form digest value>,
    "X-HTTP-Method": "DELETE"
  },
  success: successHandler,
  error: errorHandler
});

Propiedades de campo

Para obtener una propiedad, envíe una solicitud GET al extremo de la propiedad, tal como se muestra en el siguiente ejemplo.

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')/<property name>",
  type: "GET",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Propiedad

Tipo

L/E

Devuelta con recurso

Descripción

CanBeDeleted

Boolean

L

Obtiene un valor que especifica si se puede eliminar el campo.

DefaultValue

String

LE

Obtiene o establece un valor que especifica el valor predeterminado del campo.

Description

String

LE

Obtiene o establece un valor que especifica la descripción del campo.

Direction

String

LE

Obtiene o establece un valor que especifica el orden de lectura del campo.

EnforceUniqueValues

Boolean

LE

Obtiene o establece un valor que especifica si se requieren valores de campo únicos en una columna de lista o biblioteca.

EntityPropertyName

String

L

Obtiene el nombre de la propiedad de entidad para la entidad de elemento de lista que usa este campo.

FieldTypeKind

Int32

LE

Obtiene o establece un valor que especifica el tipo del campo. Representa un valor FieldType. Consulte FieldType en la referencia de modelo de objetos de cliente .NET para ver una lista de valores de tipos de campo.

Filterable

Boolean

L

Obtiene un valor que especifica si los elementos de lista de la lista se pueden filtrar por valor de campo.

FromBaseType

Boolean

L

Obtiene un valor Boolean que indica si el campo deriva de un tipo de campo básico.

Group

String

LE

Obtiene o establece un valor que especifica el grupo de campos.

Hidden

Boolean

LE

Obtiene o establece un valor que especifica si el campo se oculta en formularios de lista y vistas de lista.

Id

GUID

L

Obtiene un valor que especifica el identificador de campo.

Indexed

Boolean

LE

Obtiene o establece un valor booleano que especifica si el campo está indexado.

InternalName

String

L

Obtiene un valor que especifica el nombre interno de campo.

JSLink

String

LE

Obtiene o establece el nombre de un archivo JS externo que contiene lógica de representación de clientes para campos de este tipo.

ReadOnlyField

Boolean

LE

Obtiene o establece un valor que especifica si el valor del campo es de solo lectura.

Required

Boolean

LE

Obtiene o establece un valor que especifica si el campo requiere un valor.

SchemaXml

String

LE

Obtiene o establece un valor que especifica el esquema XML que define el campo.

SchemaXmlWithResourceTokens

String

L

No

Obtiene el esquema que define el campo e incluye tokens de recursos.

Scope

String

LE

Obtiene un valor que especifica la dirección URL relativa al servidor de la lista o el sitio donde reside el campo.

Sealed

Boolean

LE

Obtiene un valor que especifica si las propiedades del campo no se pueden cambiar y si el campo no se puede eliminar.

Sortable

Boolean

LE

Obtiene un valor que especifica si los elementos de lista de la lista se pueden ordenar por valor de campo.

StaticName

String

LE

Obtiene o establece un valor que especifica un identificador personalizable del campo.

Title

String

LE

Obtiene o establece un valor que especifica el nombre para mostrar del campo.

TypeAsString

String

LE

Obtiene o establece un valor que especifica el tipo del campo.

TypeDisplayName

String

L

Obtiene un valor que especifica el nombre para mostrar del tipo del campo.

TypeShortDescription

String

L

Obtiene un valor que especifica la descripción del tipo del campo.

ValidationFormula

String

LE

Obtiene o establece un valor que especifica los criterios de validación de datos del valor del campo.

ValidationMessage

String

LE

Obtiene o establece un valor que especifica el mensaje de error que se devuelve cuando se produce un error en la validación de datos del campo.

Métodos de campo

DeleteObject
SetShowInDisplayForm
SetShowInEditForm
SetShowInNewForm

Método DeleteObject

El método recomendado para eliminar un campo es enviar una solicitud DELETE al extremo del recurso Field, tal como se muestra en los ejemplos de solicitudes de campo.

Método SetShowInDisplayForm

Establece el valor de la propiedad ShowInDisplayForm para este campo.

Extremo

/setshowindisplayform(<booleano>)

Parámetros

Tipo: Boolean
true para mostrar el campo en el formulario; de lo contrario, false.

HTTP method

POST

Respuesta

Ninguna

  Ejemplo de solicitud

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')
    /setshowindisplayform(false)",
  type: "POST",
  headers: { "X-RequestDigest": <form digest value> },
  success: successHandler,
  error: errorHandler
});

Método SetShowInEditForm

Establece el valor de la propiedad ShowInEditForm para este campo.

Extremo

/setshowineditform(<booleano>)

Parámetros

Tipo: Boolean
true para mostrar el campo en el formulario; de lo contrario, false.

HTTP method

POST

Respuesta

Ninguna

  Ejemplo de solicitud

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')
    /setshowineditform(false)",
  type: "POST",
  headers: { "X-RequestDigest": <form digest value> },
  success: successHandler,
  error: errorHandler
});

Método SetShowInNewForm

Establece el valor de la propiedad ShowInNewForm para este campo.

Extremo

/setshowinnewform(<booleano>)

Parámetros

Tipo: Boolean
true para mostrar el campo en el formulario; de lo contrario, false.

HTTP method

POST

Respuesta

Ninguna

  Ejemplo de solicitud

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')
    /setshowinnewform(false)",
  type: "POST",
  headers: { "X-RequestDigest": <form digest value> },
  success: successHandler,
  error: errorHandler
});

Representación OData

El siguiente ejemplo representa un recurso de Campo en formato JSON.

    {"d":{
      "__metadata":{,
        "id":"https://<site url>/_api/Web/Lists(guid'da58632f-faf0-4a78-8219-99c307747741')/Fields(guid'fa564e0f-0c70-4ab9-b863-0177e6ddd247')",
        "uri":"https://<site url>/_api/Web/Lists(guid'da58632f-faf0-4a78-8219-99c307747741')/Fields(guid'fa564e0f-0c70-4ab9-b863-0177e6ddd247')",
        "type":"SP.FieldText"
      },
      "CanBeDeleted":false,
      "DefaultValue":null,
      "Description":"",
      "Direction":"none",
      "EnforceUniqueValues":false,
      "EntityPropertyName":"Title",
      "Filterable":true,
      "FromBaseType":true,
      "Group":"Custom Columns",
      "Hidden":false,
      "Id":"fa564e0f-0c70-4ab9-b863-0177e6ddd247",
      "Indexed":false,
      "InternalName":"Title",
      "JSLink":"clienttemplates.js",
      "ReadOnlyField":false,
      "Required":true,
      "SchemaXml":"<Field ID=\"{fa564e0f-0c70-4ab9-b863-0177e6ddd247}\" Type=\"Text\" Name=\"Title\" DisplayName=\"Task Name\" Required=\"TRUE\" SourceID=\"http://schemas.microsoft.com/sharepoint/v3\" StaticName=\"Title\" FromBaseType=\"TRUE\" Sealed=\"TRUE\" ColName=\"nvarchar1\" />",
      "Scope":"/Lists/Backlog items",
      "Sealed":true,
      "Sortable":true,
      "StaticName":"Title",
      "Title":"Task Name",
      "FieldTypeKind":2,
      "TypeAsString":"Text",
      "TypeDisplayName":"Single line of text",
      "TypeShortDescription":"Single line of text",
      "ValidationFormula":null,
      "ValidationMessage":null,
      "MaxLength":255
    }}

Recursos FieldCalculated

URI del extremo  |  Propiedades  |  Métodos  |  Representación OData

Especifica un campo calculado. Hereda de SP.Field. Valor de tipo de campo = 17.

URI del extremo

http://<url de sitio>/_api/web/fields('<id. de campo>')
http://<url de sitio>/_api/web/lists(guid'<id. de lista>')/fields('<id. de campo>')

Métodos HTTP compatibles

GET  |  POST  |  DELETE  |  MERGE  |  PUT

Ejemplos de solicitudes

Ejemplo de solicitud GET: obtener un campo calculado

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')",
  type: "GET",
  headers: { "accept": "application/json;odata=verbose" },
  success: successHandler,
  error: errorHandler
});

O bien, puede utilizar el método GetByInternalNameOrTitle o GetByTitle del recurso FieldCollection para obtener un campo por su nombre o título interno (distingue mayúsculas de minúsculas). Ejemplo: …/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')/fields/getbytitle('Start Date').

Ejemplo de solicitud POST: crear un campo calculado

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields",
  type: "POST",
  data: "{ '__metadata': { 'type': 'SP.FieldCalculated' }, 'FieldTypeKind': 17, 'Title':
    'Days Remaining', 'Formula': '=DATEDIF([Start Date],[End Date],"d")', 'OutputType': 9 }",
  headers: { 
    "X-RequestDigest": <form digest value>,
    "accept": "application/json;odata=verbose",
    "content-type": "application/json;odata=verbose",
    "content-length": <length of body data>
  },
  success: successHandler,
  error: errorHandler
});

Consulte Métodos de FieldCollection para conocer otras maneras de crear un campo. Consulte Fórmulas de campos calculados para ver ejemplos de fórmulas compatibles.

Ejemplo de solicitud MERGE: cambiar un campo calculado

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')",
  type: "POST",
  data: "{ '__metadata': { 'type': 'SP.FieldCalculated' }, 'Title': 'Remaining', 'Formula':
    '=DATEDIF([Start Date],[End Date],"d")&" days"', 'OutputType': 2 }",
  headers: { 
    "X-RequestDigest": <form digest value>,
    "content-type": "application/json;odata=verbose",
    "content-length": <length of body data>,
    "X-HTTP-Method": "MERGE"
  },
  success: successHandler,
  error: errorHandler
});

Consulte Notas de implementación para obtener información acerca de cómo especificar el tipo de campo en una solicitud MERGE o PUT.

Ejemplo de solicitud DELETE: eliminar un campo calculado

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')",
  type: "POST",
  headers: { 
    "X-RequestDigest": <form digest value>,
    "X-HTTP-Method": "DELETE"
  },
  success: successHandler,
  error: errorHandler
});

Propiedades de FieldCalculated

Para obtener una propiedad, envíe una solicitud GET al extremo de la propiedad, tal como se muestra en el siguiente ejemplo.

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')/<property name>",
  type: "GET",
  headers: { "accept": "application/json;odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Propiedad

Tipo

L/E

Devuelta con recurso

Descripción

Consulte Propiedades de campo para conocer las propiedades que se heredan de SP.Field.

DateFormat

Int32

LE

Obtiene o establece el formato de fecha y hora que se muestra en el campo. Representa un valor DateTimeFieldFormatType: DateOnly = 0, DateTime = 1.

Formula

String

LE

Obtiene o establece un valor que especifica la fórmula del campo.

OutputType

Int32

LE

Obtiene o establece un valor que especifica el formato de salida del campo. Representa un valor FieldType. Consulte FieldType en la referencia de modelo de objetos de cliente .NET para ver una lista de valores de tipos de campo.

Métodos FieldCalculated

Los métodos se heredan de SP.Field.

DeleteObject  (o envíe una solicitud DELETE al extremo de campo)
SetShowInDisplayForm
SetShowInEditForm
SetShowInNewForm

Representación OData

El siguiente ejemplo representa un recurso SP.FieldCalculated en formato JSON.

    {"d":{
      "__metadata":{
        "id":"Web/Lists(guid'b784e682-3373-4c29-b3c2-373bdb71ce93')/Fields(guid'ddb702c8-e343-479b-9fda-b71af9175031')",
        "uri":"http://<site url>/_api/Web/Lists(guid'b784e682-3373-4c29-b3c2-373bdb71ce93')/Fields(guid'ddb702c8-e343-479b-9fda-b71af9175031')",
        "type":"SP.FieldCalculated"
      },
      "CanBeDeleted":true,
      "DefaultValue":null,
      "Description":"",
      "Direction":"none",
      "EnforceUniqueValues":false,
      "EntityPropertyName":"Remaining",
      "Filterable":true,
      "FromBaseType":false,
      "Group":"Custom Columns",
      "Hidden":false,
      "Id":"ddb702c8-e343-479b-9fda-b71af9175031",
      "Indexed":false,
      "InternalName":"Remaining",
      "JSLink":"clienttemplates.js",
      "ReadOnlyField":true,
      "Required":false,
      "SchemaXml":"<Field DisplayName=\"Remaining\" Type=\"Calculated\" Required=\"FALSE\" ResultType=\"Number\" ID=\"{ddb702c8-e343-479b-9fda-b71af9175031}\" SourceID=\"{b784e682-3373-4c29-b3c2-373bdb71ce93}\" StaticName=\"Remaining\" Name=\"Remaining\" ColName=\"sql_variant6\" RowOrdinal=\"0\" ReadOnly=\"TRUE\" Version=\"1\"><Formula>=DATEDIF(Start_x0020_Date,End_x0020_Date,\"d\")</Formula><FieldRefs><FieldRef Name=\"End_x0020_Date\" /><FieldRef Name=\"Start_x0020_Date\" /></FieldRefs></Field>",
      "Scope":"/Lists/Targets",
      "Sealed":false,
      "Sortable":true,
      "StaticName":"Remaining",
      "Title":"Remaining",
      "FieldTypeKind":17,
      "TypeAsString":"Calculated",
      "TypeDisplayName":"Calculated",
      "TypeShortDescription":"Calculated (calculation based on other columns)",
      "ValidationFormula":null,
      "ValidationMessage":null,
      "DateFormat":0,
      "Formula":"=DATEDIF([Start Date],[End Date],\"d\")",
      "OutputType":9
    }}

Recurso FieldCollection

URI del extremo  |  Propiedades  |  Métodos  |  Representación OData

Representa una colección de recursos Field.

URI del extremo

http://<url de sitio>/_api/web/fields
http://<url de sitio>/_api/web/lists(guid'<list id>')/fields

Métodos HTTP compatibles

GET  |  POST

Ejemplos de solicitudes

Ejemplo de solicitud GET: obtener todos los campos de una lista

$.ajax({
  url: "http://<site url>/_api/web
    /lists(guid'da58632f-faf0-4a78-8219-99c307747741')/fields",
  type: "GET",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Ejemplo de solicitud GET: obtener un campo específico

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('fa564e0f-0c70-4ab9-b863-0177e6ddd247')",
  type: "GET",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

O bien, puede utilizar el método GetByTitle o GetByInternalNameOrTitle del recurso FieldCollection para obtener un campo por su nombre o título interno (distingue mayúsculas de minúsculas). Ejemplo: …/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')/fields/getbytitle('Assigned To').

Ejemplo de solicitud POST: crear un campo

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields",
  type: "POST",
  data: "{ '__metadata': { 'type': 'SP.Field' }, 'Title': 'Comments', 'FieldTypeKind': 3 }",
  headers: { 
    "X-RequestDigest": <form digest value>,
    "accept": "application/json; odata=verbose",
    "content-type": "application/json;odata=verbose",
    "content-length": <length of body data>
  },
  success: successHandler,
  error: errorHandler
});

Ejemplo de solicitud POST: crear un campo incluido el esquema del campo. Para enviar un esquema complejo, puede usar el método CreateFieldAsXml.

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields",
  type: "POST",
  data: { '__metadata': { 'type': 'SP.Field' }, 'FieldTypeKind': 20, 'Title':
    'Stakeholders', 'SchemaXml': '<Field Type="UserMulti" Required="TRUE"
    UserSelectionMode="PeopleAndGroups" UserSelectionScope="0" Mult="TRUE" />' },
  headers: { 
    "X-RequestDigest": <form digest value>,
    "accept": "application/json; odata=verbose",
    "content-type": "application/json;odata=verbose",
    "content-length": <length of body data>
  },
  success: successHandler,
  error: errorHandler
});

Consulte Métodos de FieldCollection para conocer otras maneras de crear un campo. Consulte los Ejemplos de solicitudes Field para ver ejemplos que muestren cómo cambiar o eliminar un elemento de campo.

Propiedades de FieldCollection

Para obtener una propiedad, envíe una solicitud GET al extremo de la propiedad, tal como se muestra en el siguiente ejemplo.

$.ajax({
  url: "http://<site url>/_api/web
    /lists(guid'da58632f-faf0-4a78-8219-99c307747741')/fields/schemaxml",
  type: "GET",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Propiedad

Tipo

L/E

Devuelta con recurso

Descripción

SchemaXml

String

L

No

Especifica el esquema XML de la colección de campos.

Métodos de FieldCollection

AddDependentLookupField
AddField
CreateFieldAsXml
GetById
GetByInternalNameOrTitle
GetByTitle

Método AddDependentLookupField

Agrega un campo de búsqueda secundario que depende de uno principal para su relación con la lista desde la cual obtiene su información.

Extremo

/adddependentlookupfield(displayname, primarylookupfieldid, showfield)

Parámetros

displayname

Tipo: String
el título del nuevo campo.

primarylookupfieldid

Tipo: String
el identificador del campo de búsqueda para asociar con este campo de búsqueda dependiente.

showfield

Tipo: String
el nombre del campo de la lista de destino desde donde se incluirán datos.

HTTP method

POST

Respuesta

Tipo: SP.Field
El nuevo campo.

  Ejemplo de solicitud

$.ajax({
  url: "http://<site url>/_api/web
    /lists(guid'da58632f-faf0-4a78-8219-99c307747741')/fields
    /adddependentlookupfield(displayname='Project', primarylookupfieldid='c3a92d97-2b77-4a25-9698-3ab54874bc6f', showfield='Title')",
  type: "POST",
  headers: {
    "X-RequestDigest": <form digest value>>,
    "accept": "application/json;odata=verbose"
  },
  success: successHandler,
  error: errorHandler
});

Método AddField

Agrega un campo a la colección de campos.

Extremo

/addfield

Parámetros

parameters

Tipo: SP.FieldCreationInformation
Propiedades que definen el nuevo campo. Envíe este parámetro en el cuerpo de la solicitud, como se muestra en el ejemplo.

HTTP method

POST

Respuesta

Tipo: SP.Field
El nuevo campo.

  Ejemplo de solicitud

$.ajax({
  url: "http://<site url>/_api/web
    /lists(guid'da58632f-faf0-4a78-8219-99c307747741')/fields
    /addfield",
  type: "POST",
  data: "{ 'parameters': { '__metadata': { 'type': 'SP.FieldCreationInformation' }, 'Title':
    'Impact', 'FieldTypeKind': 6, 'Required': true, 'Choices': { '__metadata': { 'type':
    'Collection(Edm.String)' }, 'results': [ 'High', 'Medium', 'Low' ] } } }",
  headers: {
    "X-RequestDigest": <form digest value>,
    "accept": "application/json;odata=verbose",
    "content-type": "application/json; odata=verbose",
    "content-length": <length of body data>
  },
  success: successHandler,
  error: errorHandler
});

O bien, puede agregar un campo al enviar una POST solicitud al extremo de recurso FieldCollection, como se muestra en los ejemplos de solicitud de FieldCollection.

Método CreateFieldAsXml

Crea un campo según el esquema especificado, un valor Boolean y las opciones de campo.

Extremo

/createfieldasxml

Parámetros

parameters

Tipo: SP.XmlSchemaFieldCreationInformation
Propiedades que definen el nuevo campo. Envíe este parámetro en el cuerpo de la solicitud, como se muestra en el ejemplo.

HTTP method

POST

Respuesta

Tipo: SP.Field
El nuevo campo.

  Ejemplo de solicitud

$.ajax({
  url: "http://<site url>/_api/web
    /lists(guid'da58632f-faf0-4a78-8219-99c307747741')/fields
    /createfieldasxml",
  type: "POST",
  data: "{ 'parameters': { '__metadata': { 'type': 'SP.XmlSchemaFieldCreationInformation' },
    'SchemaXml': '<Field Type="UserMulti" Title="Stakeholders" DisplayName="Stakeholders"
    Required="FALSE" UserSelectionMode="PeopleAndGroups" UserSelectionScope="0" Mult="TRUE" />' } }",
  headers: {
    "X-RequestDigest": <form digest value>,
    "accept": "application/json;odata=verbose",
    "content-type": "application/json; odata=verbose",
    "content-length": <length of body data>
  },
  success: successHandler,
  error: errorHandler
});

O bien, puede agregar un campo al enviar una POST solicitud al extremo de recurso FieldCollection, como se muestra en los ejemplos de solicitud de FieldCollection.

Método GetById

Obtiene el campo con el identificador especificado.

Extremo

/getbyid('<id. de campo>')

Parámetros

Tipo: String
El identificador del campo.

HTTP method

GET

Respuesta

Tipo: SP.Field
El campo especificado.

  Ejemplo de solicitud

$.ajax({
  url: "http://<site url>/_api/web
    /lists(guid'da58632f-faf0-4a78-8219-99c307747741')/fields
    /getbyid('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')",
  type: "GET",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

También puede simplemente remitir el identificador del campo al recurso FieldCollection. Ejemplo: …/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')/fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1').

Método GetByInternalNameOrTitle

Devuelve el primer objeto Field con el título o nombre interno especificado desde la colección.

Extremo

/getbyinternalnameortitle('<nombre o título interno del campo>')

Parámetros

Tipo: String
El nombre interno con distinción de mayúsculas y minúsculas o el título del campo.

HTTP method

GET

Respuesta

Tipo: SP.Field
El campo especificado.

  Ejemplo de solicitud

$.ajax({
  url: "http://<site url>/_api/web
    /lists(guid'da58632f-faf0-4a78-8219-99c307747741')/fields
    /getbyinternalnameortitle('AssignedTo')",
  type: "GET",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Método GetByTitle

Devuelve el primer objeto de campo de la colección en función del título del campo especificado.

Extremo

/getbytitle('<título de campo>')

Parámetros

Tipo: String
El título con distinción de mayúsculas y minúsculas del campo.

HTTP method

GET

Respuesta

Tipo: SP.Field
El campo especificado.

  Ejemplo de solicitud

$.ajax({
  url: "http://<site url>/_api/web
    /lists(guid'da58632f-faf0-4a78-8219-99c307747741')/fields
    /getbytitle('Start Date')",
  type: "GET",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Representación OData

El siguiente ejemplo representa un recurso FieldCollection en formato JSON.

    {"d":{
      "results":[{
        "__metadata":{
          "id":"https://<site url>/_api/Web/Lists(guid'da58632f-faf0-4a78-8219-99c307747741')/Fields(guid'03e45e84-1992-4d42-9116-26f756012634')",
          "uri":"https://<site url>/_api/Web/Lists(guid'da58632f-faf0-4a78-8219-99c307747741')/Fields(guid'03e45e84-1992-4d42-9116-26f756012634')",
          "type":"SP.Field"
        },
        "CanBeDeleted":false,
        "DefaultValue":null,
        "Description":"",
        "Direction":"none",
        "EnforceUniqueValues":false,
        "EntityPropertyName":"ContentTypeId",
        "Filterable":true,
        "FromBaseType":true,
        "Group":"Custom Columns",
        "Hidden":true,
        "Id":"03e45e84-1992-4d42-9116-26f756012634",
        "Indexed":false,
        "InternalName":"ContentTypeId",
        "JSLink":null,
        "ReadOnlyField":true,
        "Required":false,
        "SchemaXml":"<Field ID="{03e45e84-1992-4d42-9116-26f756012634}" RowOrdinal="0" Type="ContentTypeId" Sealed="TRUE" ReadOnly="TRUE" Hidden="TRUE" DisplayName="Content Type ID" Name="ContentTypeId" DisplaceOnUpgrade="TRUE" SourceID="http://schemas.microsoft.com/sharepoint/v3" StaticName="ContentTypeId" ColName="tp_ContentTypeId" FromBaseType="TRUE" />",
        "Scope":"/Lists/Backlog items",
        "Sealed":true,
        "Sortable":true,
        "StaticName":"ContentTypeId",
        "Title":"Content Type ID",
        "FieldTypeKind":25,
        "TypeAsString":"ContentTypeId",
        "TypeDisplayName":"Content Type Id",
        "TypeShortDescription":"Content Type Id",
        "ValidationFormula":null,
        "ValidationMessage":null
        },{
        "__metadata":{
          "id":"https://<site url>/_api/Web/Lists(guid'da58632f-faf0-4a78-8219-99c307747741')/Fields(guid'fa564e0f-0c70-4ab9-b863-0177e6ddd247')",
          "uri":"https://<site url>/_api/Web/Lists(guid'da58632f-faf0-4a78-8219-99c307747741')/Fields(guid'fa564e0f-0c70-4ab9-b863-0177e6ddd247')",
          "type":"SP.FieldText"
        },
        "CanBeDeleted":false,
        "DefaultValue":null,
        "Description":"",
        "Direction":"none",
        "EnforceUniqueValues":false,
        "EntityPropertyName":"Title",
        "Filterable":true,
        "FromBaseType":true,
        "Group":"Custom Columns",
        "Hidden":false,
        "Id":"fa564e0f-0c70-4ab9-b863-0177e6ddd247",
        "Indexed":false,
        "InternalName":"Title",
        "JSLink":"clienttemplates.js",
        "ReadOnlyField":false,
        "Required":true,
        "SchemaXml":"<Field ID="{fa564e0f-0c70-4ab9-b863-0177e6ddd247}" Type="Text" Name="Title" DisplayName="Task Name" Required="TRUE" SourceID="http://schemas.microsoft.com/sharepoint/v3" StaticName="Title" FromBaseType="TRUE" Sealed="TRUE" ColName="nvarchar1" />",
        "Scope":"/Lists/Backlog items",
        "Sealed":true,
        "Sortable":true,
        "StaticName":"Title",
        "Title":"Task Name",
        "FieldTypeKind":2,
        "TypeAsString":"Text",
        "TypeDisplayName":"Single line of text",
        "TypeShortDescription":"Single line of text",
        "ValidationFormula":null,
        "ValidationMessage":null,
        "MaxLength":255
        },{
        ...
      }]
    }}

Recursos FieldComputed

URI del extremo  |  Propiedades  |  Métodos  |  Representación OData

Representa un campo que depende de otros campos para su contenido, pero puede especificar un modelo de representación personalizada. Hereda de SP.Field. Valor de tipo de campo = 12.

URI del extremo

http://<url de sitio>/_api/web/fields('<id. de campo>')
http://<url de sitio>/_api/web/lists(guid'<id. de lista>')/fields('<id. de campo>')

Métodos HTTP compatibles

GET  |  POST  |  DELETE  |  MERGE  |  PUT

Ejemplos de solicitudes

Ejemplo de solicitud GET: obtener un campo calculado

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')",
  type: "GET",
  headers: { "accept": "application/json;odata=verbose" },
  success: successHandler,
  error: errorHandler
});

O bien, puede utilizar el método GetByInternalNameOrTitle o GetByTitle del recurso FieldCollection para obtener un campo por su nombre o título interno (distingue mayúsculas de minúsculas). Ejemplo: …/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')/fields/getbytitle('Start Date').

Ejemplo de una solicitud POST: crear un campo calculado con el método CreateFieldAsXml

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields/createfieldasxml",
  type: "POST",
  data: "{ 'parameters': { '__metadata': { 'type': 'SP.XmlSchemaFieldCreationInformation' },
    'SchemaXml': '<Field Type=\"Computed\" DisplayName=\"Search\">
    <FieldRefs><FieldRef Name="Title" /></FieldRefs></Field>' } }",
  headers: { 
    "X-RequestDigest": <form digest value>,
    "accept": "application/json;odata=verbose",
    "content-type": "application/json;odata=verbose",
    "content-length": <length of body data>
  }
  success: successHandler,
  error: errorHandler
});

Después de crear un campo calculado y especificar el esquema XML, tendrá que crear el archivo de representación XSL. Consulte Información general del sistema de representación de vistas de listas XSLT.

Ejemplo de solicitud MERGE: cambiar un campo calculado

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')",
  type: "POST",
  data: "{ '__metadata': { 'type': 'SP.FieldComputed' }, 'SchemaXml': '<Field Type=\"Computed\" DisplayName=\"Search\">
    <FieldRefs><FieldRef Name="ID" /><FieldRef Name="Title" /></FieldRefs></Field>' }",
  headers: { 
    "X-RequestDigest": <form digest value>,
    "content-type": "application/json;odata=verbose",
    "content-length": <length of body data>,
    "X-HTTP-Method": "MERGE"
  },
  success: successHandler,
  error: errorHandler
});

Consulte Notas de implementación para obtener información acerca de cómo especificar el tipo de campo en una solicitud MERGE o PUT.

Ejemplo de solicitud DELETE: eliminar un campo calculado

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')",
  type: "POST",
  headers: { 
    "X-RequestDigest": <form digest value>,
    "X-HTTP-Method": "DELETE"
  },
  success: successHandler,
  error: errorHandler
});

Propiedades de FieldComputed

Para obtener una propiedad, envíe una solicitud GET al extremo de la propiedad, tal como se muestra en el siguiente ejemplo.

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')/<property name>",
  type: "GET",
  headers: { "accept": "application/json;odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Propiedad

Tipo

L/E

Devuelta con recurso

Descripción

Consulte Propiedades de campo para conocer las propiedades que se heredan de SP.Field.

EnableLookup

Boolean

LE

Obtiene o establece un valor que especifica si un campo de búsqueda puede hacer referencia al campo.

Métodos de FieldComputed

Los métodos se heredan de SP.Field.

DeleteObject  (o envíe una solicitud DELETE al extremo de campo)
SetShowInDisplayForm

SetShowInEditForm
SetShowInNewForm

Representación OData

El siguiente ejemplo representa un recurso SP.FieldCalculated en formato JSON.

    {"d":{
      "__metadata":{
        "id":"Web/Lists(guid'b784e682-3373-4c29-b3c2-373bdb71ce93')/Fields(guid'dceca14e-c897-4988-ae4f-f7c21bea80e5')",
        "uri":"http://<site url>/_api/Web/Lists(guid'b784e682-3373-4c29-b3c2-373bdb71ce93')/Fields(guid'dceca14e-c897-4988-ae4f-f7c21bea80e5')",
        "type":"SP.FieldComputed"
      },
      "CanBeDeleted":true,
      "DefaultValue":null,
      "Description":"",
      "Direction":"none",
      "EnforceUniqueValues":false,
      "EntityPropertyName":"Search",
      "Filterable":true,
      "FromBaseType":false,
      "Group":"Custom Columns",
      "Hidden":false,
      "Id":"dceca14e-c897-4988-ae4f-f7c21bea80e5",
      "Indexed":false,
      "InternalName":"Search",
      "JSLink":null,
      "ReadOnlyField":false,
      "Required":false,
      "SchemaXml":"<Field Type=\"Computed\" DisplayName=\"Search\" ID=\"{dceca14e-c897-4988-ae4f-f7c21bea80e5}\" SourceID=\"{b784e682-3373-4c29-b3c2-373bdb71ce93}\" StaticName=\"Search\" Name=\"Search\"><FieldRefs><FieldRef Name=\"Title\" /></FieldRefs></Field>",
      "Scope":"/Lists/Targets",
      "Sealed":false,
      "Sortable":true,
      "StaticName":"Search",
      "Title":"Search",
      "FieldTypeKind":12,
      "TypeAsString":"Computed",
      "TypeDisplayName":"Computed",
      "TypeShortDescription":"Computed",
      "ValidationFormula":null,
      "ValidationMessage":null,
      "EnableLookup":false
    }}

Recursos FieldDateTime

URI del extremo  |  Propiedades  |  Métodos  |  Representación OData

Especifica un campo que contiene valores de fecha y hora. Hereda de SP.Field. Valor de tipo de campo = 4.

URI del extremo

http://<url de sitio>/_api/web/fields('<id. de campo>')
http://<url de sitio>/_api/web/lists(guid'<id. de lista>')/fields('<id. de campo>')

Métodos HTTP compatibles

GET  |  POST  |  DELETE  |  MERGE  |  PUT

Ejemplos de solicitudes

Ejemplo de una solicitud GET: obtener un campo de fecha y hora

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')",
  type: "GET",
  headers: { "accept": "application/json;odata=verbose" },
  success: successHandler,
  error: errorHandler
});

O bien, puede utilizar el método GetByInternalNameOrTitle o GetByTitle del recurso FieldCollection para obtener un campo por su nombre o título interno (distingue mayúsculas de minúsculas). Ejemplo: …/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')/fields/getbytitle('Start Date').

Ejemplo de una solicitud POST: crear un campo de fecha y hora

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields",
  type: "POST",
  data: "{ '__metadata': { 'type': 'SP.FieldDateTime' }, 'FieldTypeKind': 4,
    'Title': 'Handoff Date', 'DisplayFormat': 1 }";
  headers: { 
    "X-RequestDigest": <form digest value>,
    "accept": "application/json;odata=verbose",
    "content-type": "application/json;odata=verbose",
    "content-length": <length of body data>
  },
  success: successHandler,
  error: errorHandler
});

Consulte Métodos de FieldCollection para conocer otras maneras de crear un campo.

Ejemplo de solicitud MERGE: cambiar un campo de fecha y hora

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')",
  type: "POST",
  data: "{ '__metadata': { 'type': 'SP.FieldDateTime' }, 'FriendlyDisplayFormat': 2 }",
  headers: { 
    "X-RequestDigest": <form digest value>,
    "content-type": "application/json;odata=verbose",
    "content-length": <length of body data>,
    "X-HTTP-Method": "MERGE"
  },
  success: successHandler,
  error: errorHandler
});

Consulte Notas de implementación para obtener información acerca de cómo especificar el tipo de campo en una solicitud MERGE o PUT.

Ejemplo de solicitud DELETE: eliminar un campo de fecha y hora

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')",
  type: "POST",
  headers: { 
    "X-RequestDigest": <form digest value>,
    "X-HTTP-Method": "DELETE"
  },
  success: successHandler,
  error: errorHandler
});

Propiedades de FieldDateTime

Para obtener una propiedad, envíe una solicitud GET al extremo de la propiedad, tal como se muestra en el siguiente ejemplo.

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')/<property name>",
  type: "GET",
  headers: { "accept": "application/json;odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Propiedad

Tipo

L/E

Devuelta con recurso

Descripción

Consulte Propiedades de campo para conocer las propiedades que se heredan de SP.Field.

DateTimeCalendarType

Int32

LE

Obtiene o establece un valor que especifica el tipo de calendario del campo. Representa un valor CalendarType: Gregoriano (localizado) = 1, Era del emperador japonés = 3, Calendario de Taiwán = 4, Coreano (era de Tangún) = 5, Hijri (árabe lunar) = 6, Tailandés = 7, Hebreo lunar = 8, Gregoriano (francés de Oriente Medio) = 9, Gregoriano (árabe) = 10, Gregoriano (transliteración al inglés) = 11, Gregoriano (transliteración al francés) = 12, Coreano y japonés lunar = 14, Chino lunar = 15, Saka Era = 16.

DisplayFormat

Int32

LE

Obtiene o establece el formato de fecha y hora que se muestra en el campo. Representa un valor DateTimeFieldFormatType: DateOnly = 0, DateTime = 1.

FriendlyDisplayFormat

Int32

LE

Representa un valor DateTimeFieldFriendlyFormat: Sin especificar = 0, Deshabilitado (estándar absoluto) = 1, Relativo (relativo descriptivo estándar) = 2.

Métodos de FieldDateTime

Los métodos se heredan de SP.Field.

DeleteObject  (o envíe una solicitud DELETE al extremo de campo)
SetShowInDisplayForm

SetShowInEditForm
SetShowInNewForm

Representación OData

El siguiente ejemplo representa un recurso SP.FieldDateTime en formato JSON.

    {"d":{
      "__metadata":{
        "id":"Web/Lists(guid'47f89cf2-359d-4792-9dc4-8da877a5050a')/Fields(guid'd6b835d3-820f-4926-85bd-7711cc31c4c8')",
        "uri":"http://<site url>/_api/Web/Lists(guid'47f89cf2-359d-4792-9dc4-8da877a5050a')/Fields(guid'd6b835d3-820f-4926-85bd-7711cc31c4c8')",
        "type":"SP.FieldDateTime"
      },
      "CanBeDeleted":true,
      "DefaultValue":null,
      "Description":"",
      "Direction":"none",
      "EnforceUniqueValues":false,
      "EntityPropertyName":"Handoff_x0020_Date",
      "Filterable":true,
      "FromBaseType":false,
      "Group":"Custom Columns",
      "Hidden":false,
      "Id":"d6b835d3-820f-4926-85bd-7711cc31c4c8",
      "Indexed":false,
      "InternalName":"Handoff_x0020_Date",
      "JSLink":"clienttemplates.js",
      "ReadOnlyField":false,
      "Required":false,
      "SchemaXml":"<Field DisplayName=\"Handoff Date\" Type=\"DateTime\" Required=\"FALSE\" ID=\"{d6b835d3-820f-4926-85bd-7711cc31c4c8}\" SourceID=\"{47f89cf2-359d-4792-9dc4-8da877a5050a}\" StaticName=\"Handoff_x0020_Date\" Name=\"Handoff_x0020_Date\" ColName=\"datetime3\" RowOrdinal=\"0\" Format=\"DateTime\" FriendlyDisplayFormat=\"Unspecified\" Version=\"9\" />",
      "Scope":"/Lists/Team tasks",
      "Sealed":false,
      "Sortable":true,
      "StaticName":"Handoff_x0020_Date",
      "Title":"Handoff Date",
      "FieldTypeKind":4,
      "TypeAsString":"DateTime",
      "TypeDisplayName":"Date and Time",
      "TypeShortDescription":"Date and Time",
      "ValidationFormula":null,
      "ValidationMessage":null,
      "DateTimeCalendarType":0,
      "DisplayFormat":1,
      "FriendlyDisplayFormat":0
    }}

Recurso FieldGeolocation

URI del extremo  |  Propiedades  |  Métodos  |  Representación OData

Representa un campo que contiene valores de ubicación geográfica. Hereda de SP.Field. Valor de tipo de campo = 31.

Para obtener más información acerca de los campos de ubicación, consulte Integración de funciones de ubicación y asignación en SharePoint 2013.

URI del extremo

http://<url de sitio>/_api/web/fields('<id. de campo>')
http://<url de sitio>/_api/web/lists(guid'<id. de lista>')/fields('<id. de campo>')

Métodos HTTP compatibles

GET  |  POST  |  DELETE  |  MERGE  |  PUT

Ejemplos de solicitudes

Ejemplo de solicitud GET: obtener un campo de ubicación

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')",
  type: "GET",
  headers: { "accept": "application/json;odata=verbose" },
  success: successHandler,
  error: errorHandler
});

O bien, puede utilizar el método GetByInternalNameOrTitle o GetByTitle del recurso FieldCollection para obtener un campo por su nombre o título interno (distingue mayúsculas de minúsculas). Ejemplo: …/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')/fields/getbytitle('Start Date').

Ejemplo de solicitud POST: crear un campo de ubicación

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields",
  type: "POST",
  data: "{ '__metadata': { 'type': 'SP.Field' }, 'FieldTypeKind': 31, 'Title': 'Location' }",
  headers: { 
    "X-RequestDigest": <form digest value>,
    "accept": "application/json;odata=verbose",
    "content-type": "application/json;odata=verbose",
    "content-length": <length of body data>
  },
  success: successHandler,
  error: errorHandler
});

Consulte Métodos de FieldCollection para conocer otras maneras de crear un campo.

Ejemplo de solicitud MERGE: cambiar un campo de ubicación

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')",
  type: "POST",
  data: "{ '__metadata': { 'type': 'SP.Field' }, 'Title': 'City' }",
  headers: { 
    "X-RequestDigest": <form digest value>,
    "content-type": "application/json;odata=verbose",
    "content-length": <length of body data>,
    "X-HTTP-Method": "MERGE"
  },
  success: successHandler,
  error: errorHandler
});

Consulte Notas de implementación para obtener información acerca de cómo especificar el tipo de campo en una solicitud MERGE o PUT.

Ejemplo de solicitud DELETE: eliminar un campo de ubicación

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')",
  type: "POST",
  headers: { 
    "X-RequestDigest": <form digest value>,
    "X-HTTP-Method": "DELETE"
  },
  success: successHandler,
  error: errorHandler
});

Propiedades de FieldGeolocation

Para obtener una propiedad, envíe una solicitud GET al extremo de la propiedad, tal como se muestra en el siguiente ejemplo.

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')/<property name>",
  type: "GET",
  headers: { "accept": "application/json;odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Propiedad

Tipo

L/E

Devuelta con recurso

Descripción

Consulte Propiedades de campo para conocer las propiedades que se heredan de SP.Field.

Métodos FieldGeolocation

Los métodos se heredan de SP.Field.

DeleteObject  (o envíe una solicitud DELETE al extremo de campo)
SetShowInDisplayForm

SetShowInEditForm
SetShowInNewForm

Representación OData

El siguiente ejemplo representa un recurso SP.FieldGeolocation en formato JSON.

    {"d":{
      "__metadata":{
        "id":"Web/Lists(guid'b784e682-3373-4c29-b3c2-373bdb71ce93')/Fields(guid'aec4b49c-573e-42a5-8844-cb1a9e1a720e')",
        "uri":"http://<site url>/_api/Web/Lists(guid'b784e682-3373-4c29-b3c2-373bdb71ce93')/Fields(guid'aec4b49c-573e-42a5-8844-cb1a9e1a720e')",
        "type":"SP.FieldGeolocation"
      },
      "CanBeDeleted":true,
      "DefaultValue":null,
      "Description":"",
      "Direction":"none",
      "EnforceUniqueValues":false,
      "EntityPropertyName":"Location",
      "Filterable":false,
      "FromBaseType":false,
      "Group":"Custom Columns",
      "Hidden":false,
      "Id":"aec4b49c-573e-42a5-8844-cb1a9e1a720e",
      "Indexed":false,
      "InternalName":"Location",
      "JSLink":"Geolocationfieldtemplate.js",
      "ReadOnlyField":false,
      "Required":false,
      "SchemaXml":"<Field DisplayName=\"Location\" Type=\"Geolocation\" Required=\"FALSE\" ID=\"{aec4b49c-573e-42a5-8844-cb1a9e1a720e}\" SourceID=\"{b784e682-3373-4c29-b3c2-373bdb71ce93}\" StaticName=\"Location\" Name=\"Location\" ColName=\"geography1\" RowOrdinal=\"0\" Version=\"3\" />",
      "Scope":"/Lists/Targets",
      "Sealed":false,
      "Sortable":false,
      "StaticName":"Location",
      "Title":"Location",
      "FieldTypeKind":31,
      "TypeAsString":"Geolocation",
      "TypeDisplayName":"Geolocation",
      "TypeShortDescription":"Geographic location that represents a point on a map",
      "ValidationFormula":null,
      "ValidationMessage":null
    }}

Recurso FieldGuid

URI del extremo  |  Propiedades  |  Métodos  |  Representación OData

Hereda de SP.Field. Valor de tipo de campo = 14.

URI del extremo

http://<url de sitio>/_api/web/fields('<id. de campo>')
http://<url de sitio>/_api/web/lists(guid'<id. de lista>')/fields('<id. de campo>')

Métodos HTTP compatibles

GET  |  POST  |  DELETE  |  MERGE  |  PUT

Ejemplos de solicitudes

Ejemplo de solicitud GET: obtener un campo GUID

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')",
  type: "GET",
  headers: { "accept": "application/json;odata=verbose" },
  success: successHandler,
  error: errorHandler
});

O bien, puede utilizar el método GetByInternalNameOrTitle o GetByTitle del recurso FieldCollection para obtener un campo por su nombre o título interno (distingue mayúsculas de minúsculas). Ejemplo: …/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')/fields/getbytitle('Start Date').

Ejemplo de solicitud POST: crear un campo GUID

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields",
  type: "POST",
  data: "{ '__metadata': { 'type': 'SP.FieldGuid' }, 'FieldTypeKind': 14,
    'Title': 'Project ID' }",
  headers: { 
    "X-RequestDigest": <form digest value>,
    "accept": "application/json;odata=verbose",
    "content-type": "application/json;odata=verbose",
    "content-length": <length of body data>
  },
  success: successHandler,
  error: errorHandler
});

Consulte Métodos de FieldCollection para conocer otras maneras de crear un campo.

Ejemplo de solicitud MERGE: cambiar un campo GUID

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')",
  type: "POST",
  data: "{ '__metadata': { 'type': 'SP.FieldGuid' }, 'Title': 'Project GUID', 'EnforceUniqueValues': true }",
  headers: { 
    "X-RequestDigest": <form digest value>,
    "content-type": "application/json;odata=verbose",
    "content-length": <length of body data>,
    "X-HTTP-Method": "MERGE"
  },
  success: successHandler,
  error: errorHandler
});

Consulte Notas de implementación para obtener información acerca de cómo especificar el tipo de campo en una solicitud MERGE o PUT.

Ejemplo de solicitud DELETE: eliminar un campo GUID

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')",
  type: "POST",
  headers: { 
    "X-RequestDigest": <form digest value>,
    "X-HTTP-Method": "DELETE"
  },
  success: successHandler,
  error: errorHandler
});

Propiedades de FieldGuid

Para obtener una propiedad, envíe una solicitud GET al extremo de la propiedad, tal como se muestra en el siguiente ejemplo.

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')/<property name>",
  type: "GET",
  headers: { "accept": "application/json;odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Propiedad

Tipo

L/E

Devuelta con recurso

Descripción

Consulte Propiedades de campo para conocer las propiedades que se heredan de SP.Field.

Métodos FieldGuid

Los métodos se heredan de SP.Field.

DeleteObject  (o envíe una solicitud DELETE al extremo de campo)
SetShowInDisplayForm

SetShowInEditForm
SetShowInNewForm

Representación OData

El siguiente ejemplo representa un recurso SP.FieldGuid en formato JSON.

    {"d":{
      "__metadata":{
        "id":"Web/Lists(guid'47f89cf2-359d-4792-9dc4-8da877a5050a')/Fields(guid'53f865f8-675b-47d2-b4d6-1c8803eb6295')",
        "uri":"http://<site url>/_api/Web/Lists(guid'47f89cf2-359d-4792-9dc4-8da877a5050a')/Fields(guid'53f865f8-675b-47d2-b4d6-1c8803eb6295')",
        "type":"SP.FieldGuid"
      },
      "CanBeDeleted":true,
      "DefaultValue":null,
      "Description":"",
      "Direction":"none",
      "EnforceUniqueValues":false,
      "EntityPropertyName":"Project_x0020_ID",
      "Filterable":true,
      "FromBaseType":false,
      "Group":"Custom Columns",
      "Hidden":false,
      "Id":"53f865f8-675b-47d2-b4d6-1c8803eb6295",
      "Indexed":false,
      "InternalName":"Project_x0020_ID",
      "JSLink":null,
      "ReadOnlyField":false,
      "Required":false,
      "SchemaXml":"<Field DisplayName=\"Project ID\" Type=\"Guid\" Required=\"FALSE\" ID=\"{53f865f8-675b-47d2-b4d6-1c8803eb6295}\" SourceID=\"{47f89cf2-359d-4792-9dc4-8da877a5050a}\" StaticName=\"Project_x0020_ID\" Name=\"Project_x0020_ID\" ColName=\"uniqueidentifier1\" RowOrdinal=\"0\" Version=\"1\" />",
      "Scope":"/Lists/Team tasks",
      "Sealed":false,
      "Sortable":true,
      "StaticName":"Project_x0020_ID",
      "Title":"Project ID",
      "FieldTypeKind":14,
      "TypeAsString":"Guid",
      "TypeDisplayName":"Guid",
      "TypeShortDescription":"Guid",
      "ValidationFormula":null,
      "ValidationMessage":null
    }}

Recursos FieldLookup y FieldUser

URI del extremo  |  Propiedades  |  Métodos  |  Representación OData

Recurso

Descripción

Valor de tipo de campo

FieldLookup

Especifica un campo de búsqueda. Hereda de SP.Field.

7

FieldUser

Especifica un campo que contiene un usuario. Hereda de SP.FieldLookup.

20

URI del extremo

http://<url de sitio>/_api/web/fields('<id. de campo>')
http://<url de sitio>/_api/web/lists(guid'<id. de lista>')/fields('<id. de campo>')

Métodos HTTP compatibles

GET  |  POST  |  DELETE  |  MERGE  |  PUT

Ejemplos de solicitudes

Ejemplo de solicitud GET: obtener una búsqueda o un userfield

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')",
  type: "GET",
  headers: { "accept": "application/json;odata=verbose" },
  success: successHandler,
  error: errorHandler
});

O bien, puede utilizar el método GetByInternalNameOrTitle o GetByTitle del recurso FieldCollection para obtener un campo por su nombre o título interno (distingue mayúsculas de minúsculas). Ejemplo: …/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')/fields/getbytitle('Start Date').

Ejemplo de solicitud POST: crear un campo de búsqueda. Use el método AddField para crear un campo de búsqueda.

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields/addfield",
  type: "POST",
  data: "{ 'parameters': { '__metadata': { 'type': 'SP.FieldCreationInformation' }, 'FieldTypeKind': 7,
    'Title': 'Project Rollup', 'LookupListId': '4635daeb-7206-4513-ad17-ea06e09187ad',
    'LookupFieldName': 'Title' } }",
  headers: { 
    "X-RequestDigest": <form digest value>,
    "accept": "application/json;odata=verbose",
    "content-type": "application/json;odata=verbose",
    "content-length": <length of body data>
  },
  success: successHandler,
  error: errorHandler
});

Ejemplo de solicitud POST: crear un campo de usuario

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields",
  type: "POST",
  data: "{ '__metadata': { 'type': 'SP.FieldUser' }, 'FieldTypeKind': 20,
    'Title': 'Owner', 'SelectionGroup': 7, 'SelectionMode': 0 }",
  headers: { 
    "X-RequestDigest": <form digest value>,
    "accept": "application/json;odata=verbose",
    "content-type": "application/json;odata=verbose",
    "content-length": <length of body data>
  },
  success: successHandler,
  error: errorHandler
});

Consulte Métodos de FieldCollection para conocer otras maneras de crear un campo.

Ejemplo de solicitud MERGE: cambiar un campo de búsqueda

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')",
  type: "POST",
  data: "{ '__metadata': { 'type': 'SP.FieldLookup' }, 'AllowMultipleValues': true }",
  headers: { 
    "X-RequestDigest": <form digest value>,
    "content-type": "application/json;odata=verbose",
    "content-length": <length of body data>,
    "X-HTTP-Method": "MERGE"
  },
  success: successHandler,
  error: errorHandler
});

Consulte Notas de implementación para obtener información acerca de cómo especificar el tipo de campo en una solicitud MERGE o PUT.

Ejemplo de la solicitud DELETE: eliminar un campo de búsqueda o usuario

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')",
  type: "POST",
  headers: { 
    "X-RequestDigest": <form digest value>,
    "X-HTTP-Method": "DELETE"
  },
  success: successHandler,
  error: errorHandler
});

Propiedades FieldLookup y FieldUser

Para obtener una propiedad, envíe una solicitud GET al extremo de la propiedad, tal como se muestra en el siguiente ejemplo.

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')/<property name>",
  type: "GET",
  headers: { "accept": "application/json;odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Propiedad

Tipo

L/E

Devuelta con recurso

Descripción

Consulte Propiedades de campo para las propiedades que se heredan de SP.Field.
Un * indica que la propiedad no se heredó de FieldLookup.

AllowDisplay*

Boolean

LE

Obtiene o establece un valor que especifica si se muestra el nombre del usuario en una lista de encuesta.
* Solo se aplica a FieldUser.

AllowMultipleValues

Boolean

LE

Obtiene o establece un valor que especifica si el campo de búsqueda permite varios valores. No se puede establecer una restricción de eliminación en un campo de búsqueda que permite varios valores.

IsRelationship

Boolean

LE

Obtiene o establece un valor que especifica si SP.List.getRelatedFields devuelve este campo de búsqueda desde la lista en la que se está buscando. Siempre devuelve false si el campo representa una columna secundaria en una búsqueda de varias columnas. Las columnas secundarias no son reconocibles en la lista de origen. Consulte IsRelationship en la referencia de modelo de objetos de cliente .NET para obtener más información acerca de esta propiedad.

LookupField

String

LE

Obtiene o establece un valor que especifica el nombre de campo interno del campo usado como los valores de búsqueda.

LookupList

String

LE

Obtiene o establece un valor que especifica el identificador de lista de la lista que contiene el campo que se usará como los valores de búsqueda.

LookupWebId

GUID

LE

Obtiene o establece el identificador del sitio web que contiene la lista que es el origen del valor de este campo.

Presence*

Boolean

LE

Obtiene o establece un valor que especifica si está habilitada la presencia en el campo.
* Solo se aplica a FieldUser.

PrimaryFieldId

String

LE

Obtiene o establece un valor que especifica el identificador de campo de búsqueda principal si se trata de un campo de búsqueda dependiente. De lo contrario, es una cadena vacía.

RelationshipDeleteBehavior

Int32

LE

Obtiene o establece un valor que especifica el comportamiento de eliminación del campo de búsqueda. Representa un valor RelationshipDeleteBehaviorType: None = 0, Cascade = 1, Restrict = 2. Vea RelationshipDeleteBehavior en la referencia de modelo de objetos de cliente .NET para obtener más información acerca de esta propiedad.

SelectionGroup*

Int32

LE

Obtiene o establece un valor que especifica el identificador del grupo de SharePoint cuyos miembros pueden seleccionarse como valores del campo.
* Solo se aplica a FieldUser.

SelectionMode*

Int32

LE

Obtiene o establece un valor que especifica si se pueden seleccionar usuarios y grupos o solo usuarios. Representa un valorFieldUserSelectionMode: PeopleOnly = 0, PeopleAndGroups = 1.
*Solo se aplica a FieldUser.

Métodos FieldLookup y FieldUser

Los métodos se heredan de SP.Field.

DeleteObject  (o envíe una solicitud DELETE al extremo de campo)
SetShowInDisplayForm
SetShowInEditForm
SetShowInNewForm

Representación OData

El siguiente ejemplo representa un recurso SP.FieldLookup en formato JSON.

    {"d":{
      "__metadata":{
        "id":"Web/Lists(guid'b784e682-3373-4c29-b3c2-373bdb71ce93')/Fields(guid'2ee42785-f5b4-4af3-9011-96a9dea67d23')",
        "uri":"http://<site url>/_api/Web/Lists(guid'b784e682-3373-4c29-b3c2-373bdb71ce93')/Fields(guid'2ee42785-f5b4-4af3-9011-96a9dea67d23')",
        "type":"SP.FieldLookup"
      },
      "CanBeDeleted":true,
      "DefaultValue":null,
      "Description":"",
      "Direction":"none",
      "EnforceUniqueValues":false,
      "EntityPropertyName":"Project_x0020_Rollup",
      "Filterable":true,
      "FromBaseType":false,
      "Group":"Custom Columns",
      "Hidden":false,
      "Id":"2ee42785-f5b4-4af3-9011-96a9dea67d23",
      "Indexed":false,
      "InternalName":"Project_x0020_Rollup",
      "JSLink":"clienttemplates.js",
      "ReadOnlyField":false,
      "Required":false,
      "SchemaXml":"<Field DisplayName=\"Project Rollup\" Type=\"Lookup\" Required=\"FALSE\" List=\"{4635DAEB-7206-4513-AD17-EA06E09187AD}\" ID=\"{2ee42785-f5b4-4af3-9011-96a9dea67d23}\" SourceID=\"{b784e682-3373-4c29-b3c2-373bdb71ce93}\" StaticName=\"Project_x0020_Rollup\" Name=\"Project_x0020_Rollup\" ColName=\"int1\" RowOrdinal=\"0\" ShowField=\"Title\" Version=\"1\" />",
      "Scope":"/Lists/Targets",
      "Sealed":false,
      "Sortable":true,
      "StaticName":"Project_x0020_Rollup",
      "Title":"Project Rollup",
      "FieldTypeKind":7,
      "TypeAsString":"Lookup",
      "TypeDisplayName":"Lookup",
      "TypeShortDescription":"Lookup (information already on this site)",
      "ValidationFormula":null,
      "ValidationMessage":null,
      "AllowMultipleValues":false,
      "IsRelationship":true,
      "LookupField":"Title",
      "LookupList":"{4635DAEB-7206-4513-AD17-EA06E09187AD}",
      "LookupWebId":"0d787dd7-3d5b-481f-93a3-085687dbb644",
      "PrimaryFieldId":null,
      "RelationshipDeleteBehavior":0
    }}

El siguiente ejemplo representa un recurso SP.FieldUser en formato JSON.

    {"d":{
      "__metadata":{
        "id":"Web/Lists(guid'b784e682-3373-4c29-b3c2-373bdb71ce93')/Fields(guid'7feaefbb-c501-4539-8973-839da0d2e6f6')",
        "uri":"http://<site url>/_api/Web/Lists(guid'b784e682-3373-4c29-b3c2-373bdb71ce93')/Fields(guid'7feaefbb-c501-4539-8973-839da0d2e6f6')",
        "type":"SP.FieldUser"
      },
      "CanBeDeleted":true,
      "DefaultValue":null,
      "Description":"",
      "Direction":"none",
      "EnforceUniqueValues":false,
      "EntityPropertyName":"Owner",
      "Filterable":true,
      "FromBaseType":false,
      "Group":"Custom Columns",
      "Hidden":false,
      "Id":"7feaefbb-c501-4539-8973-839da0d2e6f6",
      "Indexed":false,
      "InternalName":"Owner",
      "JSLink":"clienttemplates.js",
      "ReadOnlyField":false,
      "Required":false,
      "SchemaXml":"<Field DisplayName=\"Owner\" Type=\"User\" Required=\"FALSE\" List=\"UserInfo\" ID=\"{7feaefbb-c501-4539-8973-839da0d2e6f6}\" SourceID=\"{b784e682-3373-4c29-b3c2-373bdb71ce93}\" StaticName=\"Owner\" Name=\"Owner\" ColName=\"int2\" RowOrdinal=\"0\" UserSelectionScope=\"7\" UserSelectionMode=\"PeopleOnly\" Version=\"1\" />",
      "Scope":"/Lists/Targets",
      "Sealed":false,
      "Sortable":true,
      "StaticName":"Owner",
      "Title":"Owner",
      "FieldTypeKind":20,
      "TypeAsString":"User",
      "TypeDisplayName":"Person or Group",
      "TypeShortDescription":"Person or Group",
      "ValidationFormula":null,
      "ValidationMessage":null,
      "AllowMultipleValues":false,
      "IsRelationship":false,
      "LookupField":"",
      "LookupList":"{a63367c0-83e8-48eb-9b88-d2c0d2db001c}",
      "LookupWebId":"0d787dd7-3d5b-481f-93a3-085687dbb644",
      "PrimaryFieldId":null,
      "RelationshipDeleteBehavior":0,
      "AllowDisplay":true,
      "Presence":true,
      "SelectionGroup":7,
      "SelectionMode":0
    }

Recursos FieldMultiChoice, FieldChoice y FieldRatingScale

URI del extremo  |  Propiedades  |  Métodos  |  Representación OData

Recurso

Descripción

Valor de tipo de campo

FieldMultiChoice

Especifica un campo que contiene uno o varios valores de un conjunto de valores especificados. Hereda de SP.Field.

15

FieldChoice

Representa un control de campo de opción. Hereda de SP.FieldMultiChoice.

6

FieldRatingScale

Especifica un campo que contiene los valores de escala de clasificación para una lista de encuesta. Hereda de SP.FieldMultiChoice. También se llama GridChoice.

16

URI del extremo

http://<url de sitio>/_api/web/fields('<id. de campo>')
http://<url de sitio>/_api/web/lists(guid'<id. de lista>')/fields('<id. de campo>')

Métodos HTTP compatibles

GET  |  POST  |  DELETE  |  MERGE  |  PUT

Ejemplos de solicitudes

Ejemplo de solicitud GET: obtener un campo

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')",
  type: "GET",
  headers: { "accept": "application/json;odata=verbose" },
  success: successHandler,
  error: errorHandler
});

O bien, puede utilizar el método GetByInternalNameOrTitle o GetByTitle del recurso FieldCollection para obtener un campo por su nombre o título interno (distingue mayúsculas de minúsculas). Ejemplo: …/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')/fields/getbytitle('Status').

Ejemplo de solicitud POST: crear un campo de opción múltiple

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'47f89cf2-359d-4792-9dc4-8da877a5050a')
    /fields",
  type: "POST",
  data: "{ '__metadata': { 'type': 'SP.FieldMultiChoice' }, 'FieldTypeKind': 15,
    'Title': 'Features', 'Choices': { '__metadata': { 'type': 'Collection(Edm.String)' },
    'results': [ 'ECM', 'Workflow', 'Collaboration' ] }, 'FillInChoice': true, 'DefaultValue': 'ECM' }",
  headers: { 
    "X-RequestDigest": <form digest value>,
    "accept": "application/json;odata=verbose",
    "content-type": "application/json;odata=verbose",
    "content-length": <length of body data>
  },
  success: successHandler,
  error: errorHandler
});

Ejemplo de solicitud POST: crear un campo de opción

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'47f89cf2-359d-4792-9dc4-8da877a5050a')
    /fields",
  type: "POST",
  data: "{ '__metadata': { 'type': 'SP.FieldChoice' }, 'FieldTypeKind': 6,
    'Title': 'Scope', 'Choices': { '__metadata': { 'type': 'Collection(Edm.String)' },
    'results': [ 'Internal', 'External' ] }, 'EditFormat': 1 }",
  headers: { 
    "X-RequestDigest": <form digest value>,
    "accept": "application/json;odata=verbose",
    "content-type": "application/json;odata=verbose",
    "content-length": <length of body data>
  },
  success: successHandler,
  error: errorHandler
});

Ejemplo de solicitud POST: crear un campo de escala de clasificación

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields",
  type: "POST",
  data: "{ '__metadata': { 'type': 'SP.FieldRatingScale' }, 'FieldTypeKind': 16,
    'Title': 'How frequently do you use these features?', 'Choices':  { '__metadata':
    { 'type': 'Collection(Edm.String)' }, 'results': [ 'ECM', 'Workflow', 'Collaboration' ] },
    'GridTextRangeLow': 'Rarely', 'GridTextRangeAverage': 'Sometimes', 'GridTextRangeHigh': 'Often',
    'GridStartNumber': 1, 'GridEndNumber': 3, 'RangeCount': 3 }",
  headers: { 
    "X-RequestDigest": <form digest value>,
    "accept": "application/json;odata=verbose",
    "content-type": "application/json;odata=verbose",
    "content-length": <length of body data>
  },
  success: successHandler,
  error: errorHandler
});

Consulte Métodos de FieldCollection para conocer otras maneras de crear un campo.

Ejemplo de solicitud MERGE: cambiar un campo de opción

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'43c6d385-122f-4b77-a7cd-538ede2a047f')
    /fields('509e9ac8-7ee6-4452-aaf9-1d2c42909187')",
  type: "POST",
  data: "{ '__metadata': { 'type': 'SP.FieldChoice' }, 'DefaultValue': 'External', 'EditFormat': 0 }",
  headers: { 
    "X-RequestDigest": <form digest value>,
    "content-type": "application/json;odata=verbose",
    "content-length": <length of body data>,
    "X-HTTP-Method": "MERGE"
  },
  success: successHandler,
  error: errorHandler
});

Consulte Notas de implementación para obtener información acerca de cómo especificar el tipo de campo en una solicitud MERGE o PUT.

Ejemplo de solicitud DELETE: eliminar un campo

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')",
  type: "POST",
  headers: { 
    "X-RequestDigest": <form digest value>,
    "X-HTTP-Method": "DELETE"
  },
  success: successHandler,
  error: errorHandler
});

Propiedades FieldMultiChoice, FieldChoice y FieldRatingScale

Para obtener una propiedad, envíe una solicitud GET al extremo de la propiedad, tal como se muestra en el siguiente ejemplo.

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')/<property name>",
  type: "GET",
  headers: { "accept": "application/json;odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Propiedad

Tipo

L/E

Devuelta con recurso

Descripción

Consulte Propiedades de campo para las propiedades que se heredan de SP.Field.
Un * indica que la propiedad no se heredó de FieldMultiChoice.

Choices

Collection(Edm.String)

LE

Obtiene o establece un valor que especifica los valores que se encuentran disponibles para seleccionar en el campo.

EditFormat*

Int32

LE

Determina si se mostrará el campo de opción como botones de opción (también denominados "botones de radio") o como lista desplegable. Representa un valorChoiceFormatType: Dropdown = 0, RadioButtons = 1.
*Solo se aplica a FieldChoice.

FillInChoice

Boolean

LE

Obtiene o establece un valor que especifica si el campo puede aceptar valores distintos de los especificados en la propiedad Choices.

GridEndNumber*

Int32

LE

Obtiene o establece un valor que especifica el número final de la escala de clasificación.
* Solo se aplica a FieldRatingScale.

GridNAOptionText*

String

LE

Obtiene o establece un valor que especifica el texto para mostrar correspondiente a la opción de la escala de clasificación que indica la opción que no corresponde.
* Solo se aplica a FieldRatingScale.

GridStartNumber*

Int32

LE

Obtiene o establece un valor que especifica el número inicial de la escala de clasificación.
* Solo se aplica a FieldRatingScale.

GridTextRangeAverage*

String

LE

Obtiene o establece un valor que especifica el texto para mostrar correspondiente al promedio de la escala de clasificación.
* Solo se aplica a FieldRatingScale.

GridTextRangeHigh*

String

LE

Obtiene o establece un valor que especifica el texto para mostrar correspondiente al máximo de la escala de clasificación.
* Solo se aplica a FieldRatingScale.

GridTextRangeLow*

String

LE

Obtiene o establece un valor que especifica el texto para mostrar correspondiente al mínimo de la escala de clasificación.
* Solo se aplica a FieldRatingScale.

Mappings

String

L

Obtiene un valor que especifica los valores internos correspondientes a las opciones.

RangeCount*

Int32

L

Obtiene un valor que especifica el número de opciones de la escala de clasificación.
* Solo se aplica a FieldRatingScale.

Métodos FieldMultiChoice, FieldChoice y FieldRatingScale

Los métodos se heredan de SP.Field.

DeleteObject  (o envíe una solicitud DELETE al extremo de campo)
SetShowInDisplayForm

SetShowInEditForm
SetShowInNewForm

Representaciones OData

El siguiente ejemplo representa un recurso SP.FieldMultiChoice en formato JSON.

    {"d":{
      "__metadata":{
        "id":"Web/Lists(guid'47f89cf2-359d-4792-9dc4-8da877a5050a')/Fields(guid'de0a7921-f807-4806-a4b6-a611224f19e5')",
        "uri":"http://<site url>/_api/Web/Lists(guid'47f89cf2-359d-4792-9dc4-8da877a5050a')/Fields(guid'de0a7921-f807-4806-a4b6-a611224f19e5')",
        "type":"SP.FieldMultiChoice"
      },
      "CanBeDeleted":true,
      "DefaultValue":"ECM",
      "Description":"",
      "Direction":"none",
      "EnforceUniqueValues":false,
      "EntityPropertyName":"Features",
      "Filterable":true,
      "FromBaseType":false,
      "Group":"Custom Columns",
      "Hidden":false,
      "Id":"de0a7921-f807-4806-a4b6-a611224f19e5",
      "Indexed":false,
      "InternalName":"Features",
      "JSLink":"clienttemplates.js",
      "ReadOnlyField":false,
      "Required":true,
      "SchemaXml":"<Field Type=\"MultiChoice\" DisplayName=\"Features\" Required=\"TRUE\" EnforceUniqueValues=\"FALSE\" Indexed=\"FALSE\" FillInChoice=\"TRUE\" ID=\"{de0a7921-f807-4806-a4b6-a611224f19e5}\" SourceID=\"{47f89cf2-359d-4792-9dc4-8da877a5050a}\" StaticName=\"Features\" Name=\"Features\" ColName=\"ntext6\" RowOrdinal=\"0\"><Default>ECM</Default><CHOICES><CHOICE>ECM</CHOICE><CHOICE>Workflow</CHOICE><CHOICE>Collaboration</CHOICE></CHOICES></Field>",
      "Scope":"/Lists/Team tasks",
      "Sealed":false,
      "Sortable":false,
      "StaticName":"Features",
      "Title":"Features",
      "FieldTypeKind":15,
      "TypeAsString":"MultiChoice",
      "TypeDisplayName":"Choice",
      "TypeShortDescription":"Choice (menu to choose from)",
      "ValidationFormula":null,
      "ValidationMessage":null,
      "FillInChoice":true,
      "Mappings":null,
      "Choices":{"__metadata":{"type":"Collection(Edm.String)"},"results":["ECM","Workflow","Collaboration"]}
    }}

El siguiente ejemplo representa un recurso SP.FieldChoice en formato JSON.

    {"d":{
      "__metadata":{
        "id":"Web/Lists(guid'47f89cf2-359d-4792-9dc4-8da877a5050a')/Fields(guid'509e9ac8-7ee6-4452-aaf9-1d2c42909187')",
        "uri":"http://<site url>/_api/Web/Lists(guid'47f89cf2-359d-4792-9dc4-8da877a5050a')/Fields(guid'509e9ac8-7ee6-4452-aaf9-1d2c42909187')",
        "type":"SP.FieldChoice"
      },
      "CanBeDeleted":true,
      "DefaultValue":null,
      "Description":"",
      "Direction":"none",
      "EnforceUniqueValues":false,
      "EntityPropertyName":"Impact",
      "Filterable":true,
      "FromBaseType":false,
      "Group":"Custom Columns",
      "Hidden":false,
      "Id":"509e9ac8-7ee6-4452-aaf9-1d2c42909187",
      "Indexed":false,
      "InternalName":"Impact",
      "JSLink":"clienttemplates.js",
      "ReadOnlyField":false,
      "Required":false,
      "SchemaXml":"<Field DisplayName=\"Impact\" Type=\"Choice\" Required=\"FALSE\" ID=\"{509e9ac8-7ee6-4452-aaf9-1d2c42909187}\" SourceID=\"{47f89cf2-359d-4792-9dc4-8da877a5050a}\" StaticName=\"Impact\" Name=\"Impact\" ColName=\"nvarchar6\" RowOrdinal=\"0\" Version=\"1\"><CHOICES><CHOICE>High</CHOICE><CHOICE>Medium</CHOICE><CHOICE>Low</CHOICE></CHOICES></Field>",
      "Scope":"/Lists/Team tasks",
      "Sealed":false,
      "Sortable":true,
      "StaticName":"Impact",
      "Title":"Impact",
      "FieldTypeKind":6,
      "TypeAsString":"Choice",
      "TypeDisplayName":"Choice",
      "TypeShortDescription":"Choice (menu to choose from)",
      "ValidationFormula":null,
      "ValidationMessage":null,
      "FillInChoice":false,
      "Mappings":null,
      "Choices":{"__metadata":{"type":"Collection(Edm.String)"},"results":["High","Medium","Low"]},
      "EditFormat":0
    }}

El siguiente ejemplo representa un recurso SP.FieldRatingScale en formato JSON.

    {"d":{
      "__metadata":{
        "id":"Web/Lists(guid'7804ea60-6093-489d-a483-bafd70ea01e9')/Fields(guid'8eac1672-8a47-4d44-a261-f5620db71402')",
        "uri":"http://<site url>/_api/Web/Lists(guid'7804ea60-6093-489d-a483-bafd70ea01e9')/Fields(guid'8eac1672-8a47-4d44-a261-f5620db71402')",
        "type":"SP.FieldRatingScale"
      },
      "CanBeDeleted":true,
      "DefaultValue":null,
      "Description":"",
      "Direction":"none",
      "EnforceUniqueValues":false,
      "EntityPropertyName":"How_x0020_frequently_x0020_do_x02",
      "Filterable":false,
      "FromBaseType":false,
      "Group":"Custom Columns",
      "Hidden":false,
      "Id":"8eac1672-8a47-4d44-a261-f5620db71402",
      "Indexed":false,
      "InternalName":"How_x0020_frequently_x0020_do_x02",
      "JSLink":"",
      "ReadOnlyField":false,
      "Required":false,
      "SchemaXml":"<Field DisplayName=\"How frequently do you use these features?\" Type=\"GridChoice\" Required=\"FALSE\" ID=\"{8eac1672-8a47-4d44-a261-f5620db71402}\" SourceID=\"{7804ea60-6093-489d-a483-bafd70ea01e9}\" StaticName=\"How_x0020_frequently_x0020_do_x02\" Name=\"How_x0020_frequently_x0020_do_x02\" ColName=\"ntext6\" RowOrdinal=\"0\" Version=\"2\" GridTxtRng1=\"Rarely\" GridTxtRng2=\"Sometimes\" GridTxtRng3=\"Often\" GridStartNum=\"1\" GridEndNum=\"3\"><CHOICES><CHOICE>ECM</CHOICE><CHOICE>Workflow</CHOICE><CHOICE>Collaboration</CHOICE></CHOICES></Field>",
      "Scope":"/Lists/Survey",
      "Sealed":false,
      "Sortable":false,
      "StaticName":"How_x0020_frequently_x0020_do_x02",
      "Title":"How frequently do you use these features?",
      "FieldTypeKind":16,
      "TypeAsString":"GridChoice",
      "TypeDisplayName":"Rating Scale",
      "TypeShortDescription":"Rating Scale (a matrix of choices or a Likert scale)",
      "ValidationFormula":null,
      "ValidationMessage":null,
      "FillInChoice":false,
      "Mappings":null,
      "Choices":{"__metadata":{"type":"Collection(Edm.String)"},"results":["ECM","Workflow","Collaboration"]},
      "GridEndNumber":3,
      "GridNAOptionText":null,
      "GridStartNumber":1,
      "GridTextRangeAverage":"Sometimes",
      "GridTextRangeHigh":"Often",
      "GridTextRangeLow":"Rarely",
      "RangeCount":3
    }}

Recurso FieldMultiLineText

URI del extremo  |  Propiedades  |  Métodos  |  Representación OData

Especifica un campo que puede contener varias líneas de texto. Hereda de SP.Field. Valor de tipo de campo = 3.

URI del extremo

http://<url de sitio>/_api/web/fields('<id. de campo>')
http://<url de sitio>/_api/web/lists(guid'<id. de lista>')/fields('<id. de campo>')

Métodos HTTP compatibles

GET  |  POST  |  DELETE  |  MERGE  |  PUT

Ejemplos de solicitudes

Ejemplo de solicitud GET: obtener un campo de texto de varias líneas

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')",
  type: "GET",
  headers: { "accept": "application/json;odata=verbose" },
  success: successHandler,
  error: errorHandler
});

O bien, puede utilizar el método GetByInternalNameOrTitle o GetByTitle del recurso FieldCollection para obtener un campo por su nombre o título interno (distingue mayúsculas de minúsculas). Ejemplo: …/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')/fields/getbytitle('Start Date').

Ejemplo de solicitud POST: crear un campo de texto de varias líneas

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields",
  type: "POST",
  data: "{ '__metadata': { 'type': 'SP.FieldMultiLineText' }, 'FieldTypeKind': 3,
    'Title': 'Justification', 'NumberOfLines': 8 }",
  headers: { 
    "X-RequestDigest": <form digest value>,
    "accept": "application/json;odata=verbose",
    "content-type": "application/json;odata=verbose",
    "content-length": <length of body data>
  },
  success: successHandler,
  error: errorHandler
});

Consulte Métodos de FieldCollection para conocer otras maneras de crear un campo.

Ejemplo de solicitud MERGE: cambiar un campo de texto de varias líneas

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')",
  type: "POST",
  data: "{ '__metadata': { 'type': 'SP.FieldMultiLineText' }, 'RichText': true }",
  headers: {
    "X-RequestDigest": <form digest value>,
    "content-type": "application/json;odata=verbose",
    "content-length": <length of body data>,
    "X-HTTP-Method": "MERGE"
  },
  success: successHandler,
  error: errorHandler
});

Consulte Notas de implementación para obtener información acerca de cómo especificar el tipo de campo en una solicitud MERGE o PUT.

Ejemplo de solicitud DELETE: eliminar un campo de texto de varias líneas

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')",
  type: "POST",
  headers: { 
    "X-RequestDigest": <form digest value>,
    "X-HTTP-Method": "DELETE"
  },
  success: successHandler,
  error: errorHandler
});

Propiedades FieldMultiLineText

Para obtener una propiedad, envíe una solicitud GET al extremo de la propiedad, tal como se muestra en el siguiente ejemplo.

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')/<property name>",
  type: "GET",
  headers: { "accept": "application/json;odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Propiedad

Tipo

L/E

Devuelta con recurso

Descripción

Consulte Propiedades de campo para conocer las propiedades que se heredan de SP.Field.

AllowHyperlink

Boolean

LE

Obtiene o establece un valor que especifica si se permite un hipervínculo como un valor del campo.

AppendOnly

Boolean

LE

Obtiene o establece un valor que especifica si todos los cambios en el valor del campo se muestran en los formularios de lista.

NumberOfLines

Int32

LE

Obtiene o establece un valor que especifica la cantidad de líneas de texto que se mostrarán en el campo.

RestrictedMode

Boolean

LE

Obtiene o establece un valor que especifica si el campo admite un subconjunto de formato enriquecido.

RichText

Boolean

LE

Obtiene o establece un valor que especifica si el campo admite el formato enriquecido.

WikiLinking

Boolean

L

Obtiene un valor que especifica si se admite un mecanismo específico de implementación para vincular páginas wiki.

Métodos FieldMultiLineText

Los métodos se heredan de SP.Field.

DeleteObject  (o envíe una solicitud DELETE al extremo de campo)
SetShowInDisplayForm

SetShowInEditForm
SetShowInNewForm

Representación OData

El siguiente ejemplo representa un recurso SP.FieldMultiLineText en formato JSON.

    {"d":{
      "__metadata":{
        "id":"Web/Lists(guid'47f89cf2-359d-4792-9dc4-8da877a5050a')/Fields(guid'c9569638-28a9-498d-9ed7-8151f54da247')",
        "uri":"http://<site url>/_api/Web/Lists(guid'47f89cf2-359d-4792-9dc4-8da877a5050a')/Fields(guid'c9569638-28a9-498d-9ed7-8151f54da247')",
        "type":"SP.FieldMultiLineText"
      },
      "CanBeDeleted":true,
      "DefaultValue":null,
      "Description":"",
      "Direction":"none",
      "EnforceUniqueValues":false,
      "EntityPropertyName":"Justification",
      "Filterable":false,
      "FromBaseType":false,
      "Group":"Custom Columns",
      "Hidden":false,
      "Id":"c9569638-28a9-498d-9ed7-8151f54da247",
      "Indexed":false,
      "InternalName":"Justification",
      "JSLink":"clienttemplates.js",
      "ReadOnlyField":false,
      "Required":false,
      "SchemaXml":"<Field DisplayName=\"Justification\" Type=\"Note\" Required=\"FALSE\" ID=\"{c9569638-28a9-498d-9ed7-8151f54da247}\" SourceID=\"{47f89cf2-359d-4792-9dc4-8da877a5050a}\" StaticName=\"Justification\" Name=\"Justification\" ColName=\"ntext8\" RowOrdinal=\"0\" NumLines=\"8\" Version=\"3\" AllowHyperlink=\"TRUE\" RichText=\"TRUE\" />",
      "Scope":"/Lists/Team tasks",
      "Sealed":false,
      "Sortable":false,
      "StaticName":"Justification",
      "Title":"Justification",
      "FieldTypeKind":3,
      "TypeAsString":"Note",
      "TypeDisplayName":"Multiple lines of text",
      "TypeShortDescription":"Multiple lines of text",
      "ValidationFormula":null,
      "ValidationMessage":null,
      "AllowHyperlink":false,
      "AppendOnly":false,
      "NumberOfLines":8,
      "RestrictedMode":true,
      "RichText":true,
      "WikiLinking":false
    }}

Recursos FieldNumber y FieldCurrency

URI del extremo  |  Propiedades  |  Métodos  |  Representación OData

Recurso

Descripción

Valor de tipo de campo

FieldNumber

Especifica un campo que contiene valores numéricos. Hereda de SP.Field.

9

FieldCurrency

Especifica un campo que contiene valores de moneda. Hereda de SP.FieldNumber.

10

URI del extremo

http://<url de sitio>/_api/web/fields('<id. de campo>')
http://<url de sitio>/_api/web/lists(guid'<id. de lista>')/fields('<id. de campo>')

Métodos HTTP compatibles

GET  |  POST  |  DELETE  |  MERGE  |  PUT

Ejemplos de solicitudes

Ejemplo de solicitud GET: obtener un campo numérico o de moneda

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')",
  type: "GET",
  headers: { "accept": "application/json;odata=verbose" },
  success: successHandler,
  error: errorHandler
});

O bien, puede utilizar el método GetByInternalNameOrTitle o GetByTitle del recurso FieldCollection para obtener un campo por su nombre o título interno (distingue mayúsculas de minúsculas). Ejemplo: …/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')/fields/getbytitle('Start Date').

Ejemplo de solicitud POST: crear un campo numérico

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields",
  type: "POST",
  data: "{ '__metadata': { 'type': 'SP.FieldNumber' }, 'FieldTypeKind': 9, 'Title': 'Target',
    'Minimum Value': 1 }",
  headers: { 
    "X-RequestDigest": <form digest value>,
    "accept": "application/json;odata=verbose",
    "content-type": "application/json;odata=verbose",
    "content-length": <length of body data>
  },
  success: successHandler,
  error: errorHandler
});

Ejemplo de solicitud POST: crear un campo de moneda

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields",
  type: "POST",
  data: "{ '__metadata': { 'type': 'SP.FieldCurrency' }, 'FieldTypeKind': 10, 'Title': 'Est Cost',
    'CurrencyLocaleId': 2058, 'Minimum Value': 0 }",
  headers: { 
    "X-RequestDigest": <form digest value>,
    "accept": "application/json;odata=verbose",
    "content-type": "application/json;odata=verbose",
    "content-length": <length of body data>
  },
  success: successHandler,
  error: errorHandler
});

Consulte Métodos de FieldCollection para conocer otras maneras de crear un campo.

Ejemplo de solicitud MERGE: cambiar un campo numérico o de moneda

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')",
  type: "POST",
  data: "{ '__metadata': { 'type': 'SP.FieldNumber' }, 'Minimum Value': 0, 'Maximum Value': 10000 }",
  headers: { 
    "X-RequestDigest": <form digest value>,
    "content-type": "application/json;odata=verbose",
    "content-length": <length of body data>,
    "X-HTTP-Method": "MERGE"
  },
  success: successHandler,
  error: errorHandler
});

Consulte Notas de implementación para obtener información acerca de cómo especificar el tipo de campo en una solicitud MERGE o PUT.

Ejemplo de la solicitud DELETE: eliminar un campo numérico o de moneda

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')",
  type: "POST",
  headers: { 
    "X-RequestDigest": <form digest value>,
    "X-HTTP-Method": "DELETE"
  },
  success: successHandler,
  error: errorHandler
});

Propiedades FieldNumber y FieldCurrency

Para obtener una propiedad, envíe una solicitud GET al extremo de la propiedad, tal como se muestra en el siguiente ejemplo.

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')/<property name>",
  type: "GET",
  headers: { "accept": "application/json;odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Propiedad

Tipo

L/E

Devuelta con recurso

Descripción

Consulte Propiedades de campo para las propiedades que se heredan de SP.Field.
Un * indica que la propiedad no se heredó de FieldNumber.

CurrencyLocaleId*

Int32

LE

Obtiene o establece un valor que especifica el identificador de configuración regional (LCID) usado para dar formato al valor del campo. Consulte una lista de identificadores de configuración regional.
*Solo se aplica a FieldCurrency.

MaximumValue

Double

LE

Obtiene o establece un valor que especifica el valor mínimo permitido para el campo.

MinimumValue

Double

LE

Obtiene o establece un valor que especifica el valor mínimo permitido para el campo.

Métodos FieldNumber y FieldCurrency

Los métodos se heredan de SP.Field.

DeleteObject  (o envíe una solicitud DELETE al extremo de campo)
SetShowInDisplayForm

SetShowInEditForm
SetShowInNewForm

Representación OData

El siguiente ejemplo representa un recurso SP.FieldNumber en formato JSON.

    {"d":{
      "__metadata":{
        "id":"Web/Lists(guid'b784e682-3373-4c29-b3c2-373bdb71ce93')/Fields(guid'6b98a3a1-0b14-4495-b184-4de33c32de92')",
        "uri":"http://<site url>/_api/Web/Lists(guid'b784e682-3373-4c29-b3c2-373bdb71ce93')/Fields(guid'6b98a3a1-0b14-4495-b184-4de33c32de92')",
        "type":"SP.FieldNumber"
      },
      "CanBeDeleted":true,
      "DefaultValue":null,
      "Description":"",
      "Direction":"none",
      "EnforceUniqueValues":false,
      "EntityPropertyName":"Target",
      "Filterable":true,
      "FromBaseType":false,
      "Group":"Custom Columns",
      "Hidden":false,
      "Id":"6b98a3a1-0b14-4495-b184-4de33c32de92",
      "Indexed":false,
      "InternalName":"Target",
      "JSLink":"clienttemplates.js",
      "ReadOnlyField":false,
      "Required":false,
      "SchemaXml":"<Field DisplayName=\"Target\" Type=\"Number\" Required=\"FALSE\" ID=\"{6b98a3a1-0b14-4495-b184-4de33c32de92}\" SourceID=\"{b784e682-3373-4c29-b3c2-373bdb71ce93}\" StaticName=\"Target\" Name=\"Target\" ColName=\"float1\" RowOrdinal=\"0\" Min=\"1\" Version=\"1\" />",
      "Scope":"/Lists/Targets",
      "Sealed":false,
      "Sortable":true,
      "StaticName":"Target",
      "Title":"Target",
      "FieldTypeKind":9,
      "TypeAsString":"Number",
      "TypeDisplayName":"Number",
      "TypeShortDescription":"Number (1, 1.0, 100)",
      "ValidationFormula":null,
      "ValidationMessage":null,
      "MaximumValue":1.7976931348623157e+308,
      "MinimumValue":1
    }}

El siguiente ejemplo representa un recurso SP.FieldCurrency en formato JSON.

    {"d":{
      "__metadata":{
        "id":"Web/Lists(guid'b784e682-3373-4c29-b3c2-373bdb71ce93')/Fields(guid'63ea3717-a47f-4cec-858d-7fcae10de409')",
        "uri":"http://<site url>/_api/Web/Lists(guid'b784e682-3373-4c29-b3c2-373bdb71ce93')/Fields(guid'63ea3717-a47f-4cec-858d-7fcae10de409')",
        "type":"SP.FieldCurrency"
      },
      "CanBeDeleted":true,
      "DefaultValue":null,
      "Description":"",
      "Direction":"none",
      "EnforceUniqueValues":false,
      "EntityPropertyName":"Est_x0020_Cost",
      "Filterable":true,
      "FromBaseType":false,
      "Group":"Custom Columns",
      "Hidden":false,
      "Id":"63ea3717-a47f-4cec-858d-7fcae10de409",
      "Indexed":false,
      "InternalName":"Est_x0020_Cost",
      "JSLink":"clienttemplates.js",
      "ReadOnlyField":false,
      "Required":false,
      "SchemaXml":"<Field DisplayName=\"Est Cost\" Type=\"Currency\" Required=\"FALSE\" ID=\"{63ea3717-a47f-4cec-858d-7fcae10de409}\" SourceID=\"{b784e682-3373-4c29-b3c2-373bdb71ce93}\" StaticName=\"Est_x0020_Cost\" Name=\"Est_x0020_Cost\" ColName=\"float3\" RowOrdinal=\"0\" LCID=\"2058\" Min=\"0\" Version=\"1\" />",
      "Scope":"/Lists/Targets",
      "Sealed":false,
      "Sortable":true,
      "StaticName":"Est_x0020_Cost",
      "Title":"Est Cost",
      "FieldTypeKind":10,
      "TypeAsString":"Currency",
      "TypeDisplayName":"Currency",
      "TypeShortDescription":"Currency ($, ¥, €)",
      "ValidationFormula":null,
      "ValidationMessage":null,
      "MaximumValue":1.7976931348623157e+308,
      "MinimumValue": 0,
      "CurrencyLocaleId":2058
    }}

Recurso FieldText

URI del extremo  |  Propiedades  |  Métodos  |  Representación OData

Especifica un campo que contiene una sola línea de texto. Hereda de SP.Field. Valor de tipo de campo = 2.

URI del extremo

http://<url de sitio>/_api/web/fields('<id. de campo>')
http://<url de sitio>/_api/web/lists(guid'<id. de lista>')/fields('<id. de campo>')

Métodos HTTP compatibles

GET  |  POST  |  DELETE  |  MERGE  |  PUT

Ejemplos de solicitudes

Ejemplo de solicitud GET: obtener un campo de texto

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')",
  type: "GET",
  headers: { "accept": "application/json;odata=verbose" },
  success: successHandler,
  error: errorHandler
});

O bien, puede utilizar el método GetByInternalNameOrTitle o GetByTitle del recurso FieldCollection para obtener un campo por su nombre o título interno (distingue mayúsculas de minúsculas). Ejemplo: …/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')/fields/getbytitle('Start Date').

Ejemplo de solicitud POST: crear un campo de texto

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields",
  type: "POST",
  data: "{ '__metadata': { 'type': 'SP.FieldText' }, 'FieldTypeKind': 2,
    'Title': 'Project Name', 'MaxLength': '22' }",
  headers: { 
    "X-RequestDigest": <form digest value>,
    "accept": "application/json;odata=verbose",
    "content-type": "application/json;odata=verbose",
    "content-length": <length of body data>
  },
  success: successHandler,
  error: errorHandler
});

Consulte Métodos de FieldCollection para conocer otras maneras de crear un campo.

Ejemplo de solicitud MERGE: cambiar un campo de texto

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')",
  type: "POST",
  data: "{ '__metadata': { 'type': 'SP.FieldText' }, 'Title': 'Code Name', 'MaxLength': '15' }",
  headers: { 
    "X-RequestDigest": <form digest value>,
    "content-type": "application/json;odata=verbose",
    "content-length": <length of body data>,
    "X-HTTP-Method": "MERGE"
  },
  success: successHandler,
  error: errorHandler
});

Consulte Notas de implementación para obtener información acerca de cómo especificar el tipo de campo en una solicitud MERGE o PUT.

Ejemplo de solicitud DELETE: eliminar un campo de texto

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')",
  type: "POST",
  headers: { 
    "X-RequestDigest": <form digest value>,
    "X-HTTP-Method": "DELETE"
  },
  success: successHandler,
  error: errorHandler
});

Propiedades FieldText

Para obtener una propiedad, envíe una solicitud GET al extremo de la propiedad, tal como se muestra en el siguiente ejemplo.

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')/<property name>",
  type: "GET",
  headers: { "accept": "application/json;odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Propiedad

Tipo

L/E

Devuelta con recurso

Descripción

Consulte Propiedades de campo para conocer las propiedades que se heredan de SP.Field.

MaxLength

Int32

LE

Obtiene o establece un valor que especifica el número máximo de caracteres permitidos en el valor del campo.

Métodos FieldText

Los métodos se heredan de SP.Field.

DeleteObject  (o envíe una solicitud DELETE al extremo de campo)
SetShowInDisplayForm

SetShowInEditForm
SetShowInNewForm

Representación OData

El siguiente ejemplo representa un recurso SP.FieldText en formato JSON.

    {"d":{
      "__metadata":{,
        "id":"Web/Lists(guid'47f89cf2-359d-4792-9dc4-8da877a5050a')/Fields(guid'bab9754a-3779-4862-8a8f-efcfef4fe073')",
        "uri":"http://<site url>/_api/Web/Lists(guid'47f89cf2-359d-4792-9dc4-8da877a5050a')/Fields(guid'bab9754a-3779-4862-8a8f-efcfef4fe073')",
        "type":"SP.FieldText"
      },
      "CanBeDeleted":true,
      "DefaultValue":null,
      "Description":"",
      "Direction":"none",
      "EnforceUniqueValues":false,
      "EntityPropertyName":"Project_x0020_Name",
      "Filterable":true,
      "FromBaseType":false,
      "Group":"Custom Columns",
      "Hidden":false,
      "Id":"bab9754a-3779-4862-8a8f-efcfef4fe073",
      "Indexed":false,
      "InternalName":"Project_x0020_Name",
      "JSLink":"clienttemplates.js",
      "ReadOnlyField":false,
      "Required":false,
      "SchemaXml":"<Field DisplayName=\"Project Name\" Type=\"Text\" Required=\"FALSE\" ID=\"{bab9754a-3779-4862-8a8f-efcfef4fe073}\" SourceID=\"{47f89cf2-359d-4792-9dc4-8da877a5050a}\" StaticName=\"Project_x0020_Name\" Name=\"Project_x0020_Name\" ColName=\"nvarchar5\" RowOrdinal=\"0\" MaxLength=\"22\" Version=\"1\" />",
      "Scope":"/Lists/Team tasks",
      "Sealed":false,
      "Sortable":true,
      "StaticName":"Project_x0020_Name",
      "Title":"Project Name",
      "FieldTypeKind":2,
      "TypeAsString":"Text",
      "TypeDisplayName":"Single line of text",
      "TypeShortDescription":"Single line of text",
      "ValidationFormula":null,
      "ValidationMessage":null,
      "MaxLength":22
    }}

Recurso FieldUrl

URI del extremo  |  Propiedades  |  Métodos  |  Representación OData

Especifica un campo que contiene una dirección URL. Hereda de SP.Field. Valor de tipo de campo = 11.

URI del extremo

http://<url de sitio>/_api/web/fields('<id. de campo>')
http://<url de sitio>/_api/web/lists(guid'<id. de lista>')/fields('<id. de campo>')

Métodos HTTP compatibles

GET  |  POST  |  DELETE  |  MERGE  |  PUT

Ejemplos de solicitudes

Ejemplo de solicitud GET: obtener un campo URL

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')",
  type: "GET",
  headers: { "accept": "application/json;odata=verbose" },
  success: successHandler,
  error: errorHandler
});

O bien, puede utilizar el método GetByInternalNameOrTitle o GetByTitle del recurso FieldCollection para obtener un campo por su nombre o título interno (distingue mayúsculas de minúsculas). Ejemplo: …/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')/fields/getbytitle('Start Date').

Ejemplo de solicitud POST: crear un campo de URL

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields",
  type: "POST",
  data: "{ '__metadata': { 'type': 'SP.FieldUrl' }, 'FieldTypeKind': 11,
    'Title': 'Avatar', 'DisplayFormat': 1 }",
  headers: { 
    "X-RequestDigest": <form digest value>,
    "accept": "application/json;odata=verbose",
    "content-type": "application/json;odata=verbose",
    "content-length": <length of body data>
  },
  success: successHandler,
  error: errorHandler
});

Consulte Métodos de FieldCollection para conocer otras maneras de crear un campo.

Ejemplo de solicitud MERGE: cambiar un campo URL

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')",
  type: "POST",
  data: "{ '__metadata': { 'type': 'SP.FieldUrl' }, 'Title': 'Team pics', 'DisplayFormat': 0 }",
  headers: { 
    "X-RequestDigest": <form digest value>,
    "content-type": "application/json;odata=verbose",
    "content-length": <length of body data>,
    "X-HTTP-Method": "MERGE"
  },
  success: successHandler,
  error: errorHandler
});

Consulte Notas de implementación para obtener información acerca de cómo especificar el tipo de campo en una solicitud MERGE o PUT.

Ejemplo de solicitud DELETE: eliminar un campo URL

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')",
  type: "POST",
  headers: { 
    "X-RequestDigest": <form digest value>,
    "X-HTTP-Method": "DELETE"
  },
  success: successHandler,
  error: errorHandler
});

Propiedades FieldUrl

Para obtener una propiedad, envíe una solicitud GET al extremo de la propiedad, tal como se muestra en el siguiente ejemplo.

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')/<property name>",
  type: "GET",
  headers: { "accept": "application/json;odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Propiedad

Tipo

L/E

Devuelta con recurso

Descripción

Consulte Propiedades de campo para conocer las propiedades que se heredan de SP.Field.

DisplayFormat

Int32

LE

Obtiene o establece un valor que especifica el formato de presentación del valor del campo. Representa un valor UrlFieldFormatType: Hyperlink = 0, Image = 1.

Métodos FieldUrl

Los métodos se heredan de SP.Field.

DeleteObject  (o envíe una solicitud DELETE al extremo de campo)
SetShowInDisplayForm

SetShowInEditForm
SetShowInNewForm

Representación OData

El siguiente ejemplo representa un recurso SP.FieldUrl en formato JSON.

    {"d":{
      "__metadata":{
        "id":"Web/Lists(guid'47f89cf2-359d-4792-9dc4-8da877a5050a')/Fields(guid'ac80888e-9373-4886-8496-2ee2461cdf03')",
        "uri":"http://<site url>/_api/Web/Lists(guid'47f89cf2-359d-4792-9dc4-8da877a5050a')/Fields(guid'ac80888e-9373-4886-8496-2ee2461cdf03')",
        "type":"SP.FieldUrl"
      },
      "CanBeDeleted":true,
      "DefaultValue":null,
      "Description":"",
      "Direction":"none",
      "EnforceUniqueValues":false,
      "EntityPropertyName":"Avatar",
      "Filterable":false,
      "FromBaseType":false,
      "Group":"Custom Columns",
      "Hidden":false,
      "Id":"ac80888e-9373-4886-8496-2ee2461cdf03",
      "Indexed":false,
      "InternalName":"Avatar",
      "JSLink":"clienttemplates.js",
      "ReadOnlyField":false,
      "Required":false,
      "SchemaXml":"<Field DisplayName=\"Avatar\" Type=\"URL\" Required=\"FALSE\" ID=\"{ac80888e-9373-4886-8496-2ee2461cdf03}\" SourceID=\"{47f89cf2-359d-4792-9dc4-8da877a5050a}\" StaticName=\"Avatar\" Name=\"Avatar\" ColName=\"nvarchar13\" RowOrdinal=\"0\" ColName2=\"nvarchar14\" RowOrdinal2=\"0\" Format=\"Image\" Version=\"1\" />",
      "Scope":"/Lists/Team tasks",
      "Sealed":false,
      "Sortable":true,
      "StaticName":"Avatar",
      "Title":"Avatar",
      "FieldTypeKind":11,
      "TypeAsString":"URL",
      "TypeDisplayName":"Hyperlink or Picture",
      "TypeShortDescription":"Hyperlink or Picture",
      "ValidationFormula":null,
      "ValidationMessage":null,
      "DisplayFormat":1
    }}

Notas de implementación

Para cambiar una propiedad heredada, el valor type de los datos de cuerpo pueden especificar el tipo de campo principal que define al campo o el tipo de campo secundario que lo hereda. Por ejemplo, los siguientes datos de cuerpo cambian la propiedad Title para cualquier campo derivado de SP.Field: "{ '__metadata': { 'type': 'SP.Field' }, 'Title': 'Comments' }". Sin embargo, para cambiar una propiedad no heredada, debe especificar el tipo de campo que contiene a la propiedad. Por ejemplo, los siguientes datos de cuerpo especifican el tipo SP.FieldMultiLineText porque también cambian la propiedad NumberOfLines: "{ '__metadata': { 'type': 'SP.FieldMultiLineText' }, 'Title': 'Comments', 'NumberOfLines': 6 }"

Recursos adicionales