TOTVS Fluig Developer
Ajuda API Guia de estilos Documentação técnica
Resources Data Types Files and Libraries

GroupRest Resource

Group

Available Since
1.5

POST /2.0/groups/create

Create a new Group

Available Since
1.5
Request Body
media type data type description
application/json GroupCreateVO (JSON)

Request JSON (example):


 {
 	"code" : "654654", // code
 	"description" : "description", // description
 	"isInternal" : "true", // is Internal
 }
Response Body
media type data type description
application/json object (JSON) 

 This method just return HTTP 200 status, successful message

	{
		 content: null
		 message: {
			 message: "Grupo  criado com sucesso!"
			 detail: "Grupo  criado com sucesso!"
			 type: "INFO"
		}
	}
Available Since
1.5

POST /2.0/groups/addUsers/{groupCode}

Add list user

Request Parameters
name type description
groupCode path :

15644
Request Body
media type data type description
application/json array of string (JSON)

Request JSON (example):

[ "adm", "user1" ]
Response Body
media type data type description
application/json object (JSON) 
This method just return HTTP 200 status, successful message

 {
 	content: null
 	message: {
 		message: "Usuários adicionados com sucesso ao grupo 99."
 		detail: "Usuários adicionados com sucesso ao grupo 99."
 		type: "INFO"
 	}
 }
 
 @since 1.5
Available Since
1.5.9

GET /2.0/groups/findGroupsByUser/{genericId}

Available Since
1.5.9
Request Parameters
name type description default
genericId path

User's generic indentifier, can be (login, idpId or userCode)

  
pattern query (optional - default = "")
Response Body
media type data type description
application/json object (JSON) 
This method just return HTTP 200 status, successful message

 {
 	 content: null
 	 message: {
 		 message: "OK"
 		 detail: "OK"
 		 type: "INFO"
 	}
 }
Available Since
1.6

GET /2.0/groups/listUsersByGroup/{groupId}

Available Since
1.6
Request Parameters
name type description default constraints
groupId path

Group code to find users

    
limit query (optional - default = "20")
 20 required
offset query (optional - default = "0")
 0 required
orderby query  
pattern query (optional - default = "")
  
Response Body
media type data type description
application/json object (JSON) 
This method just return HTTP 200 status, successful message

 {
 	 content: null
 	 message: {
 		 message: "OK"
 		 detail: "OK"
 		 type: "INFO"
 	 }
 }
Available Since
1.5

GET /2.0/groups/containsUser/{groupCode}/{genericId}

Add list user

Available Since
1.5
Request Parameters
name type description
genericId path :

User's generic indentifier, can be (login, idpId or userCode)
groupCode path :

15644
Response Body
media type data type description
application/json object (JSON) 
This method return boolean: true / false