getUserChars

Obtém uma lista dos caracteres usados em um campo específico.

Sintaxe

Tipos de usuário autorizados

  • IpsAdmin
  • IpsCompanyAdmin
  • TrialSiteAdmin
  • ImagePortalAdmin

Parâmetros

Entrada (getUserCharsParam)

Nome Tipo Obrigatório Descrição
*charField* xsd:string Sim Determina o Estado da lixeira a ser procurado.
*includeInative* xsd:boolean Sim Incluir ou excluir usuários inativos. Usuários de Administração não IPS devem ser membros ativos de pelo menos uma empresa para serem autorizados a fazer chamadas de API. Uma falha de autorização será retornada se o usuário não tiver associações ativas à empresa.
*includeInvalid* xsd:boolean Não Incluir ou excluir usuários inválidos.
*companyHandleArray* types:HandleArray Não Filtre os resultados com base na empresa.
*groupHandleArray* types:HandleArray Não Filtra os resultados com base em grupos.
*userRoleArray* types:StringArray Não Filtra os resultados com base na função do usuário.
*numChars* xsd:int Não Habilitar > 1 caractere.

Saída (getUserCharsReturn)

Nome Tipo Obrigatório Descrição
*userCharsArray* types:StringArray Sim Uma matriz de prefixos de caracteres.

Exemplos

Este exemplo de código retorna:

  • Primeiros caracteres dos últimos nomes dos usuários de uma empresa específica.
  • Um conjunto de grupos.
  • Um conjunto de funções de usuário.

A constante de string Campos de filtro de caractere do usuário determina o tipo de caracteres do usuário retornados.

Solicitação

<ns1:getUserCharsParam xmlns:ns1="http://www.scene7.com/IpsApi/xsd">
   <ns1:charField>LastName</ns1:charField>
   <ns1:includeInvalid>false</ns1:includeInvalid>
   <ns1:companyHandleArray>
      <ns1:items>47</ns1:items>
   </ns1:companyHandleArray>
</ns1:getUserCharsParam>

Resposta

<getUserCharsReturn xmlns="http://www.scene7.com/IpsApi/xsd">
   <userCharsArray>
      <items>b</items>
      <items>c</items>
      <items>d</items>
   </userCharsArray>
</getUserCharsReturn>

Nesta página

Adobe Summit Banner

A virtual event April 27-28.

Expand your skills and get inspired.

Register for free
Adobe Summit Banner

A virtual event April 27-28.

Expand your skills and get inspired.

Register for free
Adobe Maker Awards Banner

Time to shine!

Apply now for the 2021 Adobe Experience Maker Awards.

Apply now
Adobe Maker Awards Banner

Time to shine!

Apply now for the 2021 Adobe Experience Maker Awards.

Apply now