Jump to

• Request
• Response
• Examples

Get a resource user

get

/crmRestApi/resources/11.13.18.05/resourceUsers/{resourceUsersUniqID}

Request

Path Parameters

• resourceUsersUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Resource Users resource and used to uniquely identify an instance of Resource Users. The client should not generate the hash key value. Instead, the client should query on the Resource Users collection resource in order to navigate to a specific instance of Resource Users to get the hash key.

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

Header Parameters

• Metadata-Context: string
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version: string
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : resourceUsers-item-response

Type: object

Show Source

• AddressLine1: string
  Title: Address Line 1

  Maximum Length: 240

  The first line of the address of the resource.
• AddressLine2: string
  Title: Address Line 2

  Maximum Length: 240

  The second line of the address of the resource.
• BusinessUnit: string
  Title: Business Unit

  The name of the business unit associated with the resource.
• City: string
  Title: City

  Read Only: true

  Maximum Length: 60

  The name of the city provided in the resource's address.
• Country: string
  Title: Country

  Read Only: true

  Maximum Length: 2

  The name of the country provided in the resource's address.
• County: string
  Title: County

  Maximum Length: 60

  The name of the county provided in the resource's address.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the record.
• CreateUserAccountFlag: boolean
  Title: Create User Account

  Indicates whether a user account can be created for the resource. The default value is true.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time when the record was created.
• DeleteFlag: boolean
  Read Only: true

  Indicates if the user can delete the resource.
• FaxCountryCode: string
  Title: Phone Country Code

  Maximum Length: 10

  The country code of the fax.
• FirstName: string
  Title: First Name

  Maximum Length: 150

  The first name of the resource.
• FormattedAddress: string
  Title: Address

  Read Only: true

  Maximum Length: 255

  The primary formatted address of the resource.
• HireDate: string (date)
  Title: Hire Date

  The date when the resource was hired.
• HRManagerEmailAddress: string
  Title: HR Manager Email

  The email address of the human resource manager of the resource.
• IndividualRoleCode: string
  Title: Individual Role Code

  Maximum Length: 255

  The special individual role of the user.
• IndividualRoleEndDate: string (date)
  Title: Individual Role End Date

  The date when the individual role ends.
• IndividualRoleStartDate: string (date)
  Title: Individual Role Start Date

  The date when the individual role starts.
• JobCode: string
  Title: Job Code

  The job code assigned to the resource.
• JobTitle: string
  Title: Job Title

  Read Only: true

  The title of the job assigned to the resource.
• LastName: string
  Title: Last Name

  Maximum Length: 150

  The last name of the resource.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  The date when the record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the record.
• LegalEntity: string
  Title: Legal Entity

  The name of the legal entity of associated with the resource.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MiddleName: string
  Title: Middle Name

  Maximum Length: 60

  The middle name of the resource.
• MobilePhoneCountryCode: string
  Title: Phone Country Code

  Maximum Length: 10

  The country code associated with the mobile phone.
• PartyName: string
  Title: Resource Name

  Read Only: true

  Maximum Length: 360

  The name of the person.
• PersonNumber: string
  Title: Person Number

  Read Only: true

  The person number identifier of the worker record of the resource.
• PersonType: string
  Title: Person Type

  The type of the work relationship of a worker associated with the resource. For exampe, Employee, Contingent, or Worker.
• PostalCode: string
  Title: Postal Code

  Read Only: true

  Maximum Length: 60

  The postal code for the address of resource.
• Province: string
  Title: Province

  Maximum Length: 60

  The name of the province provided in the resource's address.
• RawFaxNumber: string
  Title: Fax

  Maximum Length: 60

  The fax number of the resource in raw format.
• RawMobilePhoneNumber: string
  Title: Mobile Phone

  Maximum Length: 60

  The mobile phone number of the resource.
• RawWorkPhoneNumber: string
  Title: Work Phone

  Maximum Length: 60

  The resource's work phone number in raw format.
• ResourceEmail: string
  Title: Email

  Maximum Length: 320

  The email address of the resource.
• ResourceEndDate: string (date)
  Title: To Date

  The date up to which the resource is active.
• ResourceManagerFirstName: string
  Title: Manager First Name

  Maximum Length: 255

  The first name of the reporting manager of the resource.
• ResourceManagerLastName: string
  Title: Manager Last Name

  Maximum Length: 255

  The last name of the reporting manager of the resource.
• ResourceManagerName: string
  Title: Manager Name

  Maximum Length: 255

  The name of the manager of the resource.
• ResourceManagerPartyId: integer
  Title: Manager Party ID

  Read Only: true

  The unique identifier of the reporting manager of the resource.
• ResourceManagerPartyNumber: string
  Title: Manager Party Number

  Read Only: true

  Maximum Length: 255

  The unique public identifier of the reporting manager of the resource.
• ResourceOrganizationName: string
  Title: Organization

  Maximum Length: 255

  The name of the resource organization associated to the resource in managerial role.
• ResourceOrganizationUsage: string
  Title: Organization Usage

  Read Only: true

  Maximum Length: 255

  The usage type of the resource organization. For example, Sales or Marketing.
• ResourceOrgManagerEmail: string
  Title: Manager Email

  Maximum Length: 255

  The email address of the reporting manager of the resource.
• ResourceOrgMemRoleEndDate: string (date)
  Title: Membership Role End Date

  The date when the membership of the resource ends.
• ResourceOrgMemRoleStartDate: string (date)
  Title: Organization Membership Role Start Date

  The date when the resource becomes a member of the organization.
• ResourceOrgRoleCode: string
  Title: Organization Role Code

  Maximum Length: 255

  The code indicating the role of the resource in association with organization membership. For example, SALES_REPRESENTATIVE or SALES_MANAGER.
• ResourceOrgRoleName: string
  Read Only: true

  Maximum Length: 255

  The role that defines the function of the resource in an organization or hierarchy.
• ResourceParentOrganizationName: string
  Title: Parent Organization

  Maximum Length: 255

  The name of the organization to which the manager of the resource is associated.
• ResourcePartyId: integer (int64)
  Title: Party ID

  The unique identifier of the party associated with the resource.
• ResourcePartyNumber: string
  Title: Party Number

  Maximum Length: 30

  The unique identifier of the party associated with the resource.
• ResourceProfileId: integer (int64)
  Title: Profile ID

  Read Only: true

  The unique identifier of the profile of the resource.
• ResourceRoleAssign: array Resource Role Assignments
  Title: Resource Role Assignments

  The resource role assignments resource is used to view the role assigned to a resource, such as implementer, reseller, and so on.
• ResourceStartDate: string (date)
  Title: Resource Start Date

  The date when the resource becomes active.
• ResourceType: string
  Title: Usage

  The type of the resource.
• State: string
  Title: State

  Maximum Length: 60

  The name of the state provided in the resource's address.
• TimezoneCode: string
  Title: Time Zone Code

  Maximum Length: 64

  The code for the time zone of the resource.
• Title: string
  Title: Title

  Maximum Length: 60

  The title preceding the name of the resource.
• TopResourceFlag: boolean
  Title: Root Resource

  Default Value: false

  Indicates whether the resource is top user in hierarchy.
• UpdateFlag: boolean
  Title: Update Access

  Read Only: true

  Indicates if the user can update the resource.
• Username: string
  Title: User Name

  Read Only: true

  The user name or account name, used for login, of the resource user.
• UserStatus: string
  Title: User Account Status

  Maximum Length: 255

  Indicates the the status of the user account for the resource. The supported values are A for active and S for suspended. The status is set to A for new accounts.
• WorkPhoneCountryCode: string
  Title: Phone Country Code

  Maximum Length: 10

  The country code associated with the work phone.

{
    "type":"object",
    "properties":{
        "AddressLine1":{
            "title":"Address Line 1",
            "maxLength":240,
            "type":"string",
            "description":"The first line of the address of the resource.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address1",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 1",
                "protectionTokenizationScheme":"WORD"
            }
        },
        "AddressLine2":{
            "title":"Address Line 2",
            "maxLength":240,
            "type":"string",
            "description":"The second line of the address of the resource.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address2",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 2",
                "protectionTokenizationScheme":"WORD"
            }
        },
        "BusinessUnit":{
            "title":"Business Unit",
            "type":"string",
            "description":"The name of the business unit associated with the resource.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "City":{
            "title":"City",
            "maxLength":60,
            "type":"string",
            "description":"The name of the city provided in the resource's address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "protectionKey":"PartySiteEO.City",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"City"
            }
        },
        "Country":{
            "title":"Country",
            "maxLength":2,
            "type":"string",
            "description":"The name of the country provided in the resource's address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "County":{
            "title":"County",
            "maxLength":60,
            "type":"string",
            "description":"The name of the county provided in the resource's address.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "protectionKey":"PartySiteEO.County",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"County"
            }
        },
        "CreateUserAccountFlag":{
            "title":"Create User Account",
            "type":"boolean",
            "description":"Indicates whether a user account can be created for the resource. The default value is true.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DeleteFlag":{
            "type":"boolean",
            "description":"Indicates if the user can delete the resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "FaxCountryCode":{
            "title":"Phone Country Code",
            "maxLength":10,
            "type":"string",
            "description":"The country code of the fax.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "FirstName":{
            "title":"First Name",
            "maxLength":150,
            "type":"string",
            "description":"The first name of the resource.",
            "nullable":false,
            "x-queryable":false
        },
        "FormattedAddress":{
            "title":"Address",
            "maxLength":255,
            "type":"string",
            "description":"The primary formatted address of the resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "HRManagerEmailAddress":{
            "title":"HR Manager Email",
            "type":"string",
            "description":"The email address of the human resource manager of the resource.",
            "nullable":true,
            "x-queryable":false
        },
        "HireDate":{
            "title":"Hire Date",
            "type":"string",
            "description":"The date when the resource was hired.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "IndividualRoleCode":{
            "title":"Individual Role Code",
            "maxLength":255,
            "type":"string",
            "description":"The special individual role of the user.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "IndividualRoleEndDate":{
            "title":"Individual Role End Date",
            "type":"string",
            "description":"The date when the individual role ends.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "IndividualRoleStartDate":{
            "title":"Individual Role Start Date",
            "type":"string",
            "description":"The date when the individual role starts.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "JobCode":{
            "title":"Job Code",
            "type":"string",
            "description":"The job code assigned to the resource.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "JobTitle":{
            "title":"Job Title",
            "type":"string",
            "description":"The title of the job assigned to the resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LastName":{
            "title":"Last Name",
            "maxLength":150,
            "type":"string",
            "description":"The last name of the resource.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LegalEntity":{
            "title":"Legal Entity",
            "type":"string",
            "description":"The name of the legal entity of associated with the resource.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "MiddleName":{
            "title":"Middle Name",
            "maxLength":60,
            "type":"string",
            "description":"The middle name of the resource.",
            "nullable":true,
            "x-queryable":false
        },
        "MobilePhoneCountryCode":{
            "title":"Phone Country Code",
            "maxLength":10,
            "type":"string",
            "description":"The country code associated with the mobile phone.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PartyName":{
            "title":"Resource Name",
            "maxLength":360,
            "type":"string",
            "description":"The name of the person.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PersonNumber":{
            "title":"Person Number",
            "type":"string",
            "description":"The person number identifier of the worker record of the resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PersonType":{
            "title":"Person Type",
            "type":"string",
            "description":"The type of the work relationship of a worker associated with the resource. For exampe, Employee, Contingent, or Worker.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PostalCode":{
            "title":"Postal Code",
            "maxLength":60,
            "type":"string",
            "description":"The postal code for the address of resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "protectionKey":"PartySiteEO.PostalCode",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Postal Code"
            }
        },
        "Province":{
            "title":"Province",
            "maxLength":60,
            "type":"string",
            "description":"The name of the province provided in the resource's address.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "protectionKey":"PartySiteEO.Province",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Province"
            }
        },
        "RawFaxNumber":{
            "title":"Fax",
            "maxLength":60,
            "type":"string",
            "description":"The fax number of the resource in raw format.",
            "nullable":true,
            "x-queryable":false
        },
        "RawMobilePhoneNumber":{
            "title":"Mobile Phone",
            "maxLength":60,
            "type":"string",
            "description":"The mobile phone number of the resource.",
            "nullable":true,
            "x-queryable":false
        },
        "RawWorkPhoneNumber":{
            "title":"Work Phone",
            "maxLength":60,
            "type":"string",
            "description":"The resource's work phone number in raw format.",
            "nullable":true,
            "x-queryable":false
        },
        "ResourceEmail":{
            "title":"Email",
            "maxLength":320,
            "type":"string",
            "description":"The email address of the resource.",
            "nullable":false,
            "x-hints":{
                "protectionKey":"EmailEO.EmailAddress",
                "protectionObjectTitle":"Email",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Email"
            },
            "x-queryable":true
        },
        "ResourceEndDate":{
            "title":"To Date",
            "type":"string",
            "description":"The date up to which the resource is active.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "ResourceManagerFirstName":{
            "title":"Manager First Name",
            "maxLength":255,
            "type":"string",
            "description":"The first name of the reporting manager of the resource.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "MgrStr"
                ]
            },
            "x-queryable":true
        },
        "ResourceManagerLastName":{
            "title":"Manager Last Name",
            "maxLength":255,
            "type":"string",
            "description":"The last name of the reporting manager of the resource.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "MgrStr"
                ]
            },
            "x-queryable":true
        },
        "ResourceManagerName":{
            "title":"Manager Name",
            "maxLength":255,
            "type":"string",
            "description":"The name of the manager of the resource.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "MgrStr"
                ]
            },
            "x-queryable":true
        },
        "ResourceManagerPartyId":{
            "title":"Manager Party ID",
            "type":"integer",
            "description":"The unique identifier of the reporting manager of the resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "MgrStr"
                ]
            }
        },
        "ResourceManagerPartyNumber":{
            "title":"Manager Party Number",
            "maxLength":255,
            "type":"string",
            "description":"The unique public identifier of the reporting manager of the resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "MgrStr"
                ]
            }
        },
        "ResourceOrgManagerEmail":{
            "title":"Manager Email",
            "maxLength":255,
            "type":"string",
            "description":"The email address of the reporting manager of the resource.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "MgrStr"
                ]
            },
            "x-queryable":true
        },
        "ResourceOrgMemRoleEndDate":{
            "title":"Membership Role End Date",
            "type":"string",
            "description":"The date when the membership of the resource ends.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "ResourceOrgMemRoleStartDate":{
            "title":"Organization Membership Role Start Date",
            "type":"string",
            "description":"The date when the resource becomes a member of the organization.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ResourceOrgRoleCode":{
            "title":"Organization Role Code",
            "maxLength":255,
            "type":"string",
            "description":"The code indicating the role of the resource in association with organization membership. For example, SALES_REPRESENTATIVE or SALES_MANAGER.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ResourceOrgRoleName":{
            "maxLength":255,
            "type":"string",
            "description":"The role that defines the function of the resource in an organization or hierarchy.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceOrganizationName":{
            "title":"Organization",
            "maxLength":255,
            "type":"string",
            "description":"The name of the resource organization associated to the resource in managerial role.",
            "nullable":true,
            "x-queryable":true
        },
        "ResourceOrganizationUsage":{
            "title":"Organization Usage",
            "maxLength":255,
            "type":"string",
            "description":"The usage type of the resource organization. For example, Sales or Marketing.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceParentOrganizationName":{
            "title":"Parent Organization",
            "maxLength":255,
            "type":"string",
            "description":"The name of the organization to which the manager of the resource is associated.",
            "nullable":true,
            "x-queryable":true
        },
        "ResourcePartyId":{
            "title":"Party ID",
            "type":"integer",
            "description":"The unique identifier of the party associated with the resource.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ResourcePartyNumber":{
            "title":"Party Number",
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier of the party associated with the resource.",
            "nullable":true,
            "x-queryable":true
        },
        "ResourceProfileId":{
            "title":"Profile ID",
            "type":"integer",
            "description":"The unique identifier of the profile of the resource.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ResourceRoleAssign":{
            "title":"Resource Role Assignments",
            "type":"array",
            "description":"The resource role assignments resource is used to view the role assigned to a resource, such as implementer, reseller, and so on.",
            "items":{
                "$ref":"#/components/schemas/resourceUsers-ResourceRoleAssign-item-response"
            }
        },
        "ResourceStartDate":{
            "title":"Resource Start Date",
            "type":"string",
            "description":"The date when the resource becomes active.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "ResourceType":{
            "title":"Usage",
            "type":"string",
            "description":"The type of the resource.",
            "nullable":true,
            "x-queryable":false
        },
        "State":{
            "title":"State",
            "maxLength":60,
            "type":"string",
            "description":"The name of the state provided in the resource's address.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "protectionKey":"PartySiteEO.State",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"State"
            }
        },
        "TimezoneCode":{
            "title":"Time Zone Code",
            "maxLength":64,
            "type":"string",
            "description":"The code for the time zone of the resource.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "AttributeType":"Picklist"
            }
        },
        "Title":{
            "title":"Title",
            "maxLength":60,
            "type":"string",
            "description":"The title preceding the name of the resource.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "TopResourceFlag":{
            "title":"Root Resource",
            "type":"boolean",
            "description":"Indicates whether the resource is top user in hierarchy.",
            "nullable":true,
            "default":false,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "UpdateFlag":{
            "title":"Update Access",
            "type":"boolean",
            "description":"Indicates if the user can update the resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "UserStatus":{
            "title":"User Account Status",
            "maxLength":255,
            "type":"string",
            "description":"Indicates the the status of the user account for the resource. The supported values are A for active and S for suspended. The status is set to A for new accounts.",
            "nullable":true,
            "x-queryable":true
        },
        "Username":{
            "title":"User Name",
            "type":"string",
            "description":"The user name or account name, used for login, of the resource user.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "<",
                    "<=",
                    ">",
                    ">=",
                    "BETWEEN",
                    "NOTBETWEEN",
                    "CONTAINS",
                    "DOESNOTCONTAIN"
                ]
            },
            "x-queryable":true
        },
        "WorkPhoneCountryCode":{
            "title":"Phone Country Code",
            "maxLength":10,
            "type":"string",
            "description":"The country code associated with the work phone.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : Resource Role Assignments

Type: array

Title: Resource Role Assignments

The resource role assignments resource is used to view the role assigned to a resource, such as implementer, reseller, and so on.

Show Source

• Array of: object resourceUsers-ResourceRoleAssign-item-response

{
    "title":"Resource Role Assignments",
    "type":"array",
    "description":"The resource role assignments resource is used to view the role assigned to a resource, such as implementer, reseller, and so on.",
    "items":{
        "$ref":"#/components/schemas/resourceUsers-ResourceRoleAssign-item-response"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : resourceUsers-ResourceRoleAssign-item-response

Type: object

Show Source

• EndDateActive: string (date)
  Title: To Date

  The date when the resource role becomes inactive.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PartyName: string
  Title: Resource

  Maximum Length: 360

  The name of the party.
• RoleCode: string
  Read Only: true

  Maximum Length: 30

  The value of the code for the role assigned to the resource.
• RoleId: integer
  Title: Role

  The unique identifier of the role.
• RoleRelateId: integer
  Read Only: true

  Role Relation identifier (PK)
• RoleResourceId: integer
  The unique identifier of the resource role.
• StartDateActive: string (date)
  Title: From Date

  The date when the resource role become active.

{
    "type":"object",
    "properties":{
        "EndDateActive":{
            "title":"To Date",
            "type":"string",
            "description":"The date when the resource role becomes inactive.",
            "format":"date",
            "nullable":false,
            "x-hints":{
                "DefaultValue":"FUTURE_DATE"
            },
            "x-queryable":true
        },
        "PartyName":{
            "title":"Resource",
            "maxLength":360,
            "type":"string",
            "description":"The name of the party.",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "RoleCode":{
            "maxLength":30,
            "type":"string",
            "description":"The value of the code for the role assigned to the resource.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RoleId":{
            "title":"Role",
            "type":"integer",
            "description":"The unique identifier of the role.",
            "nullable":false,
            "x-hints":{
                "fnd:FND_AUDIT_FORCE_WRITE":"true",
                "fnd:FND_AUDIT_USER_KEY":"true",
                "controlType":"choice",
                "fnd:FND_AUDIT_FK_VIEWOBJECT":"oracle.apps.cdm.foundation.resources.publicModel.view.ResourceRoleVVO",
                "ATTR_INTERNAL_USE":"Y",
                "ExtnEventActionProperty":"HideInCreateTask;HideInEmailTemplate;HideInFieldUpdate",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:FND_AUDIT_FK_DISPLAYATTR":"RoleName",
                "fnd:FND_AUDIT_FK_WHEREATTR":"RoleId"
            },
            "x-queryable":true
        },
        "RoleRelateId":{
            "type":"integer",
            "description":"Role Relation identifier (PK)",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "ATTR_INTERNAL_USE":"Y",
                "ExtnEventActionProperty":"HideInCreateTask;HideInEmailTemplate;HideInFieldUpdate",
                "fnd:GLOBALLY_UNIQUE":"true",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "RoleResourceId":{
            "type":"integer",
            "description":"The unique identifier of the resource role.",
            "nullable":false,
            "x-hints":{
                "fnd:FND_AUDIT_FORCE_WRITE":"true",
                "ATTR_INTERNAL_USE":"Y",
                "ExtnEventActionProperty":"HideInCreateTask;HideInEmailTemplate;HideInFieldUpdate"
            },
            "x-queryable":true
        },
        "StartDateActive":{
            "title":"From Date",
            "type":"string",
            "description":"The date when the resource role become active.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Links

FaxCountryCodeVA

Operation: /crmRestApi/resources/11.13.18.05/countryCodes

The following properties are defined on the LOV link relation:

• Source Attribute: FaxCountryCode; Target Attribute: PhoneCountryCode
• Display Attribute: PhoneCountryCode, TerritoryShortName

MobilePhoneCountryCodeVA

Operation: /crmRestApi/resources/11.13.18.05/countryCodes

The following properties are defined on the LOV link relation:

• Source Attribute: MobilePhoneCountryCode; Target Attribute: PhoneCountryCode
• Display Attribute: PhoneCountryCode, TerritoryShortName

ResourceRoleAssign

Operation: /crmRestApi/resources/11.13.18.05/resourceUsers/{resourceUsersUniqID}/child/ResourceRoleAssign

Parameters:

• resourceUsersUniqID: $request.path.resourceUsersUniqID

The resource role assignments resource is used to view the role assigned to a resource, such as implementer, reseller, and so on.

WorkPhoneCountryCodeVA

Operation: /crmRestApi/resources/11.13.18.05/countryCodes

The following properties are defined on the LOV link relation:

• Source Attribute: WorkPhoneCountryCode; Target Attribute: PhoneCountryCode
• Display Attribute: PhoneCountryCode, TerritoryShortName

Back to Top

Examples

The following example shows how to get a Resource User by submitting a GET request on the REST resource using cURL.

cURL Command

curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/resourceUsers/CDRM_977317

Example of Response Body

The following example shows the contents of the response body in JSON format.

{
  "ResourceProfileId": 300100187632523,
  "PartyName": "Lokesh Chugh",
  "LastUpdateDate": "2020-07-23T08:23:09.908+00:00",
  "LastUpdatedBy": "MHoope",
  "CreationDate": "2020-07-23T08:22:33.003+00:00",
  "CreatedBy": "MHoope",
  "ResourceType": "INDIVIDUAL",
  "FormattedAddress": "Line 1,5 Cross,FLORENCE, CA 90001",
  "TimezoneCode": null,
  "Username": "LOKESHCHUGH",
  "City": "Florence",
  "Country": "US",
  "PostalCode": "90001",
  "UpdateFlag": "true",
  "DeleteFlag": "false",
  "ResourceOrgRoleCode": "SALES_REPRESENTATIVE",
  "ResourceOrgRoleName": "Salesperson",
  "FirstName": "Lokesh",
  "LastName": "Chugh",
  "MiddleName": null,
  "Title": "MR.",
  "ResourcePartyNumber": "CDRM_977317",
  "State": "CA",
  "ResourceEmail": "[e-mail]",
  "RawWorkPhoneNumber": "6505061410",
  "RawMobilePhoneNumber": "659123457",
  "RawFaxNumber": null,
  "AddressLine1": "Line 1",
  "AddressLine2": "5 Cross",
  "ResourceStartDate": "2020-07-23",
  "ResourceEndDate": "4712-12-31",
  "ResourcePartyId": 300100187632524,
  "ResourceOrganizationName": "Alan Tan Org",
  "ResourceOrganizationUsage": "SALES_RESOURCE_ORG",
  "ResourceOrgMemRoleEndDate": "4712-12-31",
  "ResourceParentOrganizationName": "Alan Tan Org",
  "ResourceOrgManagerEmail": "[e-mail]",
  "ResourceManagerName": "Alan Tan",
  "ResourceManagerFirstName": "Alan",
  "ResourceManagerLastName": "Tan",
  "HRManagerEmailAddress": null,
  "HireDate": "2020-07-23",
  "ResourceOrgMemRoleStartDate": "2020-07-23",
  "IndividualRoleCode": "SALES_REPRESENTATIVE",
  "IndividualRoleStartDate": "2020-07-23",
  "IndividualRoleEndDate": "4712-12-31",
  "ResourceManagerPartyNumber": "CDRM_977314",
  "County": null,
  "Province": null,
  "ResourceManagerPartyId": 300100187632390,
  "TopResourceFlag": null,
  "FaxCountryCode": null,
  "WorkPhoneCountryCode": "1",
  "MobilePhoneCountryCode": "1",
  "PersonNumber": "300100187632535",
  "BusinessUnit": "Vision Operations",
  "LegalEntity": "Vision Corporation",
  "JobCode": null,
  "JobTitle": null,
  "UserStatus": "A",
  "PersonType": "EMP",
  "CreateUserAccountFlag": null,
    "links": [
...
		]
}

Note:

RecordSet is a lookup type. You can filter resources using RecordSet. Record Sets are supported in Resource REST and Resource User REST with the following values:

• ORA_MYDIRECTS- My direct reports: Resources who are my direct reports.
• ORA_MYREPORTEES- All my direct and indirect reports: Resources who are my direct or indirect reports.
• ORA_MYMANAGERANDPEERS- My manager and my peers: Resources who are my peers or is my manager.

Example of URL

https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/resourceUsers?q=RecordSet='ORA_MYMANAGERANDPEERS'

Get an Internal Resource by Email

The following example shows how to get a Resource User by specifying the email ID in the ResourceEmail finder by submitting a GET request on the REST resource using cURL.

cURL Command

curl --user sales_cloud_user -X GET -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/resourceUsers?q=ResourceEmail='[e-mail]'

Example of Response Body

The following example shows the contents of the response body in JSON format.

{
 "PartyName": "John Smith",
 "ResourceType": "INDIVIDUAL",
 "FormattedAddress": "500 Oracle Parkway,REDWOOD CITY, CA 944065",
 "Username": "jsmith439906587",
 "City": "Redwood City",
 "Country": "US",
 "PostalCode": "944065",
 "FirstName": "John",
 "LastName": "Smith",
 "ResourcePartyNumber": "Conta504976",
 "State": "CA",
 "ResourceEmail": "[e-mail]",
 "RawWorkPhoneNumber": "6505061212",
 "RawMobilePhoneNumber": null,
 "RawFaxNumber": null,
 "AddressLine1": "500 Oracle Parkway",
 "ResourceOrganizationName": "JSmithOrg",
 "ResourceOrganizationUsage": "SALES_RESOURCE_ORG",
 "ResourceOrgMemRoleEndDate": "4712-12-31",
 "ResourceOrgRoleCode":"SALES_MANAGER",
 "ResourceParentOrganizationName" : "NA Sales",
 "ResourceManagerFirstName": "Phil",
 "ResourceManagerLastName": "Gioco",
 "HRManagerEmailAddress": "[e-mail]",
 "HireDate": "2018-08-20",
 "ResourceOrgMemRoleStartDate": "2018-08-20",
 "ResourceManagerPartyNumber": "100010034246635",
 "ResourceManagerPartyId": 100010034246635,
 "PersonNumber": "300100159661235",
 "BusinessUnit": "Vision Corporation Enterprise",
 "LegalEntity": "Vision Corporation",
 "UserStatus": "A",
 "PersonType": "EMP",
 "CreateUserAccountFlag": null,
...
}

Get an Internal Resource by User Name

The following example shows how to get a Resource User by specifying the specifying the user name in the Username finder by submitting a GET request on the REST resource using cURL. For more such examples see Manage Sales Resource Life Cycle.

cURL Command

curl --user sales_cloud_user -X GET -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/resourceUsers?q=Username='jdoe439906587'

Example of Response Body

The following example shows the contents of the response body in JSON format.

{
 "PartyName": "Jane Doe",
 "ResourceType": "INDIVIDUAL",
 "FormattedAddress": "500 Oracle Parkway,REDWOOD CITY, CA 944065",
 "Username": "jdoe439906587",
 "City": "Redwood City",
 "Country": "US",
 "PostalCode": "944065",
 "FirstName": "John",
 "LastName": "Smith",
 "ResourcePartyNumber": "Conta765976",
 "State": "CA",
 "ResourceEmail": "[e-mail]",
 "RawWorkPhoneNumber": "6505061212",
 "RawMobilePhoneNumber": null,
 "RawFaxNumber": null,
 "AddressLine1": "500 Oracle Parkway",
 "ResourceOrganizationName": "JSmithOrg",
 "ResourceOrganizationUsage": "SALES_RESOURCE_ORG",
 "ResourceOrgMemRoleEndDate": "4712-12-31",
 "ResourceOrgRoleCode":"SALES_REPRESENTATIVE",
 "ResourceParentOrganizationName" : "NA Sales",
 "ResourceManagerFirstName": "Phil",
 "ResourceManagerLastName": "Gioco", 
 "HRManagerEmailAddress": "[e-mail]",
 "HireDate": "2018-08-20",
 "ResourceOrgMemRoleStartDate": "2018-08-20",
 "ResourceManagerPartyNumber": "100010034246635",
 "ResourceManagerPartyId": 100010034246635,
 "PersonNumber": "300100159661235",
 "BusinessUnit": "Vision Corporation Enterprise",
 "LegalEntity": "Vision Corporation",
 "UserStatus": "A",
 "PersonType": "EMP",
 "CreateUserAccountFlag": null,
...
}

Back to Top