Jump to

• Request
• Response
• Examples

Update an asset resource

patch

/crmRestApi/resources/11.13.18.05/assets/{AssetId}/child/assetResources/{AssetResourceId}

Request

Path Parameters

• AssetId(required): integer(int64)
  The unique identifier of the asset.
• AssetResourceId(required): integer(int64)
  The unique identifier of the resource associated with the asset.

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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• AssetId: integer (int64)
  Title: Asset ID

  The unique identifier of the Asset.
• EmailAddress: string
  Title: Email

  The e-mail address of the asset team member.
• MemberFunctionCode: string
  Title: Function

  Maximum Length: 30

  The code indicating the role of an asset resource in the resource team such as Integrator, Executive Sponsor, and Technical Account Manager. A list of valid values is defined in the lookup FND_LOOKUPS.
• OwnerFlag: boolean
  Title: Owner

  Indicates whether the asset resource is the owner of the asset.
• ResourceId: integer (int64)
  Title: Resource Party ID

  The identifier of the party associated with the asset resource.

{
    "type":"object",
    "properties":{
        "MemberFunctionCode":{
            "title":"Function",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the role of an asset resource in the resource team such as Integrator, Executive Sponsor, and Technical Account Manager. A list of valid values is defined in the lookup FND_LOOKUPS.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ResourceId":{
            "title":"Resource Party ID",
            "type":"integer",
            "description":"The identifier of the party associated with the asset resource.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            }
        },
        "AssetId":{
            "title":"Asset ID",
            "type":"integer",
            "description":"The unique identifier of the Asset.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "EmailAddress":{
            "title":"Email",
            "type":"string",
            "description":"The e-mail address of the asset team member.",
            "nullable":true
        },
        "OwnerFlag":{
            "title":"Owner",
            "type":"boolean",
            "description":"Indicates whether the asset resource is the owner of the asset.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "ResourceId"
                ]
            }
        }
    }
}

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 : assets-assetResources-item-response

Type: object

Show Source

• AssetId: integer (int64)
  Title: Asset ID

  The unique identifier of the Asset.
• AssetNumber: string
  Title: Asset Number

  Read Only: true

  Maximum Length: 100

  The number that identifies the asset.
• AssetResourceId: integer (int64)
  Title: Asset Resource ID

  The unique identifier of the resource associated with the asset.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created or imported the record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time when the record was created.
• EmailAddress: string
  Title: Email

  The e-mail address of the asset team member.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time 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.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The login details of the user who last updated the record in the interface table or submitted the import process.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MemberFunctionCode: string
  Title: Function

  Maximum Length: 30

  The code indicating the role of an asset resource in the resource team such as Integrator, Executive Sponsor, and Technical Account Manager. A list of valid values is defined in the lookup FND_LOOKUPS.
• OwnerFlag: boolean
  Title: Owner

  Indicates whether the asset resource is the owner of the asset.
• PartyId: integer (int64)
  Title: Party ID

  Read Only: true

  The unique identifier of the account, or contact associated with the asset.
• PartyName: string
  Title: Name

  Read Only: true

  Maximum Length: 360

  The name of the party associated with the asset resource.
• PrimaryPhoneAreaCode: string
  Title: Primary Phone Area Code

  Read Only: true

  Maximum Length: 20

  The phone area code of the asset resource.
• PrimaryPhoneCountryCode: string
  Title: Primary Phone Country Code

  Read Only: true

  Maximum Length: 10

  The phone country code of the asset resource.
• PrimaryPhoneExtension: string
  Title: Extension

  Read Only: true

  Maximum Length: 20

  The phone extension code of the asset resource.
• PrimaryPhoneLineType: string
  Title: Phone Line Type

  Read Only: true

  Maximum Length: 30

  The type of the phone line of the asset resource.
• PrimaryPhoneNumber: string
  Title: Phone

  Read Only: true

  Maximum Length: 40

  The primary phone number of the asset team member.
• ResourceId: integer (int64)
  Title: Resource Party ID

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

  Read Only: true

  Maximum Length: 30

  The unique identifier of the resource associated with the asset.
• RoleName: string
  Title: Title

  Read Only: true

  The name of the role of an asset resource in the resource team.
• Status: string
  Title: Party Status

  Read Only: true

  Maximum Length: 1

  The user-defined status of the asset team member.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Status":{
            "title":"Party Status",
            "maxLength":"1",
            "type":"string",
            "description":"The user-defined status of the asset team member.",
            "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
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created or imported the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryPhoneAreaCode":{
            "title":"Primary Phone Area Code",
            "maxLength":"20",
            "type":"string",
            "description":"The phone area code of the asset resource.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PhoneEO.PhoneAreaCode",
                "protectionObjectTitle":"Phone",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Area Code"
            },
            "x-queryable":true
        },
        "OwnerFlag":{
            "title":"Owner",
            "type":"boolean",
            "description":"Indicates whether the asset resource is the owner of the asset.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "ResourceId"
                ]
            }
        },
        "PrimaryPhoneLineType":{
            "title":"Phone Line Type",
            "maxLength":"30",
            "type":"string",
            "description":"The type of the phone line of the asset resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PartyName":{
            "title":"Name",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the party associated with the asset resource.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AssetNumber":{
            "title":"Asset Number",
            "maxLength":"100",
            "type":"string",
            "description":"The number that identifies the asset.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EmailAddress":{
            "title":"Email",
            "type":"string",
            "description":"The e-mail address of the asset team member.",
            "nullable":true,
            "x-queryable":true
        },
        "PrimaryPhoneCountryCode":{
            "title":"Primary Phone Country Code",
            "maxLength":"10",
            "type":"string",
            "description":"The phone country code of the asset resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryPhoneExtension":{
            "title":"Extension",
            "maxLength":"20",
            "type":"string",
            "description":"The phone extension code of the asset resource.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PhoneEO.PhoneExtension",
                "protectionObjectTitle":"Phone",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Extension"
            },
            "x-queryable":true
        },
        "RoleName":{
            "title":"Title",
            "type":"string",
            "description":"The name of the role of an asset resource in the resource team.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PartyId":{
            "title":"Party ID",
            "type":"integer",
            "description":"The unique identifier of the account, or contact associated with the asset.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ResourceId":{
            "title":"Resource Party ID",
            "type":"integer",
            "description":"The identifier of the party associated with the asset resource.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            },
            "x-queryable":true
        },
        "PrimaryPhoneNumber":{
            "title":"Phone",
            "maxLength":"40",
            "type":"string",
            "description":"The primary phone number of the asset team member.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PhoneEO.PhoneNumber",
                "protectionObjectTitle":"Phone",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Phone"
            },
            "x-queryable":true
        },
        "ResourcePartyNumber":{
            "title":"Resource Party Number",
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier of the resource associated with the asset.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MemberFunctionCode":{
            "title":"Function",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the role of an asset resource in the resource team such as Integrator, Executive Sponsor, and Technical Account Manager. A list of valid values is defined in the lookup FND_LOOKUPS.",
            "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"
            }
        },
        "AssetId":{
            "title":"Asset ID",
            "type":"integer",
            "description":"The unique identifier of the Asset.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AssetResourceId":{
            "title":"Asset Resource ID",
            "type":"integer",
            "description":"The unique identifier of the resource associated with the asset.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":"32",
            "type":"string",
            "description":"The login details of the user who last updated the record in the interface table or submitted the import process.",
            "nullable":true,
            "readOnly":true,
            "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

MemberFunctionLOV

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupCode%3D{MemberFunctionCode}%2CBindLookupType%3DORA_ZCM_TEAM_FUNCTION

The lookups resource is used to view standard lookup codes.

Back to Top

Examples

The following example shows how to update an asset resource by submitting a PATCH request on the REST resource using cURL.

cURL Command

curl -u <username:password> \ -X PATCH -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/assets/785805215/child/assetResources/300100168153882

Example of Request Body

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

{		
	"ResourceId": 28709      			  
}

Example of Response Body

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

{
    "AssetResourceId": 300100168153882,
    "AssetId": 785805215,
    "ResourceId": 28709,
    "MemberFunctionCode": null,
    "CreatedBy": "SALES_ADMIN",
    "CreationDate": "2018-09-25T10:07:21+00:00",
    "LastUpdatedBy": "SALES_ADMIN",
    "LastUpdateDate": "2018-09-25T10:11:55+00:00",
    "LastUpdateLogin": "76AF2964E73B33C2E053773AF80A77BF",
    "PartyName": "CYNTHIA SCHECHTER",
    "PartyId": 28709,
    "Status": "A",
    "EmailAddress": "[e-mail]",
    "PrimaryPhoneNumber": null,
    "PrimaryPhoneAreaCode": null,
    "PrimaryPhoneCountryCode": "1",
    "PrimaryPhoneExtension": null,
    "PrimaryPhoneLineType": "GEN",
    "OwnerFlag": false,
    "RoleName": "Salesperson",
    "ResourcePartyNumber": "19534",
    "links": [
		...
		]
	}

Back to Top