Web Service: UserTeamAssociationService

Port type UserTeamAssociationServiceInterfaceSource code

1. createUserTeamAssociations
   Source code
   Description:
   Creates new {@link UserTeamAssociation} objects.
   Operation type:
   Request-response. The endpoint receives a message, and sends a correlated message.
   Input:
   createUserTeamAssociationsRequest (wsdlsoap:header, use = literal, part = RequestHeader)Source code
   parameters type createUserTeamAssociations

   Creates new {@link UserTeamAssociation} objects.

   • userTeamAssociations - optional, unbounded; type UserTeamAssociation - extension of abstract type UserRecordTeamAssociation
     {@code UserTeamAssociation} associates a {@link User} with a {@link Team} to provide the user access to the entities that belong to the team.
     {@code UserRecordTeamAssociation} represents the association between a {@link UserRecord} and a {@link Team}.
     • teamId - optional; type long
       The {@link Team#id} of the team.
     • overriddenTeamAccessType - optional; type TeamAccessType - type string with restriction - enum { 'NONE', 'READ_ONLY', 'READ_WRITE' }
       The overridden team access type. This field is {@code null} if team access type is not overridden.
     • defaultTeamAccessType - optional; type TeamAccessType - type string with restriction - enum { 'NONE', 'READ_ONLY', 'READ_WRITE' }
       The default team access type {@link Team#teamAccessType}. This field is read-only and is populated by Google.
     • userId - optional; type long
       Refers to the {@link User#id}.
   Output:
   createUserTeamAssociationsResponse (wsdlsoap:header, use = literal, part = ResponseHeader)Source code
   parameters type createUserTeamAssociationsResponse

   • rval - optional, unbounded; type UserTeamAssociation - extension of abstract type UserRecordTeamAssociation
     {@code UserTeamAssociation} associates a {@link User} with a {@link Team} to provide the user access to the entities that belong to the team.
     {@code UserRecordTeamAssociation} represents the association between a {@link UserRecord} and a {@link Team}.
     • teamId - optional; type long
       The {@link Team#id} of the team.
     • overriddenTeamAccessType - optional; type TeamAccessType - type string with restriction - enum { 'NONE', 'READ_ONLY', 'READ_WRITE' }
       The overridden team access type. This field is {@code null} if team access type is not overridden.
     • defaultTeamAccessType - optional; type TeamAccessType - type string with restriction - enum { 'NONE', 'READ_ONLY', 'READ_WRITE' }
       The default team access type {@link Team#teamAccessType}. This field is read-only and is populated by Google.
     • userId - optional; type long
       Refers to the {@link User#id}.
   Fault:
   ApiException (wsdlsoap:fault, use = literal)Source code
   ApiException type ApiExceptionFault

   Exception class for holding a list of service errors.

   Base class for exceptions.

   • message - optional; type string
     Error message.

   • errors - optional, unbounded; type ApiError
     The API error base class that provides details about an error that occurred while processing a service request.

     The OGNL field path is provided for parsers to identify the request data element that may have caused the error.

     • fieldPath - optional; type string
       The OGNL field path to identify cause of error.
     • fieldPathElements - optional, unbounded; type FieldPathElement
       A parsed copy of the field path. For example, the field path "operations[1].operand" corresponds to this list: {FieldPathElement(field = "operations", index = 1), FieldPathElement(field = "operand", index = null)}.
       A segment of a field path. Each dot in a field path defines a new segment.
       • field - optional; type string
         The name of a field in lower camelcase. (e.g. "biddingStrategy")
       • index - optional; type int
         For list fields, this is a 0-indexed position in the list. Null for non-list fields.
     • trigger - optional; type string
       The data that caused the error.
     • errorString - optional; type string
       A simple string representation of the error and reason.
     List of errors.

   A fault element of type ApiException.
2. getUserTeamAssociationsByStatement
   Source code
   Description:
   Gets a {@link UserTeamAssociationPage} of {@link UserTeamAssociation} objects that satisfy the given {@link Statement#query}. The following fields are supported for filtering:

   PQL Property	Object Property
   {@code userId}	{@link UserTeamAssociation#userId}
   {@code teamId}	{@link UserTeamAssociation#teamId}

   Operation type:
   Request-response. The endpoint receives a message, and sends a correlated message.
   Input:
   getUserTeamAssociationsByStatementRequest (wsdlsoap:header, use = literal, part = RequestHeader)Source code
   parameters type getUserTeamAssociationsByStatement

   Gets a {@link UserTeamAssociationPage} of {@link UserTeamAssociation} objects that satisfy the given {@link Statement#query}. The following fields are supported for filtering:

   PQL Property	Object Property
   {@code userId}	{@link UserTeamAssociation#userId}
   {@code teamId}	{@link UserTeamAssociation#teamId}

   • filterStatement - optional; type Statement
     Captures the {@code WHERE}, {@code ORDER BY} and {@code LIMIT} clauses of a PQL query. Statements are typically used to retrieve objects of a predefined domain type, which makes SELECT clause unnecessary.

     An example query text might be {@code "WHERE status = 'ACTIVE' ORDER BY id LIMIT 30"}.

     Statements support bind variables. These are substitutes for literals and can be thought of as input parameters to a PQL query.

     An example of such a query might be {@code "WHERE id = :idValue"}.

     Statements also support use of the LIKE keyword. This provides wildcard string matching.

     An example of such a query might be {@code "WHERE name LIKE '%searchString%'"}.

     The value for the variable idValue must then be set with an object of type {@link Value}, e.g., {@link NumberValue}, {@link TextValue} or {@link BooleanValue}.
     • query - optional; type string
       Holds the query in PQL syntax. The syntax is:
       [WHERE {[AND | OR] ...}]
[ORDER BY [ASC | DESC]]
[LIMIT {[,] } | { OFFSET }]
       

       
            := {< | <= | > | >= | = | != }

     := {< | <= | > | >= | = | != }
:= IN
:= IS NULL
:= LIKE
:= :
       

     • values - optional, unbounded; type String_ValueMapEntry
       Holds keys and values for bind variables and their values. The key is the name of the bind variable. The value is the literal value of the variable.

       In the example {@code "WHERE status = :bindStatus ORDER BY id LIMIT 30"}, the bind variable, represented by {@code :bindStatus} is named {@code bindStatus}, which would also be the parameter map key. The bind variable's value would be represented by a parameter map value of type {@link TextValue}. The final result, for example, would be an entry of {@code "bindStatus" => StringParam("ACTIVE")}.

       This represents an entry in a map with a key of type String and value of type Value.
       • key - optional; type string
       • value - optional; type Value
         {@code Value} represents a value.
   Output:
   getUserTeamAssociationsByStatementResponse (wsdlsoap:header, use = literal, part = ResponseHeader)Source code
   parameters type getUserTeamAssociationsByStatementResponse

   • rval - optional; type UserTeamAssociationPage
     Captures a page of {@link UserTeamAssociation} objects.
     • totalResultSetSize - optional; type int
       The size of the total result set to which this page belongs.
     • startIndex - optional; type int
       The absolute index in the total result set on which this page begins.
     • results - optional, unbounded; type UserTeamAssociation - extension of abstract type UserRecordTeamAssociation
       {@code UserTeamAssociation} associates a {@link User} with a {@link Team} to provide the user access to the entities that belong to the team.
       {@code UserRecordTeamAssociation} represents the association between a {@link UserRecord} and a {@link Team}.
       • teamId - optional; type long
         The {@link Team#id} of the team.
       • overriddenTeamAccessType - optional; type TeamAccessType - type string with restriction - enum { 'NONE', 'READ_ONLY', 'READ_WRITE' }
         The overridden team access type. This field is {@code null} if team access type is not overridden.
       • defaultTeamAccessType - optional; type TeamAccessType - type string with restriction - enum { 'NONE', 'READ_ONLY', 'READ_WRITE' }
         The default team access type {@link Team#teamAccessType}. This field is read-only and is populated by Google.
       • userId - optional; type long
         Refers to the {@link User#id}.
       The collection of user team associations contained within this page.
   Fault:
   ApiException (wsdlsoap:fault, use = literal)Source code
   ApiException type ApiExceptionFault

   Exception class for holding a list of service errors.

   Base class for exceptions.

   • message - optional; type string
     Error message.

   • errors - optional, unbounded; type ApiError
     The API error base class that provides details about an error that occurred while processing a service request.

     The OGNL field path is provided for parsers to identify the request data element that may have caused the error.

     • fieldPath - optional; type string
       The OGNL field path to identify cause of error.
     • fieldPathElements - optional, unbounded; type FieldPathElement
       A parsed copy of the field path. For example, the field path "operations[1].operand" corresponds to this list: {FieldPathElement(field = "operations", index = 1), FieldPathElement(field = "operand", index = null)}.
       A segment of a field path. Each dot in a field path defines a new segment.
       • field - optional; type string
         The name of a field in lower camelcase. (e.g. "biddingStrategy")
       • index - optional; type int
         For list fields, this is a 0-indexed position in the list. Null for non-list fields.
     • trigger - optional; type string
       The data that caused the error.
     • errorString - optional; type string
       A simple string representation of the error and reason.
     List of errors.

   A fault element of type ApiException.
3. performUserTeamAssociationAction
   Source code
   Description:
   Performs actions on {@link UserTeamAssociation} objects that match the given {@link Statement#query}.
   Operation type:
   Request-response. The endpoint receives a message, and sends a correlated message.
   Input:
   performUserTeamAssociationActionRequest (wsdlsoap:header, use = literal, part = RequestHeader)Source code
   parameters type performUserTeamAssociationAction

   Performs actions on {@link UserTeamAssociation} objects that match the given {@link Statement#query}.

   • userTeamAssociationAction - optional; type UserTeamAssociationAction
     Represents the actions that can be performed on {@link UserTeamAssociation} objects.
     • statement - optional; type Statement
       Captures the {@code WHERE}, {@code ORDER BY} and {@code LIMIT} clauses of a PQL query. Statements are typically used to retrieve objects of a predefined domain type, which makes SELECT clause unnecessary.

       An example query text might be {@code "WHERE status = 'ACTIVE' ORDER BY id LIMIT 30"}.

       Statements support bind variables. These are substitutes for literals and can be thought of as input parameters to a PQL query.

       An example of such a query might be {@code "WHERE id = :idValue"}.

       Statements also support use of the LIKE keyword. This provides wildcard string matching.

       An example of such a query might be {@code "WHERE name LIKE '%searchString%'"}.

       The value for the variable idValue must then be set with an object of type {@link Value}, e.g., {@link NumberValue}, {@link TextValue} or {@link BooleanValue}.
       • query - optional; type string
         Holds the query in PQL syntax. The syntax is:
         [WHERE {[AND | OR] ...}]
[ORDER BY [ASC | DESC]]
[LIMIT {[,] } | { OFFSET }]
         

         
              := {< | <= | > | >= | = | != }

     := {< | <= | > | >= | = | != }
:= IN
:= IS NULL
:= LIKE
:= :
         

       • values - optional, unbounded; type String_ValueMapEntry
         Holds keys and values for bind variables and their values. The key is the name of the bind variable. The value is the literal value of the variable.

         In the example {@code "WHERE status = :bindStatus ORDER BY id LIMIT 30"}, the bind variable, represented by {@code :bindStatus} is named {@code bindStatus}, which would also be the parameter map key. The bind variable's value would be represented by a parameter map value of type {@link TextValue}. The final result, for example, would be an entry of {@code "bindStatus" => StringParam("ACTIVE")}.

         This represents an entry in a map with a key of type String and value of type Value.
         • key - optional; type string
         • value - optional; type Value
           {@code Value} represents a value.
   Output:
   performUserTeamAssociationActionResponse (wsdlsoap:header, use = literal, part = ResponseHeader)Source code
   parameters type performUserTeamAssociationActionResponse

   • rval - optional; type UpdateResult
     Represents the result of performing an action on objects.
     • numChanges - optional; type int
       The number of objects that were changed as a result of performing the action.
   Fault:
   ApiException (wsdlsoap:fault, use = literal)Source code
   ApiException type ApiExceptionFault

   Exception class for holding a list of service errors.

   Base class for exceptions.

   • message - optional; type string
     Error message.

   • errors - optional, unbounded; type ApiError
     The API error base class that provides details about an error that occurred while processing a service request.

     The OGNL field path is provided for parsers to identify the request data element that may have caused the error.

     • fieldPath - optional; type string
       The OGNL field path to identify cause of error.
     • fieldPathElements - optional, unbounded; type FieldPathElement
       A parsed copy of the field path. For example, the field path "operations[1].operand" corresponds to this list: {FieldPathElement(field = "operations", index = 1), FieldPathElement(field = "operand", index = null)}.
       A segment of a field path. Each dot in a field path defines a new segment.
       • field - optional; type string
         The name of a field in lower camelcase. (e.g. "biddingStrategy")
       • index - optional; type int
         For list fields, this is a 0-indexed position in the list. Null for non-list fields.
     • trigger - optional; type string
       The data that caused the error.
     • errorString - optional; type string
       A simple string representation of the error and reason.
     List of errors.

   A fault element of type ApiException.
4. updateUserTeamAssociations
   Source code
   Description:
   Updates the specified {@link UserTeamAssociation} objects.
   Operation type:
   Request-response. The endpoint receives a message, and sends a correlated message.
   Input:
   updateUserTeamAssociationsRequest (wsdlsoap:header, use = literal, part = RequestHeader)Source code
   parameters type updateUserTeamAssociations

   Updates the specified {@link UserTeamAssociation} objects.

   • userTeamAssociations - optional, unbounded; type UserTeamAssociation - extension of abstract type UserRecordTeamAssociation
     {@code UserTeamAssociation} associates a {@link User} with a {@link Team} to provide the user access to the entities that belong to the team.
     {@code UserRecordTeamAssociation} represents the association between a {@link UserRecord} and a {@link Team}.
     • teamId - optional; type long
       The {@link Team#id} of the team.
     • overriddenTeamAccessType - optional; type TeamAccessType - type string with restriction - enum { 'NONE', 'READ_ONLY', 'READ_WRITE' }
       The overridden team access type. This field is {@code null} if team access type is not overridden.
     • defaultTeamAccessType - optional; type TeamAccessType - type string with restriction - enum { 'NONE', 'READ_ONLY', 'READ_WRITE' }
       The default team access type {@link Team#teamAccessType}. This field is read-only and is populated by Google.
     • userId - optional; type long
       Refers to the {@link User#id}.
   Output:
   updateUserTeamAssociationsResponse (wsdlsoap:header, use = literal, part = ResponseHeader)Source code
   parameters type updateUserTeamAssociationsResponse

   • rval - optional, unbounded; type UserTeamAssociation - extension of abstract type UserRecordTeamAssociation
     {@code UserTeamAssociation} associates a {@link User} with a {@link Team} to provide the user access to the entities that belong to the team.
     {@code UserRecordTeamAssociation} represents the association between a {@link UserRecord} and a {@link Team}.
     • teamId - optional; type long
       The {@link Team#id} of the team.
     • overriddenTeamAccessType - optional; type TeamAccessType - type string with restriction - enum { 'NONE', 'READ_ONLY', 'READ_WRITE' }
       The overridden team access type. This field is {@code null} if team access type is not overridden.
     • defaultTeamAccessType - optional; type TeamAccessType - type string with restriction - enum { 'NONE', 'READ_ONLY', 'READ_WRITE' }
       The default team access type {@link Team#teamAccessType}. This field is read-only and is populated by Google.
     • userId - optional; type long
       Refers to the {@link User#id}.
   Fault:
   ApiException (wsdlsoap:fault, use = literal)Source code
   ApiException type ApiExceptionFault

   Exception class for holding a list of service errors.

   Base class for exceptions.

   • message - optional; type string
     Error message.

   • errors - optional, unbounded; type ApiError
     The API error base class that provides details about an error that occurred while processing a service request.

     The OGNL field path is provided for parsers to identify the request data element that may have caused the error.

     • fieldPath - optional; type string
       The OGNL field path to identify cause of error.
     • fieldPathElements - optional, unbounded; type FieldPathElement
       A parsed copy of the field path. For example, the field path "operations[1].operand" corresponds to this list: {FieldPathElement(field = "operations", index = 1), FieldPathElement(field = "operand", index = null)}.
       A segment of a field path. Each dot in a field path defines a new segment.
       • field - optional; type string
         The name of a field in lower camelcase. (e.g. "biddingStrategy")
       • index - optional; type int
         For list fields, this is a 0-indexed position in the list. Null for non-list fields.
     • trigger - optional; type string
       The data that caused the error.
     • errorString - optional; type string
       A simple string representation of the error and reason.
     List of errors.

   A fault element of type ApiException.