Referência da API REST de campos
Saiba mais sobre os recursos relacionados ao campo e pontos de extremidade em SharePoint API REST.
Última alteração: segunda-feira, 9 de março de 2015
Aplica-se a: apps for SharePoint | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013
Sobre os exemplos de solicitação neste artigo
Os exemplos neste artigo usam solicitações de AJAX jQuery. Antes de tentar usar os exemplos, faça o seguinte:
Alterar <site url> e outros dados de espaço reservado como qualquer IDs, nomes ou caminhos de entidades de SharePoint.
Se você estiver usando a biblioteca entre domínios, você precisará alterar o formato de solicitação. Por exemplo, ele pode parecer com o seguinte.
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 });
Se você estiver usando OAuth, adicione um cabeçalho de Authorization ("Authorization": "Bearer " + <access token>) para enviar o token de acesso OAuth.
Remova as quebras de linha os valores de propriedade url e data nos exemplos a solicitação. Quebras de linha são adicionadas aos exemplos para facilitar a leitura.
Se desejar que o servidor retorne respostas no formato Atom, remova o cabeçalho "accept": "application/json; odata=verbose" .
Consulte solicitações como REST diferem pelo ambiente para obter mais informações sobre como alterar as solicitações. Consulte os recursos adicionais para obter links para obter mais informações sobre como usar o serviço REST SharePoint, OAuth e a biblioteca entre domínios.
Dica
O serviço REST SharePoint Online dá suporte para a combinação de várias solicitações em uma única chamada do serviço, usando a opção de consulta OData $batch. Para obter detalhes e links para exemplos de códigos, confira Fazem solicitações de lote com as APIs REST. Ainda não há suporte para essa opção no SharePoint local.
Recursos de campo
URI do ponto de extremidade | Propriedades | Métodos | Representação de OData
Representa um campo em uma lista de SharePoint.
URI do ponto de extremidade
http://<site url>/_api/web/fields('<field id>')
http://<site url>/_api/web/lists(guid'<list id>')/fields('<field id>')
Métodos HTTP com suporte
OBTER | POST | EXCLUIR | MESCLAR | PUT
Exemplos de solicitação
Exemplo de solicitação GET: Obtém um 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
});
Ou então, você pode usar o método GetByTitle da FieldCollection do recurso para obter um campo por seu título (diferencia maiúsculas de minúsculas). Exemplo: …/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')/fields/getbytitle('Start Date').
Exemplo de solicitação POST: Criar um 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
});
Exemplo de solicitação POST: Crie um campo, incluindo o esquema de campo. Para enviar um esquema complexo, você pode usar o 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 os métodos FieldCollection para outras maneiras de criar um campo.
Exemplo de solicitação de mesclagem: Alterar um 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 As notas de implementação para obter informações sobre como especificar o tipo de campo em uma solicitação direta ou PUT.
Exemplo de solicitação de exclusão: Excluir um 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
});
Propriedades do campo
Para obter uma propriedade, envie uma solicitação GET para o ponto de extremidade de propriedade, conforme mostrado no exemplo a seguir.
$.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
});
Propriedade |
Tipo |
GRAVAÇÃO/LEITURA |
Descrição |
|
---|---|---|---|---|
CanBeDeleted |
Boolean |
N |
Sim |
Obtém um valor que especifica se o campo pode ser excluído. |
DefaultValue |
String |
RW |
Sim |
Obtém ou define um valor que especifica o valor padrão para o campo. |
Descrição |
String |
RW |
Sim |
Obtém ou define um valor que especifica a descrição do campo. |
Direction |
String |
RW |
Sim |
Obtém ou define um valor que especifica a ordem de leitura do campo. |
EnforceUniqueValues |
Boolean |
RW |
Sim |
Obtém ou define um valor que especifica se valores de campo exclusivos são exigidos em uma coluna de lista ou biblioteca. |
EntityPropertyName |
String |
N |
Sim |
Obtém o nome da propriedade de entidade para a entidade de item de lista que usa este campo. |
FieldTypeKind |
Int32 |
RW |
Sim |
Obtém ou define um valor que especifica o tipo do campo. Representa um valor de FieldType . Consulte FieldType na referência de modelo de objeto do .NET cliente para obter uma lista de valores de tipo de campo. |
Filtráveis |
Boolean |
N |
Sim |
Obtém um valor que especifica se itens de lista na lista podem ser filtrados pelo valor de campo. |
FromBaseType |
Boolean |
N |
Sim |
Obtém um valor Boolean que indica se o campo deriva de um tipo de campo base. |
Grupo |
String |
RW |
Sim |
Obtém ou define um valor que especifica o grupo de campo. |
Oculto |
Boolean |
RW |
Sim |
Obtém ou define um valor que especifica se o campo está oculto nos modos de exibição de lista e formulários de lista. |
ID |
GUID |
N |
Sim |
Obtém um valor que especifica o identificador de campo. |
Indexada |
Boolean |
RW |
Sim |
Obtém ou define um valor Booliano que especifica se a lista está oculta. |
InternalName |
String |
N |
Sim |
Obtém um valor que especifica o nome interno do campo. |
JSLink |
String |
RW |
Sim |
Obtém ou define o nome de um arquivo JS externo que contenha qualquer lógica de renderização de cliente para campos deste tipo. |
ReadOnlyField |
Boolean |
RW |
Sim |
Obtém ou define um valor que especifica se o valor do campo é somente para leitura. |
Obrigatório |
Boolean |
RW |
Sim |
Obtém ou define um valor que especifica se o campo requer um valor. |
SchemaXml |
String |
RW |
Sim |
Obtém ou define um valor que especifica o esquema de XML que define o campo. |
SchemaXmlWithResourceTokens |
String |
N |
Não |
Obtém o esquema que define o campo e inclui tokens de recurso. |
Escopo |
String |
RW |
Sim |
Obtém um valor que especifica a URL relativa ao servidor da lista ou site a que o campo pertence. |
Lacrados |
Boolean |
RW |
Sim |
Obtém o valor que especifica se as propriedades no campo podem ser alteradas e se o campo pode ser excluído. |
Ordenável |
Boolean |
RW |
Sim |
Obtém um valor que especifica se itens de lista na lista podem ser classificados pelo valor de campo. |
StaticName |
String |
RW |
Sim |
Obtém ou define um valor que especifica um identificador personalizável do campo. |
Title |
String |
RW |
Sim |
Obtém ou define um valor que especifica o nome de exibição de um campo. |
TypeAsString |
String |
RW |
Sim |
Obtém ou define um valor que especifica o tipo do campo. |
TypeDisplayName |
String |
N |
Sim |
Obtém um valor que especifica o nome de exibição para o tipo do campo. |
TypeShortDescription |
String |
N |
Sim |
Obtém um valor que especifica a descrição para o tipo do campo. |
ValidationFormula |
String |
RW |
Sim |
Obtém ou define um valor que especifica os critérios de validação de dados para o valor do campo. |
ValidationMessage |
String |
RW |
Sim |
Obtém ou define um valor que especifica a mensagem de erro retornada quando a validação de dados falha para o campo. |
Métodos de campo
DeleteObject
SetShowInDisplayForm
SetShowInEditForm
SetShowInNewForm
Método DeleteObject
A maneira recomendada para excluir um campo é enviar uma solicitação de DELETE ao ponto de extremidade de recurso Field , conforme mostrado nos exemplos de solicitação de campo.
Método SetShowInDisplayForm
Define o valor da propriedade ShowInDisplayForm para este campo.
ponto de extremidade |
/setshowindisplayform (<boolean>) |
Parâmetros |
Tipo: Boolean |
HTTP method |
postar |
Resposta |
Nenhum |
Exemplo de solicitação
$.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
Define o valor da propriedade ShowInEditForm para este campo.
ponto de extremidade |
/setshowineditform (<boolean>) |
Parâmetros |
Tipo: Boolean |
HTTP method |
postar |
Resposta |
Nenhum |
Exemplo de solicitação
$.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
Define o valor da propriedade ShowInNewForm para este campo.
ponto de extremidade |
/setshowinnewform (<boolean>) |
Parâmetros |
Tipo: Boolean |
HTTP method |
postar |
Resposta |
Nenhum |
Exemplo de solicitação
$.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
});
Representação de OData
O exemplo a seguir representa um campo de recurso no 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=\"https://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
}}
Recurso de FieldCalculated
URI do ponto de extremidade | Propriedades | Métodos | Representação de OData
Especifica um campo calculado. Herda de SP. Campo. Tipo de valor do campo = 17.
URI do ponto de extremidade
http://<site url>web/_api/fields('<field id>')
http://<site url>/_api/web/lists(guid'<list id>')/fields('<field id>')
Métodos HTTP com suporte
OBTER | POST | EXCLUIR | MESCLAR | PUT
Exemplos de solicitação
Exemplo de solicitação GET: Obtenha um 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
});
Ou então, você pode usar o método GetByInternalNameOrTitle ou GetByTitle da FieldCollection do recurso para obter um campo por seu nome interno (diferencia maiúsculas de minúsculas) ou o título. Exemplo: …/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')/fields/getbytitle('Start Date').
Exemplo de solicitação POST: Criar um 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 os métodos FieldCollection para outras maneiras de criar um campo. Consulte as Fórmulas de campo calculado para obter exemplos de fórmulas com suporte.
Exemplo de solicitação de mesclagem: Alterar um 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 As notas de implementação para obter informações sobre como especificar o tipo de campo em uma solicitação direta ou PUT.
Exemplo de solicitação de exclusão: Excluir um 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
});
Propriedades de FieldCalculated
Para obter uma propriedade, envie uma solicitação GET para o ponto de extremidade de propriedade, conforme mostrado no exemplo a seguir.
$.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
});
Métodos de FieldCalculated
Métodos são herdados do SP. Campo.
Ação ExcluirObjeto (ou enviar uma solicitação de exclusão para o ponto de extremidade de campo)
SetShowInDisplayForm
SetShowInEditForm
SetShowInNewForm
Representação de OData
O exemplo a seguir representa uma SP. FieldCalculated recurso no 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 de FieldCollection
URI do ponto de extremidade | Propriedades | Métodos | Representação de OData
Representa uma coleção de recursos Field.
URI do ponto de extremidade
http://<site url>/_api/web/fields
http://<site url>/_api/web/lists(guid'<list id>')/fields
Métodos HTTP com suporte
OBTER | POST
Exemplos de solicitação
Exemplo de solicitação GET: Obtenha todos os campos em uma 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
});
Exemplo de solicitação GET: Obtenha um 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
});
Ou então, você pode usar o método GetByTitle ou GetByInternalNameOrTitle da FieldCollection do recurso para obter um campo por seu nome interno (diferencia maiúsculas de minúsculas) ou o título. Exemplo: …/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')/fields/getbytitle('Assigned To').
Exemplo de solicitação POST: Criar um 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
});
Exemplo de solicitação POST: Crie um campo, incluindo o esquema de campo. Para enviar um esquema complexo, você pode usar o 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 os métodos FieldCollection para outras maneiras de criar um campo. Veja exemplos de solicitação de campo para obter exemplos que mostram como alterar ou excluir um campo.
Propriedades de FieldCollection
Para obter uma propriedade, envie uma solicitação GET para o ponto de extremidade de propriedade, conforme mostrado no exemplo a seguir.
$.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
});
Propriedade |
Tipo |
GRAVAÇÃO/LEITURA |
Descrição |
|
---|---|---|---|---|
SchemaXml |
String |
N |
Não |
Especifica o esquema XML da coleção de campos. |
Métodos de FieldCollection
AddDependentLookupField
AddField
CreateFieldAsXml
GetById
GetByInternalNameOrTitle
GetByTitle
Método AddDependentLookupField
Adiciona um campo de pesquisa secundário que depende de um campo de pesquisa principal para sua relação com a lista de onde ele obtém informações.
ponto de extremidade |
/adddependentlookupfield (displayname, primarylookupfieldid, showfield) |
Parâmetros |
|
HTTP method |
postar |
Resposta |
Tipo: SP. Campo |
Exemplo de solicitação
$.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
Adiciona um campo à coleção de campos.
ponto de extremidade |
/addfield |
Parâmetros |
|
HTTP method |
postar |
Resposta |
Tipo: SP. Campo |
Exemplo de solicitação
$.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
});
Ou então, você pode adicionar um campo, enviando uma solicitação de POST para o ponto de extremidade de recurso FieldCollection , conforme mostrado nos exemplos de solicitação FieldCollection.
Método CreateFieldAsXml
Cria um campo com base no esquema, valor Boolean e opções de campo especificadas.
ponto de extremidade |
/createfieldasxml |
Parâmetros |
|
HTTP method |
postar |
Resposta |
Tipo: SP. Campo |
Exemplo de solicitação
$.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
});
Ou então, você pode adicionar um campo, enviando uma solicitação de POST para o ponto de extremidade de recurso FieldCollection , conforme mostrado nos exemplos de solicitação FieldCollection.
Método GetById
Obtém o campo com a ID especificada.
ponto de extremidade |
/GetByID('<field id>') |
Parâmetros |
Tipo: String |
HTTP method |
Get |
Resposta |
Tipo: SP. Campo |
Exemplo de solicitação
$.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
});
Ou então, você pode apenas passar a identificação do campo para o recurso de FieldCollection . Exemplo: …/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')/fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1').
Método GetByInternalNameOrTitle
Retorna o primeiro objeto de Campo com o título ou nome interno especificado da coleção.
ponto de extremidade |
/getbyinternalnameortitle('<field internal name or title>') |
Parâmetros |
Tipo: String |
HTTP method |
Get |
Resposta |
Tipo: SP. Campo |
Exemplo de solicitação
$.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
Retorna o primeiro objeto de campo na coleção com base no título do campo especificado.
ponto de extremidade |
/getbytitle('<field title>') |
Parâmetros |
Tipo: String |
HTTP method |
Get |
Resposta |
Tipo: SP. Campo |
Exemplo de solicitação
$.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
});
Representação de OData
O exemplo a seguir representa um recurso de FieldCollection no 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="https://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="https://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
},{
...
}]
}}
Recurso de FieldComputed
URI do ponto de extremidade | Propriedades | Métodos | Representação de OData
Representa um campo que depende de outros campos por seu conteúdo, mas pode especificar um padrão de processamento personalizado. Herda de SP. Campo. Tipo de valor do campo = 12.
URI do ponto de extremidade
http://<site url>web/_api/fields('<field id>')
http://<site url>/_api/web/lists(guid'<list id>')/fields('<field id>')
Métodos HTTP com suporte
OBTER | POST | EXCLUIR | MESCLAR | PUT
Exemplos de solicitação
Exemplo de solicitação GET: Obtenha um 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
});
Ou então, você pode usar o método GetByInternalNameOrTitle ou GetByTitle da FieldCollection do recurso para obter um campo por seu nome interno (diferencia maiúsculas de minúsculas) ou o título. Exemplo: …/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')/fields/getbytitle('Start Date').
Exemplo de solicitação POST: Criar um campo calculado usando o 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
});
Depois de criar um campo calculado e especificar o esquema XML, você terá que criar o arquivo de renderização de XSL. Consulte Visão geral do modo de exibição de lista XSLT renderização sistema.
Exemplo de solicitação de mesclagem: Alterar um 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 As notas de implementação para obter informações sobre como especificar o tipo de campo em uma solicitação direta ou PUT.
Exemplo de solicitação de exclusão: Excluir um 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
});
Propriedades de FieldComputed
Para obter uma propriedade, envie uma solicitação GET para o ponto de extremidade de propriedade, conforme mostrado no exemplo a seguir.
$.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
});
Métodos de FieldComputed
Métodos são herdados do SP. Campo.
Ação ExcluirObjeto (ou enviar uma solicitação de exclusão para o ponto de extremidade de campo)
SetShowInDisplayForm
SetShowInEditForm
SetShowInNewForm
Representação de OData
O exemplo a seguir representa uma SP. FieldComputed recurso no 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
}}
Recurso de FieldDateTime
URI do ponto de extremidade | Propriedades | Métodos | Representação de OData
Especifica um campo que contém valores de data e hora. Herda de SP. Campo. Tipo de valor do campo = 4.
URI do ponto de extremidade
http://<site url>web/_api/fields('<field id>')
http://<site url>/_api/web/lists(guid'<list id>')/fields('<field id>')
Métodos HTTP com suporte
OBTER | POST | EXCLUIR | MESCLAR | PUT
Exemplos de solicitação
Exemplo de solicitação GET: Obter um campo de data 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
});
Ou então, você pode usar o método GetByInternalNameOrTitle ou GetByTitle da FieldCollection do recurso para obter um campo por seu nome interno (diferencia maiúsculas de minúsculas) ou o título. Exemplo: …/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')/fields/getbytitle('Start Date').
Exemplo de solicitação POST: Criar um campo de data 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 os métodos FieldCollection para outras maneiras de criar um campo.
Exemplo de solicitação de mesclagem: Alterar um campo de data 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 As notas de implementação para obter informações sobre como especificar o tipo de campo em uma solicitação direta ou PUT.
Exemplo de solicitação de exclusão: Excluir um campo de data 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
});
Propriedades de FieldDateTime
Para obter uma propriedade, envie uma solicitação GET para o ponto de extremidade de propriedade, conforme mostrado no exemplo a seguir.
$.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
});
Métodos de FieldDateTime
Métodos são herdados do SP. Campo.
Ação ExcluirObjeto (ou enviar uma solicitação de exclusão para o ponto de extremidade de campo)
SetShowInDisplayForm
SetShowInEditForm
SetShowInNewForm
Representação de OData
O exemplo a seguir representa uma SP. FieldDateTime recurso no 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 de FieldGeolocation
URI do ponto de extremidade | Propriedades | Métodos | Representação de OData
Representa um campo que contém valores de localização geográfica. Herda de SP. Campo. Tipo de valor do campo = 31.
To learn more about using location fields, see Integrar a funcionalidade de local e o mapa no SharePoint 2013.
URI do ponto de extremidade
http://<site url>web/_api/fields('<field id>')
http://<site url>/_api/web/lists(guid'<list id>')/fields('<field id>')
Métodos HTTP com suporte
OBTER | POST | EXCLUIR | MESCLAR | PUT
Exemplos de solicitação
Exemplo de solicitação GET: Obtém um campo de localização
$.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
});
Ou então, você pode usar o método GetByInternalNameOrTitle ou GetByTitle da FieldCollection do recurso para obter um campo por seu nome interno (diferencia maiúsculas de minúsculas) ou o título. Exemplo: …/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')/fields/getbytitle('Start Date').
Exemplo de solicitação POST: Criar um campo de localização
$.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 os métodos FieldCollection para outras maneiras de criar um campo.
Exemplo de solicitação de mesclagem: Alterar um campo de localização
$.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 As notas de implementação para obter informações sobre como especificar o tipo de campo em uma solicitação direta ou PUT.
Exemplo de solicitação de exclusão: Excluir um campo de localização
$.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
});
Propriedades de FieldGeolocation
Para obter uma propriedade, envie uma solicitação GET para o ponto de extremidade de propriedade, conforme mostrado no exemplo a seguir.
$.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
});
Métodos de FieldGeolocation
Métodos são herdados do SP. Campo.
Ação ExcluirObjeto (ou enviar uma solicitação de exclusão para o ponto de extremidade de campo)
SetShowInDisplayForm
SetShowInEditForm
SetShowInNewForm
Representação de OData
O exemplo a seguir representa uma SP. FieldGeolocation recurso no 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 de FieldGuid
URI do ponto de extremidade | Propriedades | Métodos | Representação de OData
Herda de SP. Campo. Tipo de valor do campo = 14.
URI do ponto de extremidade
http://<site url>web/_api/fields('<field id>')
http://<site url>/_api/web/lists(guid'<list id>')/fields('<field id>')
Métodos HTTP com suporte
OBTER | POST | EXCLUIR | MESCLAR | PUT
Exemplos de solicitação
Exemplo de solicitação GET: Obtém um 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
});
Ou então, você pode usar o método GetByInternalNameOrTitle ou GetByTitle da FieldCollection do recurso para obter um campo por seu nome interno (diferencia maiúsculas de minúsculas) ou o título. Exemplo: …/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')/fields/getbytitle('Start Date').
Exemplo de solicitação POST: Criar um 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 os métodos FieldCollection para outras maneiras de criar um campo.
Exemplo de solicitação de mesclagem: Alterar um 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 As notas de implementação para obter informações sobre como especificar o tipo de campo em uma solicitação direta ou PUT.
Exemplo de solicitação de exclusão: Excluir um 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
});
Propriedades de FieldGuid
Para obter uma propriedade, envie uma solicitação GET para o ponto de extremidade de propriedade, conforme mostrado no exemplo a seguir.
$.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
});
Métodos de FieldGuid
Métodos são herdados do SP. Campo.
Ação ExcluirObjeto (ou enviar uma solicitação de exclusão para o ponto de extremidade de campo)
SetShowInDisplayForm
SetShowInEditForm
SetShowInNewForm
Representação de OData
O exemplo a seguir representa uma SP. FieldGuid recurso no 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 e FieldUser
URI do ponto de extremidade | Propriedades | Métodos | Representação de OData
Recurso |
Descrição |
Valor de FieldType |
---|---|---|
FieldLookup |
Especifica um campo de pesquisa. Herda de SP. Campo. |
7 |
FieldUser |
Especifica um campo que contém um usuário. Herda de SP.FieldLookup. |
20 |
URI do ponto de extremidade
http://<site url>web/_api/fields('<field id>')
http://<site url>/_api/web/lists(guid'<list id>')/fields('<field id>')
Métodos HTTP com suporte
OBTER | POST | EXCLUIR | MESCLAR | PUT
Exemplos de solicitação
Exemplo de solicitação GET: Fazer uma pesquisa ou 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
});
Ou então, você pode usar o método GetByInternalNameOrTitle ou GetByTitle da FieldCollection do recurso para obter um campo por seu nome interno (diferencia maiúsculas de minúsculas) ou o título. Exemplo: …/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')/fields/getbytitle('Start Date').
Exemplo de solicitação POST: Crie um campo de pesquisa. Use o método AddField para criar um campo de pesquisa.
$.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
});
Exemplo de solicitação POST: Criar um campo de usuário
$.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 os métodos FieldCollection para outras maneiras de criar um campo.
Exemplo de solicitação de mesclagem: Alterar um campo de pesquisa
$.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 As notas de implementação para obter informações sobre como especificar o tipo de campo em uma solicitação direta ou PUT.
Exemplo de solicitação de exclusão: Excluir um campo de pesquisa ou de usuário
$.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
});
Propriedades FieldLookup e FieldUser
Para obter uma propriedade, envie uma solicitação GET para o ponto de extremidade de propriedade, conforme mostrado no exemplo a seguir.
$.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
});
Métodos FieldLookup e FieldUser
Métodos são herdados do SP. Campo.
Ação ExcluirObjeto (ou enviar uma solicitação de exclusão para o ponto de extremidade de campo)
SetShowInDisplayForm
SetShowInEditForm
SetShowInNewForm
Representação de OData
O exemplo a seguir representa uma SP. FieldLookup recurso no 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
}}
O exemplo a seguir representa uma SP. FieldUser recurso no 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 e FieldRatingScale
URI do ponto de extremidade | Propriedades | Métodos | Representação de OData
Recurso |
Descrição |
Valor de FieldType |
---|---|---|
FieldMultiChoice |
Especifica um campo que contém um ou mais valores de uma coleção de valores especificada. Herda de SP. Campo. |
15 |
FieldChoice |
Representa um controle de campo de opção. Herda de SP.FieldMultiChoice. |
6 |
FieldRatingScale |
Especifica o campo que contém valores de escala de classificação para uma lista de pesquisas. Herda de SP.FieldMultiChoice. Também chamado de GridChoice. |
16 |
URI do ponto de extremidade
http://<site url>web/_api/fields('<field id>')
http://<site url>/_api/web/lists(guid'<list id>')/fields('<field id>')
Métodos HTTP com suporte
OBTER | POST | EXCLUIR | MESCLAR | PUT
Exemplos de solicitação
Exemplo de solicitação GET: Obtém um 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
});
Ou então, você pode usar o método GetByInternalNameOrTitle ou GetByTitle da FieldCollection do recurso para obter um campo por seu nome interno (diferencia maiúsculas de minúsculas) ou o título. Exemplo: …/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')/fields/getbytitle('Status').
Exemplo de solicitação POST: Criar um campo de escolha de vários
$.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
});
Exemplo de solicitação POST: Criar um campo de escolha
$.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
});
Exemplo de solicitação POST: Criar um campo de escala de classificação
$.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 os métodos FieldCollection para outras maneiras de criar um campo.
Exemplo de solicitação de mesclagem: Alterar um campo de escolha
$.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 As notas de implementação para obter informações sobre como especificar o tipo de campo em uma solicitação direta ou PUT.
Exemplo de solicitação de exclusão: Excluir um 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
});
Propriedades FieldMultiChoice, FieldChoice e FieldRatingScale
Para obter uma propriedade, envie uma solicitação GET para o ponto de extremidade de propriedade, conforme mostrado no exemplo a seguir.
$.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
});
Métodos FieldMultiChoice, FieldChoice e FieldRatingScale
Métodos são herdados do SP. Campo.
Ação ExcluirObjeto (ou enviar uma solicitação de exclusão para o ponto de extremidade de campo)
SetShowInDisplayForm
SetShowInEditForm
SetShowInNewForm
Representações OData
O exemplo a seguir representa uma SP. FieldMultiChoice recurso no 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"]}
}}
O exemplo a seguir representa uma SP. FieldChoice recurso no 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
}}
O exemplo a seguir representa uma SP. FieldRatingScale recurso no 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 de FieldMultiLineText
URI do ponto de extremidade | Propriedades | Métodos | Representação de OData
Especifica um campo que pode conter múltiplas linhas de texto. Herda de SP. Campo. Tipo de valor do campo = 3.
URI do ponto de extremidade
http://<site url>web/_api/fields('<field id>')
http://<site url>/_api/web/lists(guid'<list id>')/fields('<field id>')
Métodos HTTP com suporte
OBTER | POST | EXCLUIR | MESCLAR | PUT
Exemplos de solicitação
Exemplo de solicitação GET: Obter um campo de texto várias linhas
$.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
});
Ou então, você pode usar o método GetByInternalNameOrTitle ou GetByTitle da FieldCollection do recurso para obter um campo por seu nome interno (diferencia maiúsculas de minúsculas) ou o título. Exemplo: …/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')/fields/getbytitle('Start Date').
Exemplo de solicitação POST: Criar um campo de texto várias linhas
$.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 os métodos FieldCollection para outras maneiras de criar um campo.
Exemplo de solicitação de mesclagem: Alterar um campo de texto várias linhas
$.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 As notas de implementação para obter informações sobre como especificar o tipo de campo em uma solicitação direta ou PUT.
Exemplo de solicitação de exclusão: Excluir um campo de texto linha vários
$.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
});
Propriedades de FieldMultiLineText
Para obter uma propriedade, envie uma solicitação GET para o ponto de extremidade de propriedade, conforme mostrado no exemplo a seguir.
$.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
});
Métodos de FieldMultiLineText
Métodos são herdados do SP. Campo.
Ação ExcluirObjeto (ou enviar uma solicitação de exclusão para o ponto de extremidade de campo)
SetShowInDisplayForm
SetShowInEditForm
SetShowInNewForm
Representação de OData
O exemplo a seguir representa uma SP. FieldMultiLineText recurso no 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 de FieldNumber e FieldCurrency
URI do ponto de extremidade | Propriedades | Métodos | Representação de OData
Recurso |
Descrição |
Valor de FieldType |
---|---|---|
FieldNumber |
Especifica um campo que contém valores numéricos. Herda de SP. Campo. |
9 |
FieldCurrency |
Especifica um campo que contém valores de moeda. Herda de SP.FieldNumber. |
10 |
URI do ponto de extremidade
http://<site url>web/_api/fields('<field id>')
http://<site url>/_api/web/lists(guid'<list id>')/fields('<field id>')
Métodos HTTP com suporte
OBTER | POST | EXCLUIR | MESCLAR | PUT
Exemplos de solicitação
Exemplo de solicitação GET: Obtém um campo de número ou moeda
$.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
});
Ou então, você pode usar o método GetByInternalNameOrTitle ou GetByTitle da FieldCollection do recurso para obter um campo por seu nome interno (diferencia maiúsculas de minúsculas) ou o título. Exemplo: …/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')/fields/getbytitle('Start Date').
Exemplo de solicitação POST: Criar um campo de número
$.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
});
Exemplo de solicitação POST: Criar um campo de moeda
$.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 os métodos FieldCollection para outras maneiras de criar um campo.
Exemplo de solicitação de mesclagem: Alterar um campo de número ou moeda
$.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 As notas de implementação para obter informações sobre como especificar o tipo de campo em uma solicitação direta ou PUT.
Exemplo de solicitação de exclusão: Excluir um campo de número ou moeda
$.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
});
Propriedades FieldNumber e FieldCurrency
Para obter uma propriedade, envie uma solicitação GET para o ponto de extremidade de propriedade, conforme mostrado no exemplo a seguir.
$.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
});
Métodos FieldNumber e FieldCurrency
Métodos são herdados do SP. Campo.
Ação ExcluirObjeto (ou enviar uma solicitação de exclusão para o ponto de extremidade de campo)
SetShowInDisplayForm
SetShowInEditForm
SetShowInNewForm
Representação de OData
O exemplo a seguir representa uma SP. FieldNumber recurso no 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
}}
O exemplo a seguir representa uma SP. FieldCurrency recurso no 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 de FieldText
URI do ponto de extremidade | Propriedades | Métodos | Representação de OData
Especifica um campo que contém uma linha de texto única. Herda de SP. Campo. Tipo de valor do campo = 2.
URI do ponto de extremidade
http://<site url>web/_api/fields('<field id>')
http://<site url>/_api/web/lists(guid'<list id>')/fields('<field id>')
Métodos HTTP com suporte
OBTER | POST | EXCLUIR | MESCLAR | PUT
Exemplos de solicitação
Exemplo de solicitação GET: Obtém um 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
});
Ou então, você pode usar o método GetByInternalNameOrTitle ou GetByTitle da FieldCollection do recurso para obter um campo por seu nome interno (diferencia maiúsculas de minúsculas) ou o título. Exemplo: …/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')/fields/getbytitle('Start Date').
Exemplo de solicitação POST: Criar um 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 os métodos FieldCollection para outras maneiras de criar um campo.
Exemplo de solicitação de mesclagem: Alterar um 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 As notas de implementação para obter informações sobre como especificar o tipo de campo em uma solicitação direta ou PUT.
Exemplo de solicitação de exclusão: Excluir um 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
});
Propriedades de FieldText
Para obter uma propriedade, envie uma solicitação GET para o ponto de extremidade de propriedade, conforme mostrado no exemplo a seguir.
$.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
});
Métodos de FieldText
Métodos são herdados do SP. Campo.
Ação ExcluirObjeto (ou enviar uma solicitação de exclusão para o ponto de extremidade de campo)
SetShowInDisplayForm
SetShowInEditForm
SetShowInNewForm
Representação de OData
O exemplo a seguir representa uma SP. FieldText recurso no 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 de FieldUrl
URI do ponto de extremidade | Propriedades | Métodos | Representação de OData
Especifica um campo que contém uma URL. Herda de SP. Campo. Tipo de valor do campo = 11.
URI do ponto de extremidade
http://<site url>web/_api/fields('<field id>')
http://<site url>/_api/web/lists(guid'<list id>')/fields('<field id>')
Métodos HTTP com suporte
OBTER | POST | EXCLUIR | MESCLAR | PUT
Exemplos de solicitação
Exemplo de solicitação GET: Obtém um campo de 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
});
Ou então, você pode usar o método GetByInternalNameOrTitle ou GetByTitle da FieldCollection do recurso para obter um campo por seu nome interno (diferencia maiúsculas de minúsculas) ou o título. Exemplo: …/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')/fields/getbytitle('Start Date').
Exemplo de solicitação POST: Criar um 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 os métodos FieldCollection para outras maneiras de criar um campo.
Exemplo de solicitação de mesclagem: Alterar um campo de 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 As notas de implementação para obter informações sobre como especificar o tipo de campo em uma solicitação direta ou PUT.
Exemplo de solicitação de exclusão: Excluir um campo de 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
});
Propriedades de FieldUrl
Para obter uma propriedade, envie uma solicitação GET para o ponto de extremidade de propriedade, conforme mostrado no exemplo a seguir.
$.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
});
Métodos de FieldUrl
Métodos são herdados do SP. Campo.
Ação ExcluirObjeto (ou enviar uma solicitação de exclusão para o ponto de extremidade de campo)
SetShowInDisplayForm
SetShowInEditForm
SetShowInNewForm
Representação de OData
O exemplo a seguir representa uma SP. FieldUrl recurso no 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
}}
Anotações de implementação
Para alterar uma propriedade herdada, o valor de type nos dados de corpo pode especificar o tipo de campo pai que define o campo ou o tipo de campo filho que herda a ele. Por exemplo, os seguintes dados do corpo altera a propriedade Title de qualquer campo derivado SP. Campo: "{ '__metadata': { 'type': 'SP.Field' }, 'Title': 'Comments' }". No entanto, para alterar uma propriedade que não é herdada, você deve especificar o tipo de campo que contém a propriedade. Por exemplo, os seguintes dados do corpo especificam o tipo de SP.FieldMultiLineText porque ele também altera a propriedade NumberOfLines : "{ '__metadata': { 'type': 'SP.FieldMultiLineText' }, 'Title': 'Comments', 'NumberOfLines': 6 }"