Create a relationship
post
/crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/relationships
Request
Path Parameters
-
CoveredLevelPuid(required): string
The public unique identifier of the covered level.
-
SubscriptionProductPuid(required): string
The public unique identifier of the subscription product.
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
OperationLinksPuid: string
Maximum Length:
120
The public unique identifier of the operation links. -
RelationshipTypeCode: string
Maximum Length:
30
The code indicating the type of the relationship. -
SourceAssetKey: string
Maximum Length:
120
The source asset key -
SourceProdAssociationId: integer
(int64)
The unique identifier of the source product association.
-
SourceProdAssociationPuid: string
Maximum Length:
120
The public unique identifier of the source product association. -
SourceProductPuid: string
Maximum Length:
120
The public unique identifier of the source product. -
SourceRootAssetKey: string
Maximum Length:
120
The source root asset key -
TargetProdAssociationId: integer
(int64)
The unique identifier of the target product association.
-
TargetProdAssociationPuid: string
Maximum Length:
120
The public unique identifier of the target product association. -
TargetProductPuid: string
Maximum Length:
120
The public unique identifier of the target product.
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.
Root Schema : subscriptionProducts-coveredLevels-relationships-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the relationship. -
CreationDate: string
(date-time)
Read Only:
true
The date when the relationship was created. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the relationship was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the relationship. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login details of the user who last updated the relationship. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
Read Only:
true
The number 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 determine whether another session has updated the row. -
OperationLinksPuid: string
Maximum Length:
120
The public unique identifier of the operation links. -
RelationshipTypeCode: string
Maximum Length:
30
The code indicating the type of the relationship. -
SourceAssetKey: string
Maximum Length:
120
The source asset key -
SourceProdAssociationId: integer
(int64)
The unique identifier of the source product association.
-
SourceProdAssociationPuid: string
Maximum Length:
120
The public unique identifier of the source product association. -
SourceProductPuid: string
Maximum Length:
120
The public unique identifier of the source product. -
SourceRootAssetKey: string
Maximum Length:
120
The source root asset key -
TargetProdAssociationId: integer
(int64)
The unique identifier of the target product association.
-
TargetProdAssociationPuid: string
Maximum Length:
120
The public unique identifier of the target product association. -
TargetProductPuid: string
Maximum Length:
120
The public unique identifier of the target product.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
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.