Jump to

• Request
• Response

Create a recipient of a report

post

/fscmRestApi/resources/11.13.18.05/projectProgramCommunications/{projectProgramCommunicationsUniqID}/child/Associations/{AssociationsUniqID}/child/CommunicationRecipients

Request

Path Parameters

• AssociationsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Project Program Communication Associations resource and used to uniquely identify an instance of Project Program Communication Associations. The client should not generate the hash key value. Instead, the client should query on the Project Program Communication Associations collection resource in order to navigate to a specific instance of Project Program Communication Associations to get the hash key.
• projectProgramCommunicationsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Project Program Communications resource and used to uniquely identify an instance of Project Program Communications. The client should not generate the hash key value. Instead, the client should query on the Project Program Communications collection resource in order to navigate to a specific instance of Project Program Communications to get the hash key.

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

• PersonId: integer (int64)
  Unique identifier of the person receiving the report.
• ReportRecipientId: integer (int64)
  Unique identifier of the report recipient.

{ "type":"object", "properties":{ "PersonId":{ "type":"integer", "description":"Unique identifier of the person receiving the report.", "format":"int64", "nullable":false, "x-hints":{ "precision":18 } }, "ReportRecipientId":{ "type":"integer", "description":"Unique identifier of the report recipient.", "format":"int64", "nullable":false, "x-hints":{ "precision":18, "fnd:GLOBALLY_UNIQUE":"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 : projectProgramCommunications-Associations-CommunicationRecipients-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 details of user who last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PersonEmail: string
  Title: Email

  Read Only: true

  Maximum Length: 240

  Email of the person receiving the report.
• PersonId: integer (int64)
  Unique identifier of the person receiving the report.
• PersonName: string
  Title: Name

  Read Only: true

  Maximum Length: 240

  Name of the person receiving the report.
• ReportRecipientId: integer (int64)
  Unique identifier of the report recipient.

{ "type":"object", "properties":{ "LastUpdatedBy":{ "maxLength":64, "type":"string", "description":"The user who last updated 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 }, "PersonName":{ "title":"Name", "maxLength":240, "type":"string", "description":"Name of the person receiving the report.", "nullable":true, "readOnly":true, "x-queryable":true }, "CreatedBy":{ "maxLength":64, "type":"string", "description":"The user who created the record.", "nullable":false, "readOnly":true, "x-queryable":true }, "PersonId":{ "type":"integer", "description":"Unique identifier of the person receiving the report.", "format":"int64", "nullable":false, "x-hints":{ "precision":18 }, "x-queryable":true }, "links":{ "title":"Links", "type":"array", "description":"The link relations associated with the resource instance.", "items":{ "$ref":"#/components/schemas/link" } }, "PersonEmail":{ "title":"Email", "maxLength":240, "type":"string", "description":"Email of the person receiving the report.", "nullable":true, "readOnly":true, "x-queryable":true }, "ReportRecipientId":{ "type":"integer", "description":"Unique identifier of the report recipient.", "format":"int64", "nullable":false, "x-hints":{ "precision":18, "fnd:GLOBALLY_UNIQUE":"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 details of user who last updated the record.", "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." } } }

Back to Top