Jump to

• Request
• Response
• Examples

Get a resource role

get

/crmRestApi/resources/11.13.18.05/resourceRoles/{RoleCode}

Request

Path Parameters

• RoleCode(required): string
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

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 : resourceRoles-item-response

Type: object

Show Source

• ActiveFlag: boolean
  Title: Active Flag

  Maximum Length: 1

  Default Value: true

  Flag to indicate if role is active.
• AdministratorFlag: boolean
  Title: Administrator

  Maximum Length: 1

  Default Value: false

  Flag indicating if this role is an administrator role or not.
• 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.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  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
  Read Only: true

  Maximum Length: 32

  Who column: indicates the session login associated to the user who last updated the row.
• LeadFlag: boolean
  Title: Lead

  Maximum Length: 1

  Default Value: false

  Flag indicating if this role is a leader role or not.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ManagerFlag: boolean
  Title: Manager

  Maximum Length: 1

  Default Value: false

  Flag indicating if this role is a manager role or not.
• MemberFlag: boolean
  Title: Member

  Maximum Length: 1

  Default Value: true

  Flag indicating if this role is a member role or not.
• ObjectVersionNumber: integer (int32)
  Read Only: true

  Used to implement optimistic locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.
• RoleCode: string
  Title: Role Code

  Maximum Length: 30

  Unqiue code for a resource role.
• RoleCodeTypeSwitcher: string
  Title: Role Code Type Switcher

  Read Only: true

  The switcher used for the role type code list of values.
• RoleDescription: string
  Title: Role Description

  Maximum Length: 120

  Description for role.
• RoleId: integer
  Title: Role ID

  Read Only: true

  Unique identifier for the role.
• RoleName: string
  Title: Role Name

  Maximum Length: 60

  Resource role name.
• RoleTypeCode: string
  Title: Role Type

  Maximum Length: 240

  Role type identifier.
• SeededFlag: boolean
  Title: System

  Read Only: true

  Maximum Length: 1

  Default Value: false

  Flag indicating pre-defined role types.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"Who column: indicates the user who last updated the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Who column: indicates the date and time of the creation of the row.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"Who column: indicates the user who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ManagerFlag":{
            "title":"Manager",
            "maxLength":1,
            "type":"boolean",
            "description":"Flag indicating if this role is a manager role or not.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "AdministratorFlag":{
            "title":"Administrator",
            "maxLength":1,
            "type":"boolean",
            "description":"Flag indicating if this role is an administrator role or not.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "RoleDescription":{
            "title":"Role Description",
            "maxLength":120,
            "type":"string",
            "description":"Description for role.",
            "nullable":true,
            "x-queryable":true
        },
        "RoleCodeTypeSwitcher":{
            "title":"Role Code Type Switcher",
            "type":"string",
            "description":"The switcher used for the role type code list of values.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RoleId":{
            "title":"Role ID",
            "type":"integer",
            "description":"Unique identifier for the role.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "SeededFlag":{
            "title":"System",
            "maxLength":1,
            "type":"boolean",
            "description":"Flag indicating pre-defined role types.",
            "nullable":true,
            "readOnly":true,
            "default":false,
            "x-queryable":true
        },
        "RoleCode":{
            "title":"Role Code",
            "maxLength":30,
            "type":"string",
            "description":"Unqiue code for a resource role.",
            "nullable":false,
            "x-queryable":true
        },
        "ActiveFlag":{
            "title":"Active Flag",
            "maxLength":1,
            "type":"boolean",
            "description":"Flag to indicate if role is active.",
            "nullable":false,
            "default":true,
            "x-queryable":true
        },
        "RoleName":{
            "title":"Role Name",
            "maxLength":60,
            "type":"string",
            "description":"Resource role name.",
            "nullable":false,
            "x-queryable":true
        },
        "RoleTypeCode":{
            "title":"Role Type",
            "maxLength":240,
            "type":"string",
            "description":"Role type identifier.",
            "nullable":false,
            "x-hints":{
                "APPCORE_VIEW_APPLICATION_ID":"690",
                "controlType":"choice",
                "APPCORE_LOOKUP_TYPE":"JTF_RS_ROLE_TYPE"
            },
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Used to implement optimistic locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "MemberFlag":{
            "title":"Member",
            "maxLength":1,
            "type":"boolean",
            "description":"Flag indicating if this role is a member role or not.",
            "nullable":true,
            "default":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"Who column: indicates the date and time of the last update of the row.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"Who column: indicates the session login associated to the user who last updated the row.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LeadFlag":{
            "title":"Lead",
            "maxLength":1,
            "type":"boolean",
            "description":"Flag indicating if this role is a leader role or not.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        }
    }
}

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 : 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."
        }
    }
}

Links

RoleCodeTypeLookup

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DJTF_RS_ROLE_TYPE%2CLookupCode%3D{RoleTypeCode}

The following properties are defined on the LOV link relation:

• Source Attribute: RoleTypeCode; Target Attribute: LookupCode
• Display Attribute: Meaning

Back to Top

Examples

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

cURL Command

curl --user sales_cloud_user https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/resourceRoles/{RoleCode}

Example of Response Body

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

{
    "RoleId": 300100070297923,
    "RoleCode": "Code62d63997398",
    "RoleTypeCode": "SALES",
    "SeededFlag": false,
    "MemberFlag": true,
    "AdministratorFlag": false,
    "LeadFlag": false,
    "ManagerFlag": false,
    "ActiveFlag": false,
    "ObjectVersionNumber": 3,
    "RoleName": "RoleName0d363997383",
    "RoleDescription": "RoleDescription Updated",
    "CreatedBy": "MDM_ADMIN_V1",
    "CreationDate": "2015-03-28T10:33:18+00:00",
    "LastUpdatedBy": "MDM_ADMIN_V1",
    "LastUpdateDate": "2015-03-28T10:36:15.005+00:00",
    "LastUpdateLogin": "125CDE94B9534CBEE0531833F40AA419",
    "RoleCodeTypeSwitcher": "LOV_RoleTypeCodeVal",
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/resourceRoles/Code62d63997398",
            "name": "resourceRoles",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000378"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/resourceRoles/Code62d63997398",
            "name": "resourceRoles",
            "kind": "item"
        }
    ]
}

Back to Top