Jump to

• Request
• Response

Create a related communication resource

post

/fscmRestApi/resources/11.13.18.05/publicSectorCommunicationResources/{ResourceId}/child/CommResourceRelations

Request

Path Parameters

• ResourceId(required): integer(int64)
  The unique identifier of the communication resource. This ID is automatically generated by the application.

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.
• Upsert-Mode: string
  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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• AnchorFifthKeyName: string
  Maximum Length: 100

  The fifth key name for the anchor communication resource.
• AnchorFirstKeyName: string
  Maximum Length: 100

  The first key name for the anchor communication resource.
• AnchorFourthKeyName: string
  Maximum Length: 100

  The fourth key name for the anchor communication resource.
• AnchorResourceId: integer (int64)
  The anchor resource ID.
• AnchorSecondKeyName: string
  Maximum Length: 100

  The second key name for the anchor communication resource.
• AnchorThirdKeyName: string
  Maximum Length: 100

  The third key name for the anchor communication resource.
• ContactTypeResFlag: string
  Maximum Length: 1

  Indicates whether the resource relationship is based on contact type. If Y, the relationship is contact-type-based. The default is N.
• DeletedFlag: string
  Maximum Length: 1

  Indicates whether the seed data is logically deleted. If Y, the seed data is deleted. The default is N.
• ModuleId: string
  Maximum Length: 32

  The module that owns the row. A module is an entry in the application taxonomy (for example, a logical business area). If no module is identified, the Seed Data Framework won???t extract the row as seed data.
• RelatedFifthKeyName: string
  Maximum Length: 100

  The fifth key name for the related communication resource.
• RelatedFirstKeyName: string
  Maximum Length: 100

  The first key name for the related communication resource.
• RelatedFourthKeyName: string
  Maximum Length: 100

  The fourth key name for the related communication resource.
• RelatedResourceId: integer (int64)
  The related resource ID.
• RelatedSecondKeyName: string
  Maximum Length: 100

  The second key name for the related communication resource.
• RelatedThirdKeyName: string
  Maximum Length: 100

  The third key name for the related communication resource.
• ResourceRelationCode: string
  Maximum Length: 100

  The unique code for the related communication resource.
• ResourceRelationId: integer (int64)
  The unique ID for the related communication resource, which is automatically generated by the application.
• SeedDataLock: integer (int32)
  Indicates the level at which seed data is locked: 0 = customer data, 1 = fields are read-only, 2 = only some fields can be updated.
• SeedDataSource: string
  Maximum Length: 512

  Indicates the source of the seed data.

{
    "type":"object",
    "properties":{
        "AnchorFifthKeyName":{
            "maxLength":100,
            "type":"string",
            "description":"The fifth key name for the anchor communication resource.",
            "nullable":true
        },
        "AnchorFirstKeyName":{
            "maxLength":100,
            "type":"string",
            "description":"The first key name for the anchor communication resource.",
            "nullable":true
        },
        "AnchorFourthKeyName":{
            "maxLength":100,
            "type":"string",
            "description":"The fourth key name for the anchor communication resource.",
            "nullable":true
        },
        "AnchorResourceId":{
            "type":"integer",
            "description":"The anchor resource ID.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "AnchorSecondKeyName":{
            "maxLength":100,
            "type":"string",
            "description":"The second key name for the anchor communication resource.",
            "nullable":true
        },
        "AnchorThirdKeyName":{
            "maxLength":100,
            "type":"string",
            "description":"The third key name for the anchor communication resource.",
            "nullable":true
        },
        "ContactTypeResFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the resource relationship is based on contact type. If Y, the relationship is contact-type-based. The default is N.",
            "nullable":false
        },
        "DeletedFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the seed data is logically deleted. If Y, the seed data is deleted. The default is N.",
            "nullable":false
        },
        "ModuleId":{
            "maxLength":32,
            "type":"string",
            "description":"The module that owns the row. A module is an entry in the application taxonomy (for example, a logical business area). If no module is identified, the Seed Data Framework won???t extract the row as seed data.",
            "nullable":true
        },
        "RelatedFifthKeyName":{
            "maxLength":100,
            "type":"string",
            "description":"The fifth key name for the related communication resource.",
            "nullable":true
        },
        "RelatedFirstKeyName":{
            "maxLength":100,
            "type":"string",
            "description":"The first key name for the related communication resource.",
            "nullable":true
        },
        "RelatedFourthKeyName":{
            "maxLength":100,
            "type":"string",
            "description":"The fourth key name for the related communication resource.",
            "nullable":true
        },
        "RelatedResourceId":{
            "type":"integer",
            "description":"The related resource ID.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "RelatedSecondKeyName":{
            "maxLength":100,
            "type":"string",
            "description":"The second key name for the related communication resource.",
            "nullable":true
        },
        "RelatedThirdKeyName":{
            "maxLength":100,
            "type":"string",
            "description":"The third key name for the related communication resource.",
            "nullable":true
        },
        "ResourceRelationCode":{
            "maxLength":100,
            "type":"string",
            "description":"The unique code for the related communication resource.",
            "nullable":false
        },
        "ResourceRelationId":{
            "type":"integer",
            "description":"The unique ID for the related communication resource, which is automatically generated by the application.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "SeedDataLock":{
            "type":"integer",
            "description":"Indicates the level at which seed data is locked: 0 = customer data, 1 = fields are read-only, 2 = only some fields can be updated.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":1
            }
        },
        "SeedDataSource":{
            "maxLength":512,
            "type":"string",
            "description":"Indicates the source of the seed data.",
            "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 : publicSectorCommunicationResources-CommResourceRelations-item-response

Type: object

Show Source

• AnchorFifthKeyName: string
  Maximum Length: 100

  The fifth key name for the anchor communication resource.
• AnchorFirstKeyName: string
  Maximum Length: 100

  The first key name for the anchor communication resource.
• AnchorFourthKeyName: string
  Maximum Length: 100

  The fourth key name for the anchor communication resource.
• AnchorResourceCode: string
  Title: Resource Code

  Read Only: true

  Maximum Length: 32

  The anchor resource code.
• AnchorResourceId: integer (int64)
  The anchor resource ID.
• AnchorSecondKeyName: string
  Maximum Length: 100

  The second key name for the anchor communication resource.
• AnchorThirdKeyName: string
  Maximum Length: 100

  The third key name for the anchor communication resource.
• ContactTypeResFlag: string
  Maximum Length: 1

  Indicates whether the resource relationship is based on contact type. If Y, the relationship is contact-type-based. The default is N.
• DeletedFlag: string
  Maximum Length: 1

  Indicates whether the seed data is logically deleted. If Y, the seed data is deleted. The default is N.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ModuleId: string
  Maximum Length: 32

  The module that owns the row. A module is an entry in the application taxonomy (for example, a logical business area). If no module is identified, the Seed Data Framework won???t extract the row as seed data.
• RelatedFifthKeyName: string
  Maximum Length: 100

  The fifth key name for the related communication resource.
• RelatedFirstKeyName: string
  Maximum Length: 100

  The first key name for the related communication resource.
• RelatedFourthKeyName: string
  Maximum Length: 100

  The fourth key name for the related communication resource.
• RelatedResourceCode: string
  Title: Resource Code

  Read Only: true

  Maximum Length: 32

  The related resource code.
• RelatedResourceId: integer (int64)
  The related resource ID.
• RelatedSecondKeyName: string
  Maximum Length: 100

  The second key name for the related communication resource.
• RelatedThirdKeyName: string
  Maximum Length: 100

  The third key name for the related communication resource.
• ResourceRelationCode: string
  Maximum Length: 100

  The unique code for the related communication resource.
• ResourceRelationId: integer (int64)
  The unique ID for the related communication resource, which is automatically generated by the application.
• SeedDataLock: integer (int32)
  Indicates the level at which seed data is locked: 0 = customer data, 1 = fields are read-only, 2 = only some fields can be updated.
• SeedDataSource: string
  Maximum Length: 512

  Indicates the source of the seed data.

{
    "type":"object",
    "properties":{
        "AnchorFifthKeyName":{
            "maxLength":100,
            "type":"string",
            "description":"The fifth key name for the anchor communication resource.",
            "nullable":true,
            "x-queryable":true
        },
        "AnchorFirstKeyName":{
            "maxLength":100,
            "type":"string",
            "description":"The first key name for the anchor communication resource.",
            "nullable":true,
            "x-queryable":true
        },
        "AnchorFourthKeyName":{
            "maxLength":100,
            "type":"string",
            "description":"The fourth key name for the anchor communication resource.",
            "nullable":true,
            "x-queryable":true
        },
        "AnchorResourceCode":{
            "title":"Resource Code",
            "maxLength":32,
            "type":"string",
            "description":"The anchor resource code.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AnchorResourceId":{
            "type":"integer",
            "description":"The anchor resource ID.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AnchorSecondKeyName":{
            "maxLength":100,
            "type":"string",
            "description":"The second key name for the anchor communication resource.",
            "nullable":true,
            "x-queryable":true
        },
        "AnchorThirdKeyName":{
            "maxLength":100,
            "type":"string",
            "description":"The third key name for the anchor communication resource.",
            "nullable":true,
            "x-queryable":true
        },
        "ContactTypeResFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the resource relationship is based on contact type. If Y, the relationship is contact-type-based. The default is N.",
            "nullable":false,
            "x-queryable":true
        },
        "DeletedFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the seed data is logically deleted. If Y, the seed data is deleted. The default is N.",
            "nullable":false,
            "x-queryable":true
        },
        "ModuleId":{
            "maxLength":32,
            "type":"string",
            "description":"The module that owns the row. A module is an entry in the application taxonomy (for example, a logical business area). If no module is identified, the Seed Data Framework won???t extract the row as seed data.",
            "nullable":true,
            "x-queryable":true
        },
        "RelatedFifthKeyName":{
            "maxLength":100,
            "type":"string",
            "description":"The fifth key name for the related communication resource.",
            "nullable":true,
            "x-queryable":true
        },
        "RelatedFirstKeyName":{
            "maxLength":100,
            "type":"string",
            "description":"The first key name for the related communication resource.",
            "nullable":true,
            "x-queryable":true
        },
        "RelatedFourthKeyName":{
            "maxLength":100,
            "type":"string",
            "description":"The fourth key name for the related communication resource.",
            "nullable":true,
            "x-queryable":true
        },
        "RelatedResourceCode":{
            "title":"Resource Code",
            "maxLength":32,
            "type":"string",
            "description":"The related resource code.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RelatedResourceId":{
            "type":"integer",
            "description":"The related resource ID.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RelatedSecondKeyName":{
            "maxLength":100,
            "type":"string",
            "description":"The second key name for the related communication resource.",
            "nullable":true,
            "x-queryable":true
        },
        "RelatedThirdKeyName":{
            "maxLength":100,
            "type":"string",
            "description":"The third key name for the related communication resource.",
            "nullable":true,
            "x-queryable":true
        },
        "ResourceRelationCode":{
            "maxLength":100,
            "type":"string",
            "description":"The unique code for the related communication resource.",
            "nullable":false,
            "x-queryable":true
        },
        "ResourceRelationId":{
            "type":"integer",
            "description":"The unique ID for the related communication resource, which is automatically generated by the application.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "SeedDataLock":{
            "type":"integer",
            "description":"Indicates the level at which seed data is locked: 0 = customer data, 1 = fields are read-only, 2 = only some fields can be updated.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":1
            },
            "x-queryable":true
        },
        "SeedDataSource":{
            "maxLength":512,
            "type":"string",
            "description":"Indicates the source of the seed data.",
            "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