Get a resource
get
/crmRestApi/resources/11.13.18.05/resources/{PartyNumber}
Request
Path Parameters
-
PartyNumber(required): string
The alternate key identifier of the resource party.
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:
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.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
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(required):
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.
Root Schema : resources-item-response
Type:
Show Source
object
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
Who column: indicates the user who created the row. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Who column: indicates the date and time of the creation of the row. -
DeleteFlag: boolean
Read Only:
true
Indicates if the user can delete the resource. -
EmailAddress: string
Title:
E-Mail
Read Only:true
Maximum Length:320
The e-mail address of a resource. -
EndDateActive: string
(date)
Title:
To Date
Date on which this resource is no longer active. -
FormattedAddress: string
Title:
Address
Read Only:true
Maximum Length:255
The primary formatted address information of a resource. -
FormattedPhoneNumber: string
Title:
Phone
Read Only:true
Maximum Length:100
The primary formatted phone number for a resource. -
JobMeaning: string
Title:
Job Title
Read Only:true
The job title for the resource who is an employee. -
LastUpdateDate: string
(date-time)
Title:
Last Updated
Read Only:true
Who column: indicates the date and time of the last update of the row. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
Who column: indicates the user who last updated the row. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
Who column: indicates the session login associated to the user who last updated the row. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Manager: string
Title:
Manager
Read Only:true
The name of the manager for this resource. -
ManagerPartyId: integer
Title:
Manager Party ID
The unique identifier of the resource???s manager party. -
PartyId: integer
(int64)
Title:
Resource
The unique identifier of a resource party. -
PartyName: string
Title:
Resource Name
Read Only:true
Maximum Length:360
The name of a resource party. -
PartyNumber: string
Title:
Registry ID
Read Only:true
Maximum Length:30
The alternate key identifier of the resource party. -
PersonFirstName: string
Title:
First Name
Maximum Length:150
The first name of the resource. -
PersonLastName: string
Title:
Last Name
Maximum Length:150
The last name of the resource. -
PersonLastNamePrefix: string
Title:
Last Name Prefix
Read Only:true
Maximum Length:30
The prefix for the last name of a resource. -
PersonMiddleName: string
Title:
Middle Name
Read Only:true
Maximum Length:60
The middle name of the resource. -
PersonNameSuffix: string
Title:
Suffix
Read Only:true
Maximum Length:30
The suffix for the name of a resource. -
PersonPreNameAdjunct: string
Title:
Salutary Introduction
Read Only:true
Maximum Length:30
The preferred name adjacency of a resource. -
PersonPreviousLastName: string
Title:
Previous Last Name
Read Only:true
Maximum Length:150
The previous last name of a resource. -
PersonSecondLastName: string
Title:
Second Last Name
Read Only:true
Maximum Length:150
The second last name of a resource. -
PictureAttachment: array
Picture Attachments
Title:
Picture Attachments
The picture attachments resource is used to view the picture of a resource. -
PrimaryOrganization: string
Title:
Organization
Read Only:true
The primary organization for this resource. -
RecordSet: string
Title:
Record Set
The record set that groups resources matching the defined criteria. -
ResourceOrgRoleCode: string
Read Only:
true
Maximum Length:255
Code value for the role assigned to a resource. -
ResourceOrgRoleName: string
Read Only:
true
Maximum Length:255
The role that defines the function of the resource in an organization or hierarchy. -
ResourceProfileId: integer
(int64)
Title:
Resource Profile ID
Read Only:true
The unique primary key identifier for the resource profile. -
ResourceType: string
Title:
Usage
The type of resource, such as employee. -
StartDateActive: string
(date)
Title:
Effective As-of Date
Date on which the resource becomes active. -
UpdateFlag: boolean
Read Only:
true
Indicates if the user can update the resource. -
Url: string
Title:
Primary URL
Read Only:true
Maximum Length:2000
The primary URL of the resource. -
Usage: string
Title:
Usages
The read-only party usage for the resource party. -
Username: string
Title:
User Name
Read Only:true
Name of the user account associated with this resource
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Picture Attachments
Type:
array
Title:
Picture Attachments
The picture attachments resource is used to view the picture of a resource.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : resources-PictureAttachment-item-response
Type:
Show Source
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
The unique identifier used for tracking the uploaded files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
The unique identifier of the attached picture document. -
CategoryName: string
Title:
Category
Maximum Length:30
The name of the category of the picture attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
The user who uploaded the picture attachment. -
CreatedByUserName: string
Title:
Created By User Name
Read Only:true
The user name of the person who uploaded the picture attachment. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the picture attachment was uploaded. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
The data type for the picture attachment. -
Description: string
Title:
Description
Maximum Length:255
The description of the picture attachment. -
DmDocumentId: string
Maximum Length:
255
The document ID from which the attachment is created. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
The folder path where the picture attachment exists. -
DmVersionNumber: string
Maximum Length:
255
The document version number from which the attachment is created. -
DownloadInfo: string
Title:
DownloadInfo
JSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
The error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
The error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
The expiration date of the contents in the attachment. -
FileContents: string
(byte)
Title:
File Contents
The contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
The name of the attachment file. -
FileUrl: string
Title:
File Url
The URL of the attachment file. -
FileWebImage: string
(byte)
Title:
File Web Image
Read Only:true
The base64 encoded image of the file displayed in .png format if the source is a convertible image. -
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:255
The user who last updated the record. -
LastUpdatedByUserName: string
Title:
Last Updated By User
Read Only:true
The user name of the person who last updated the picture attachment. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Title: string
Title:
Title
The title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
The content type of the attachment. -
UploadedFileLength: integer
Title:
File Size
The length of the attachment file. -
UploadedFileName: string
Title:
Uploaded File Name
The name of the attachment file. -
UploadedText: string
Title:
Uploaded Text
The text uploaded in the attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
The URI of the attachment. -
Url: string
Title:
Url
Maximum Length:4000
The URL of the attachment. -
UserName: string
Title:
User Name
Maximum Length:255
The login associated with the attachment.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- PictureAttachment
-
Parameters:
- PartyNumber:
$request.path.PartyNumber
The picture attachments resource is used to view the picture of a resource. - PartyNumber:
- SearchFilters
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_HZ_RESOURCE_SEARCH_REC_SET
The following properties are defined on the LOV link relation:- Source Attribute: RecordSet; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder: