Jump to

• Request
• Response

Update a subscription relationship

patch

/crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/relationships/{OperationLinksPuid}

Request

Path Parameters

• OperationLinksPuid(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=
• SubscriptionNumber(required): string
  The alternate identifier of the subscription.
• SubscriptionProductPuid(required): string
  The subscription product PUID.

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

• OperationLinksPuid: string
  Title: Operation Links PUID

  Maximum Length: 120

  The operation links PUID.
• SourceAssetKey: string
  Title: Source Asset Key

  Maximum Length: 120

  The source asset key.
• SourceProdAssociationId: integer (int64)
  Title: Source Product Association ID

  The unique identifier of the source product association.
• SourceProdAssociationPuid: string
  Title: Source Product Association PUID

  Maximum Length: 120

  The source product association PUID.
• SourceProductPuid: string
  Title: Source Product PUID

  Maximum Length: 120

  The source product PUID.
• SourceRootAssetKey: string
  Title: Source Root Asset Key

  Maximum Length: 120

  The source root asset key.
• TargetProdAssociationId: integer (int64)
  Title: Target Product Association ID

  The unique identifier of the target product association.
• TargetProdAssociationPuid: string
  Title: Target Product Association PUID

  Maximum Length: 120

  The target product association PUID.
• TargetProductPuid: string
  Title: Target Product PUID

  Maximum Length: 120

  The target product PUID.

{
    "type":"object",
    "properties":{
        "OperationLinksPuid":{
            "title":"Operation Links PUID",
            "maxLength":120,
            "type":"string",
            "description":"The operation links PUID.",
            "nullable":true
        },
        "SourceAssetKey":{
            "title":"Source Asset Key",
            "maxLength":120,
            "type":"string",
            "description":"The source asset key.",
            "nullable":true
        },
        "SourceProdAssociationId":{
            "title":"Source Product Association ID",
            "type":"integer",
            "description":"The unique identifier of the source product association.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "SourceProdAssociationPuid":{
            "title":"Source Product Association PUID",
            "maxLength":120,
            "type":"string",
            "description":"The source product association PUID.",
            "nullable":true
        },
        "SourceProductPuid":{
            "title":"Source Product PUID",
            "maxLength":120,
            "type":"string",
            "description":"The source product PUID.",
            "nullable":true
        },
        "SourceRootAssetKey":{
            "title":"Source Root Asset Key",
            "maxLength":120,
            "type":"string",
            "description":"The source root asset key.",
            "nullable":true
        },
        "TargetProdAssociationId":{
            "title":"Target Product Association ID",
            "type":"integer",
            "description":"The unique identifier of the target product association.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "TargetProdAssociationPuid":{
            "title":"Target Product Association PUID",
            "maxLength":120,
            "type":"string",
            "description":"The target product association PUID.",
            "nullable":true
        },
        "TargetProductPuid":{
            "title":"Target Product PUID",
            "maxLength":120,
            "type":"string",
            "description":"The target product PUID.",
            "nullable":true
        }
    }
}

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 : subscriptions-products-relationships-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the record.
• CreationDate: string (date-time)
  Read Only: true

  The date when the record was created.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date when the record was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the record.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectVersionNumber: integer (int32)
  Read Only: true

  The object version number.
• OperationLinksPuid: string
  Title: Operation Links PUID

  Maximum Length: 120

  The operation links PUID.
• RelationshipTypeCode: string
  Title: Type

  Maximum Length: 30

  The relationship type code.
• SourceAssetKey: string
  Title: Source Asset Key

  Maximum Length: 120

  The source asset key.
• SourceProdAssociationId: integer (int64)
  Title: Source Product Association ID

  The unique identifier of the source product association.
• SourceProdAssociationPuid: string
  Title: Source Product Association PUID

  Maximum Length: 120

  The source product association PUID.
• SourceProductPuid: string
  Title: Source Product PUID

  Maximum Length: 120

  The source product PUID.
• SourceRootAssetKey: string
  Title: Source Root Asset Key

  Maximum Length: 120

  The source root asset key.
• TargetProdAssociationId: integer (int64)
  Title: Target Product Association ID

  The unique identifier of the target product association.
• TargetProdAssociationPuid: string
  Title: Target Product Association PUID

  Maximum Length: 120

  The target product association PUID.
• TargetProductPuid: string
  Title: Target Product PUID

  Maximum Length: 120

  The target product PUID.

{
    "type":"object",
    "properties":{
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "OperationLinksPuid":{
            "title":"Operation Links PUID",
            "maxLength":120,
            "type":"string",
            "description":"The operation links PUID.",
            "nullable":true,
            "x-queryable":true
        },
        "RelationshipTypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"The relationship type code.",
            "nullable":false,
            "x-queryable":true
        },
        "SourceAssetKey":{
            "title":"Source Asset Key",
            "maxLength":120,
            "type":"string",
            "description":"The source asset key.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceProdAssociationId":{
            "title":"Source Product Association ID",
            "type":"integer",
            "description":"The unique identifier of the source product association.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SourceProdAssociationPuid":{
            "title":"Source Product Association PUID",
            "maxLength":120,
            "type":"string",
            "description":"The source product association PUID.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceProductPuid":{
            "title":"Source Product PUID",
            "maxLength":120,
            "type":"string",
            "description":"The source product PUID.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceRootAssetKey":{
            "title":"Source Root Asset Key",
            "maxLength":120,
            "type":"string",
            "description":"The source root asset key.",
            "nullable":true,
            "x-queryable":true
        },
        "TargetProdAssociationId":{
            "title":"Target Product Association ID",
            "type":"integer",
            "description":"The unique identifier of the target product association.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TargetProdAssociationPuid":{
            "title":"Target Product Association PUID",
            "maxLength":120,
            "type":"string",
            "description":"The target product association PUID.",
            "nullable":true,
            "x-queryable":true
        },
        "TargetProductPuid":{
            "title":"Target Product PUID",
            "maxLength":120,
            "type":"string",
            "description":"The target product PUID.",
            "nullable":true,
            "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 : 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."
        }
    }
}

Back to Top