Jump to

• Request
• Response

Update a subscription account asset relationship

patch

/crmRestApi/resources/11.13.18.05/subscriptionAccounts/{SubscrAccountNumber}/child/subscriptionAccountAssetRelationships/{SubscriptionAccountAssetRelationshipNumber}

Request

Path Parameters

• SubscrAccountNumber(required): string
  The alternate unique identifier of the subscription account.
• SubscriptionAccountAssetRelationshipNumber(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=

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.

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 asset.
• RelationshipType: string
  Title: Relationship Type

  Maximum Length: 30

  Indicates the relationship between the subscription account and the asset.
• SubscrAccountNumber: string
  Title: Subscription Account Number

  Maximum Length: 30

  The alternate unique identifier of the subscription account.
• SubscriptionAccountAssetRelationshipId: integer (int64)
  Title: Subscription Account Asset Relationship ID

  The alternate unique identifier of subscription account asset relationship.
• SubscriptionAccountId: integer (int64)
  Title: Subscription Account ID

  The unique identifier of the subscription account.

{
    "type":"object",
    "properties":{
        "AssetId":{
            "title":"Asset ID",
            "type":"integer",
            "description":"The unique identifier of asset.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "RelationshipType":{
            "title":"Relationship Type",
            "maxLength":30,
            "type":"string",
            "description":"Indicates the relationship between the subscription account and the asset.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SubscrAccountNumber":{
            "title":"Subscription Account Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternate unique identifier of the subscription account.",
            "nullable":false
        },
        "SubscriptionAccountAssetRelationshipId":{
            "title":"Subscription Account Asset Relationship ID",
            "type":"integer",
            "description":"The alternate unique identifier of subscription account asset relationship.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "SubscriptionAccountId":{
            "title":"Subscription Account ID",
            "type":"integer",
            "description":"The unique identifier of the subscription account.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        }
    }
}

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 : subscriptionAccounts-subscriptionAccountAssetRelationships-item-response

Type: object

Show Source

• AssetId: integer (int64)
  Title: Asset ID

  The unique identifier of asset.
• AssetNumber: string
  Read Only: true

  Maximum Length: 80

  The alternate unique identifier of the asset.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the subscription account asset relationship.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the subscription account asset relationship was created.
• DeleteFlag: boolean
  Read Only: true

  Indicates whether the user can delete the subscription account asset relationship.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date when the subscription account asset relationship was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the subscription account asset relationship.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the subscription account asset relationship.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• RelationshipType: string
  Title: Relationship Type

  Maximum Length: 30

  Indicates the relationship between the subscription account and the asset.
• SubscrAccountNumber: string
  Title: Subscription Account Number

  Maximum Length: 30

  The alternate unique identifier of the subscription account.
• SubscriptionAccountAssetRelationshipId: integer (int64)
  Title: Subscription Account Asset Relationship ID

  The alternate unique identifier of subscription account asset relationship.
• SubscriptionAccountAssetRelationshipNumber: string
  Title: Subscription Account Asset Relationship Number

  Maximum Length: 30

  The unique identifier of the subscription account asset relationship.
• SubscriptionAccountId: integer (int64)
  Title: Subscription Account ID

  The unique identifier of the subscription account.
• UpdateFlag: boolean
  Read Only: true

  Indicates whether the user can update the subscription account asset relationship.

{
    "type":"object",
    "properties":{
        "AssetId":{
            "title":"Asset ID",
            "type":"integer",
            "description":"The unique identifier of asset.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AssetNumber":{
            "maxLength":80,
            "type":"string",
            "description":"The alternate unique identifier of the asset.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the subscription account asset relationship.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the subscription account asset relationship was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DeleteFlag":{
            "type":"boolean",
            "description":"Indicates whether the user can delete the subscription account asset relationship.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the subscription account asset relationship 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 of the user who last updated the subscription account asset relationship.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the subscription account asset relationship.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RelationshipType":{
            "title":"Relationship Type",
            "maxLength":30,
            "type":"string",
            "description":"Indicates the relationship between the subscription account and the asset.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SubscrAccountNumber":{
            "title":"Subscription Account Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternate unique identifier of the subscription account.",
            "nullable":false,
            "x-queryable":true
        },
        "SubscriptionAccountAssetRelationshipId":{
            "title":"Subscription Account Asset Relationship ID",
            "type":"integer",
            "description":"The alternate unique identifier of subscription account asset relationship.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SubscriptionAccountAssetRelationshipNumber":{
            "title":"Subscription Account Asset Relationship Number",
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier of the subscription account asset relationship.",
            "nullable":false,
            "x-queryable":true
        },
        "SubscriptionAccountId":{
            "title":"Subscription Account ID",
            "type":"integer",
            "description":"The unique identifier of the subscription account.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "UpdateFlag":{
            "type":"boolean",
            "description":"Indicates whether the user can update the subscription account asset relationship.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "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 : 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

RelationshipTypeListVA

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DORA_ATC_SUB_ACC_ASSET_REL_TYPE

The following properties are defined on the LOV link relation:

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

Back to Top