Resource: FieldGroup

About this resource

Representation of a FieldGroup

Properties

Property	Description	Type
createdOn	Gets the creation datetime in UTC time.	datetime
id	Gets the Id of this field group.	guid
modifiedOn	Gets the last modification datetime in UTC time.	datetime
name	Gets the name of this field group.	string
tag	Gets or sets the value of the Tag for this object. The value of this property has to be valid XML code. This property will not be returned by default. In order to include the property in the response, add a header with the name 'select-fieldgroup' and the value 'Tag' to your request.	string

Relations

Method	Name	Select-key	Resource type	Description
GET	self			Provides a link to this resource.
GET	members	select-FieldGroup: members	FieldDefinitionCollection	Gets or sets the members of this field group.
GET	modifiedby	select-FieldGroup: modifiedby	User	Gets or sets the user that last modified this resource.
GET	createdby	select-FieldGroup: createdby	User	Gets or sets the user that created this resource.

Actions

Method

Action

Description

Response codes

PUT /fieldgroup/{fieldGroupId}

edit

Edits an existing field group

204	Request completed successfully
400	Bad request (in general)
403	Insufficient permissions
404	Field group not found

DELETE /fieldgroup/{fieldGroupId}

delete

Deletes an existing field group

204	Request completed successfully
403	Insufficient permissions
404	Field group not found

Examples

Editing a field group

PUT /fieldgroup/31072990f5ec458a9145a7f9008c1404
{
  "name": "New Group Name",
  "tag": "xml",
  "members": {
    "addOrUpdate": ["1e2c7000-fbe5-4048-9e5c-a7fb00bc103d"]
    "remove": ["c3782d20-fa8b-4f5b-8aba-a7fb00bd09c0","0c655ce8-5b9b-4546-b09d-92c728e03e08"]
  }
}

Deleting a field group

DELETE /fieldgroup/6750869d69e64b6c86b4a7f900898bb4