Jump to

• Request
• Response
• Examples

Run Publish PAR Policies process

post

/fscmRestApi/resources/11.13.18.05/publishParPolicies

Request

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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• JobId: integer
  Value that uniquely identifies the last publish PAR policies process.
• Message: string
  Maximum Length: 10000

  Text of the error message, if any, encountered when submitting the process.
• PlanId: integer
  Value that uniquely identifies the plan.
• PlanName: string
  Maximum Length: 32

  Name of the plan.
• SegmentIds: string
  Maximum Length: 3000

  Values that uniquely identifies the segments.
• SegmentNames: string
  Maximum Length: 3000

  Name of the segments.

{
    "type":"object",
    "properties":{
        "Message":{
            "maxLength":"10000",
            "type":"string",
            "description":"Text of the error message, if any, encountered when submitting the process.",
            "nullable":true
        },
        "PlanId":{
            "type":"integer",
            "description":"Value that uniquely identifies the plan.",
            "nullable":true
        },
        "SegmentNames":{
            "maxLength":"3000",
            "type":"string",
            "description":"Name of the segments.",
            "nullable":true
        },
        "SegmentIds":{
            "maxLength":"3000",
            "type":"string",
            "description":"Values that uniquely identifies the segments.",
            "nullable":true
        },
        "PlanName":{
            "maxLength":"32",
            "type":"string",
            "description":"Name of the plan.",
            "nullable":true
        },
        "JobId":{
            "type":"integer",
            "description":"Value that uniquely identifies the last publish PAR policies process.",
            "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 : publishParPolicies-item-response

Type: object

Show Source

• JobId: integer
  Value that uniquely identifies the last publish PAR policies process.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Message: string
  Maximum Length: 10000

  Text of the error message, if any, encountered when submitting the process.
• PlanId: integer
  Value that uniquely identifies the plan.
• PlanName: string
  Maximum Length: 32

  Name of the plan.
• SegmentIds: string
  Maximum Length: 3000

  Values that uniquely identifies the segments.
• SegmentNames: string
  Maximum Length: 3000

  Name of the segments.

{
    "type":"object",
    "properties":{
        "Message":{
            "maxLength":"10000",
            "type":"string",
            "description":"Text of the error message, if any, encountered when submitting the process.",
            "nullable":true,
            "x-queryable":true
        },
        "PlanId":{
            "type":"integer",
            "description":"Value that uniquely identifies the plan.",
            "nullable":true,
            "x-queryable":true
        },
        "SegmentNames":{
            "maxLength":"3000",
            "type":"string",
            "description":"Name of the segments.",
            "nullable":true,
            "x-queryable":true
        },
        "SegmentIds":{
            "maxLength":"3000",
            "type":"string",
            "description":"Values that uniquely identifies the segments.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PlanName":{
            "maxLength":"32",
            "type":"string",
            "description":"Name of the plan.",
            "nullable":true,
            "x-queryable":true
        },
        "JobId":{
            "type":"integer",
            "description":"Value that uniquely identifies the last publish PAR policies process.",
            "nullable":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

Examples

This example describes how to run the publish par policies process.

Example cURL Command

Use the following cURL command to submit a request on the REST resource.

curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' 
"https://servername/fscmRestApi/resources/version/publishParPolicies"

Example Request Body

The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it updates.

{
    "PlanName": "REPL-AUTO-PAR",
    "SegmentNames": "S1"
}

Example Response Body

The following example includes the contents of the response body in JSON format:

{
    "PlanId": 300100578669000,
    "PlanName": "REPL-AUTO-PAR",
    "SegmentNames": "S1",
    "SegmentIds": "300100578583832",
    "JobId": 131660,
    "Message": "",
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/publishParPolicies/300100578669000",
            "name": "publishParPolicies",
            "kind": "item"
        },
        {
            "rel": "canonical",
            "href": "https://servername/fscmRestApi/resources/version/publishParPolicies/300100578669000",
            "name": "publishParPolicies",
            "kind": "item"
        }
    ]
}

Back to Top