Jump to

• Request
• Response

Update a report or template association

patch

/fscmRestApi/resources/11.13.18.05/projectProgramCommunicationAssociations/{projectProgramCommunicationAssociationsUniqID}

Request

Path Parameters

• projectProgramCommunicationAssociationsUniqID(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.

Header Parameters

• Effective-Of:
  This header accepts a string value. The string is a semi-colon separated list of =. It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers.
• 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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• Archived: string
  Maximum Length: 1

  Attribute indicating whether the reports are archived or not.
• AsOfPeriodName: string
  Maximum Length: 15

  The name of the program calendar period. The period with this name is the as-of-period for the measure time dimension.
• AssociationDescription: string
  Maximum Length: 240

  Description of the association.
• AssociationName: string
  Maximum Length: 240

  Name of the association.
• AutoPublish: string
  The indicator specifying if a report gets auto-published.
• AutoPublishCode: string
  Maximum Length: 1

  Default Value: N

  The code for the indicator specifying if a report gets auto-published.
• Currency: string
  Maximum Length: 255

  The currency used for monetary amounts in the report.
• CurrencyCode: string
  Maximum Length: 15

  The currency code used for monetary amounts in the report.
• Frequency: string
  The frequency for publishing the report for associated objects like daily, weekly, biweekly, monthly, quarterly, or yearly.
• FrequencyCode: string
  Maximum Length: 18

  Default Value: ORA_PJS_MONTHLY

  The frequency code for publishing the report for associated objects.
• InactiveFlag: boolean
  Maximum Length: 1

  Indicates the status of the report or a template. Only active templates can generate reports.
• OwnerPersonId: integer (int64)
  Person-ID of the template or report owner.
• ReportId: integer (int64)
  The unique identifier of a template or report.
• ScheduleStartDate: string (date-time)
  The start date for publishing a report based on its frequency.
• SourceObjectId: integer (int64)
  The unique identifier of an object to which the report belongs or a template is associated.
• TemplateFlag: boolean
  Maximum Length: 1

  The indicator specifying if the record is for a template or report.

{
    "type":"object",
    "properties":{
        "AssociationName":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the association.",
            "nullable":false
        },
        "AsOfPeriodName":{
            "maxLength":15,
            "type":"string",
            "description":"The name of the program calendar period. The period with this name is the as-of-period for the measure time dimension.",
            "nullable":true
        },
        "ReportId":{
            "type":"integer",
            "description":"The unique identifier of a template or report.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "PAYLOADHINT":"Show"
            }
        },
        "ScheduleStartDate":{
            "type":"string",
            "description":"The start date for publishing a report based on its frequency.",
            "format":"date-time",
            "nullable":true
        },
        "InactiveFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates the status of the report or a template. Only active templates can generate reports.",
            "nullable":true
        },
        "Archived":{
            "maxLength":1,
            "type":"string",
            "description":"Attribute indicating whether the reports are archived or not.",
            "nullable":true
        },
        "CurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"The currency code used for monetary amounts in the report.",
            "nullable":true
        },
        "FrequencyCode":{
            "maxLength":18,
            "type":"string",
            "description":"The frequency code for publishing the report for associated objects.",
            "nullable":true,
            "default":"ORA_PJS_MONTHLY"
        },
        "SourceObjectId":{
            "type":"integer",
            "description":"The unique identifier of an object to which the report belongs or a template is associated.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "AutoPublishCode":{
            "maxLength":1,
            "type":"string",
            "description":"The code for the indicator specifying if a report gets auto-published.",
            "nullable":true,
            "default":"N",
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "Currency":{
            "maxLength":255,
            "type":"string",
            "description":"The currency used for monetary amounts in the report.",
            "nullable":true
        },
        "AutoPublish":{
            "type":"string",
            "description":"The indicator specifying if a report gets auto-published.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Frequency":{
            "type":"string",
            "description":"The frequency for publishing the report for associated objects like daily, weekly, biweekly, monthly, quarterly, or yearly.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "AssociationDescription":{
            "maxLength":240,
            "type":"string",
            "description":"Description of the association.",
            "nullable":true
        },
        "OwnerPersonId":{
            "type":"integer",
            "description":"Person-ID of the template or report owner.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "TemplateFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"The indicator specifying if the record is for a template or report.",
            "nullable":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        }
    }
}

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 : projectProgramCommunicationAssociations-item-response

Type: object

Show Source

• Archived: string
  Maximum Length: 1

  Attribute indicating whether the reports are archived or not.
• AsOfPeriodName: string
  Maximum Length: 15

  The name of the program calendar period. The period with this name is the as-of-period for the measure time dimension.
• AssociationDescription: string
  Maximum Length: 240

  Description of the association.
• AssociationId: integer (int64)
  Read Only: true

  The unique identifier of an association of template or report to a business object.
• AssociationName: string
  Maximum Length: 240

  Name of the association.
• AutoPublish: string
  The indicator specifying if a report gets auto-published.
• AutoPublishCode: string
  Maximum Length: 1

  Default Value: N

  The code for the indicator specifying if a report gets auto-published.
• 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.
• Currency: string
  Maximum Length: 255

  The currency used for monetary amounts in the report.
• CurrencyCode: string
  Maximum Length: 15

  The currency code used for monetary amounts in the report.
• Frequency: string
  The frequency for publishing the report for associated objects like daily, weekly, biweekly, monthly, quarterly, or yearly.
• FrequencyCode: string
  Maximum Length: 18

  Default Value: ORA_PJS_MONTHLY

  The frequency code for publishing the report for associated objects.
• InactiveFlag: boolean
  Maximum Length: 1

  Indicates the status of the report or a template. Only active templates can generate reports.
• LastGeneratedDate: string (date-time)
  Read Only: true

  The last generated date of the report.
• 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.
• NextDueDate: string (date-time)
  Read Only: true

  The next due publishing date of the report.
• OwnerPersonEmail: string
  Title: Email

  Read Only: true

  Maximum Length: 240

  Email of the template or report owner.
• OwnerPersonId: integer (int64)
  Person-ID of the template or report owner.
• OwnerPersonName: string
  Title: Name

  Read Only: true

  Maximum Length: 240

  The template or report owner.
• ReportId: integer (int64)
  The unique identifier of a template or report.
• ScheduleStartDate: string (date-time)
  The start date for publishing a report based on its frequency.
• SourceObjectId: integer (int64)
  The unique identifier of an object to which the report belongs or a template is associated.
• SourceObjectName: string
  Read Only: true

  Maximum Length: 240

  The name of the business object to which the report belongs, or the template is associated.
• SourceObjectNumber: string
  Title: Program Number

  Read Only: true

  Maximum Length: 25

  The unique number identifier of the business object to which the report belongs, or the template is associated.
• SourceObjectPublicFlag: boolean
  Title: Public access

  Read Only: true

  Maximum Length: 1

  Default Value: false

  The public access indicator for the program with which a report or template is associated. For example, if the report is associated with the North America Implementations program, this attribute indicates whether the program can be publicly accessed within the organization.
• SourceObjectUserAccess: string
  Title: Access Type Code

  Read Only: true

  Maximum Length: 30

  The access type that a logged-in user has to the program or template associated with a report. For example, if the report belongs to the North America Implementations program and the logged-in user owns the program, this attribute has the value ORA_PJS_OWNER.
• Status: string
  Read Only: true

  Maximum Length: 255

  The status of the template or report like draft, unpublished, or published.
• StatusCode: string
  Read Only: true

  Maximum Length: 255

  The code for the status of the template or report like DRAFT, UNPUBLISHED, or PUBLISHED.
• TemplateFlag: boolean
  Maximum Length: 1

  The indicator specifying if the record is for a template or report.

{
    "type":"object",
    "properties":{
        "LastGeneratedDate":{
            "type":"string",
            "description":"The last generated date of the report.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssociationName":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the association.",
            "nullable":false,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OwnerPersonEmail":{
            "title":"Email",
            "maxLength":240,
            "type":"string",
            "description":"Email of the template or report owner.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AsOfPeriodName":{
            "maxLength":15,
            "type":"string",
            "description":"The name of the program calendar period. The period with this name is the as-of-period for the measure time dimension.",
            "nullable":true,
            "x-queryable":true
        },
        "ScheduleStartDate":{
            "type":"string",
            "description":"The start date for publishing a report based on its frequency.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "StatusCode":{
            "maxLength":255,
            "type":"string",
            "description":"The code for the status of the template or report like DRAFT, UNPUBLISHED, or PUBLISHED.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceObjectPublicFlag":{
            "title":"Public access",
            "maxLength":1,
            "type":"boolean",
            "description":"The public access indicator for the program with which a report or template is associated. For example, if the report is associated with the North America Implementations program, this attribute indicates whether the program can be publicly accessed within the organization.",
            "nullable":false,
            "readOnly":true,
            "default":false,
            "x-queryable":true
        },
        "Archived":{
            "maxLength":1,
            "type":"string",
            "description":"Attribute indicating whether the reports are archived or not.",
            "nullable":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"The currency code used for monetary amounts in the report.",
            "nullable":true,
            "x-queryable":true
        },
        "FrequencyCode":{
            "maxLength":18,
            "type":"string",
            "description":"The frequency code for publishing the report for associated objects.",
            "nullable":true,
            "default":"ORA_PJS_MONTHLY",
            "x-queryable":true
        },
        "SourceObjectUserAccess":{
            "title":"Access Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The access type that a logged-in user has to the program or template associated with a report. For example, if the report belongs to the North America Implementations program and the logged-in user owns the program, this attribute has the value ORA_PJS_OWNER.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Currency":{
            "maxLength":255,
            "type":"string",
            "description":"The currency used for monetary amounts in the report.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AssociationDescription":{
            "maxLength":240,
            "type":"string",
            "description":"Description of the association.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Status":{
            "maxLength":255,
            "type":"string",
            "description":"The status of the template or report like draft, unpublished, or published.",
            "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
        },
        "ReportId":{
            "type":"integer",
            "description":"The unique identifier of a template or report.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "NextDueDate":{
            "type":"string",
            "description":"The next due publishing date of the report.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InactiveFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates the status of the report or a template. Only active templates can generate reports.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceObjectName":{
            "maxLength":240,
            "type":"string",
            "description":"The name of the business object to which the report belongs, or the template is associated.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceObjectId":{
            "type":"integer",
            "description":"The unique identifier of an object to which the report belongs or a template is associated.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AutoPublishCode":{
            "maxLength":1,
            "type":"string",
            "description":"The code for the indicator specifying if a report gets auto-published.",
            "nullable":true,
            "default":"N",
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "SourceObjectNumber":{
            "title":"Program Number",
            "maxLength":25,
            "type":"string",
            "description":"The unique number identifier of the business object to which the report belongs, or the template is associated.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OwnerPersonName":{
            "title":"Name",
            "maxLength":240,
            "type":"string",
            "description":"The template or report owner.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AutoPublish":{
            "type":"string",
            "description":"The indicator specifying if a report gets auto-published.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Frequency":{
            "type":"string",
            "description":"The frequency for publishing the report for associated objects like daily, weekly, biweekly, monthly, quarterly, or yearly.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "OwnerPersonId":{
            "type":"integer",
            "description":"Person-ID of the template or report owner.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AssociationId":{
            "type":"integer",
            "description":"The unique identifier of an association of template or report to a business object.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "TemplateFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"The indicator specifying if the record is for a template or report.",
            "nullable":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "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